FPEを組み込みたいHTMLソース(xxx.html)を開き、適所へopenFPE関数(JavaScript)を記述します。

手順は以下の2つとなります。

  1. 外部JavaScriptファイル(FPEを制御する為のopenFPE関数等が含まれます)読み込み定義を記述して下さい。
  2. FPEを組み込みたい個所へopenFPE関数(JavaScript)を記述して下さい。

※JavaScriptファイル郡(flash.js,flash_check.js)は配布ファイル中の「jsフォルダ」に格納されています。

STEP 1

外部JavaScriptファイルの組込み

下記コードをHTMLソース先頭の<HEAD>から</HEAD>の間に記述(コピー&ペースト)します。

<!-- ここから外部JavaScriptファイルの読込定義 --> 
<SCRIPT language="JavaScript" type="text/javascript" src="flash_check.js"></SCRIPT>
<SCRIPT language="JavaScript" type="text/javascript" src="flash.js"></SCRIPT>
<!-- ここまで外部JavaScriptファイルの読込定義 -->

配布ファイル中に含まれるflash_check.jsとflash.js2つの外部JavaScriptファイルを利用するための宣言部となります。

実際に組み込む際はflash_check.jsとflash.jsのパス指定は適時修正して下さい。

補足説明

flash_check.js → フラッシュバージョンチェックモジュール

flash.js → FPE組込関数モジュール(openFPE関数含む)

STEP 2

openFPE関数記述

※FPEを組み込みたい箇所へ、下記コードをHTMLソースに記述(コピー&ペースト)します。
後述するパラメータ説明を参考に、画像サイズ等のパラメータを修正して下さい。

<script>~</script>までの間にFPE組込関数(openFPE)を記述して下さい。
<noscript>~</noscript>までの間にJavaScriptが使用できない環境で表示する代替イメージを定義して下さい。

<SCRIPT language="JavaScript" type="text/javascript">
<!--
openFPE('misfpe.swf','001.jpg',310,310,'config.xml','#ffffff');
//-->
</SCRIPT>
<NOSCRIPT>
<IMG SRC="001.jpg" WIDTH="310" HEIGHT="310" alt="代替イメージ">
</NOSCRIPT>

openFPE関数パラメータ

openFPE('FPE本体ファイル名','代替イメージ',横幅,高さ,'定義ファイル名','背景色',XMLキャッシュフラグ)

FPE本体ファイル名
FPE本体ファイル名を指定して下さい。
通常は「misfpe.swf」となります。
HTMLファイルと異なる場所にmisfpe.swfが存在する場合は「../misfpe.swf」等の相対指定も可能です。
※省略不可です。 ※シングルクォーテーションで囲んで指定して下さい。
代替イメージ
FPEはFlash Player バージョン6以上がインストールされている環境で動作します。
JavaScriptは使用可能であるが、バージョン6未満のプレイヤーの場合「代替イメージ」で指定された画像が表示されます。
※省略不可です。
※シングルクォーテーションで囲んで指定して下さい。
横幅
表示枠横幅をドット単位で指定します。
※省略不可です。
※シングルクォーテーションは不要です。
高さ
表示枠高さをドット単位で指定します。
※省略不可です。
※シングルクォーテーションは不要です。
定義ファイル名
定義ファイル名を指定して下さい。
通常は「xxx.xml」となります。
HTMLファイルと異なる場所に定義ファイルが存在する場合は「../xxx.xml」等の相対指定も可能です。

※省略不可です。
※シングルクォーテーションで囲んで指定して下さい。

Version 1.2.0で定義ファイルランダム選択機能が追加されました。
例 openFPE('misfpe.swf','001.jpg',320,180,'config1.xml,config2.xml,config3.xml','#ffffff')

カンマ区切りで定義ファイル名を複数指定して下さい。
上記例の場合、FPEは起動毎に3つの定義ファイルをランダムで選択しコンテンツの表示を行います。
サイトトップページ等でアクセス毎に異なるコンテンツを表示する広告、宣伝等にご利用下さい。

※定義ファイルは全て同一表示枠サイズ(横幅、高さ)で動作するものを指定して下さい。
背景色
背景色を16進数で指定します。
「#ffffff」と指定した場合は「白」になります。
「#ff0000」と指定した場合は「赤」になります。
省略時は透明扱いになりますがパフォーマンスが落ちるので必要でない限り背景色を指定することをお勧めします。
※シングルクォーテーションで囲んで指定して下さい。
XMLキャッシュフラグ
定義ファイルの読込制御フラグです。
0:読込制御をブラウザに依存させる。
1:強制的に毎回サーバに定義ファイルをリクエストする。

省略時は「0:読込制御をブラウザに依存させる」と同様の動作をします。

デバッグ中やサーバサイドスクリプトと連携させる場合は「1」として下さい。

このオプションはInternet Explorer等のブラウザが、定義ファイルを毎回キャッシュから読み込む現象を回避する為に用意されています。
※シングルクォーテーションは不要です。

Flash Player 判定について

flash_check.jsは古いFlash Playerがインストールさているか?を検出する為のJavaScriptモジュールです。

Version 1.2.0からFlash8の新機能に対応したことで、flash_check.jsは2種類用意されました。

  • Flash Player 7以上がインストールさていることをチェックするjs/flash_check.js
  • Flash Player 8以上がインストールさていることをチェックするjs/flash8/flash_check.js

FPEで利用する機能に合わせてflash_check.jsをお選び下さい。