PlayerFactoryIFクラスは、HTMLページ上にプレイヤーインスタンスを動的に生成し、プレイヤーを利用できる状態にします。
このプレイヤーインスタンスは、後述するEQPlayerAccessAPIクラスに従って動的に操作することができます。
このクラスへは、jstream_t3.PlayerFactoryIF でアクセスしてください。
■メソッド
create()
create(setting:Object, target:String):Object |
プレイヤーインスタンスを生成し、プレイヤーをHTMLページ上へ配置します。
プレイヤーインスタンスを戻り値とします。
このメソッドで生成するプレイヤーの個数に制限はありませんが、個数に比例してデバイスの負荷が上がることにご注意ください。
■パラメーター
setting:プレイヤーの設定情報を定義した連想配列です。
添え字 | 必須 | 値 | 備考 |
b | ○ | Base プレイヤー構成ファイルのパス | 変更禁止 |
c | ○ | contract_id お客様ID(難読化形式) |
変更禁止 |
m | ○ | meta_id 動画ID(難読化形式、非難読化形式の両方で利用可能) |
|
opid | - | 指定した任意ID | パラメーター”m”と“opid”両方指定した 場合、”m”が優先されます |
pl |
- |
プレイリストID(難読化形式、非難読化形式の両方で利用可能) |
|
t | - | start_time 再生開始位置(秒) |
|
ot | - | onetime ワンタイム視聴制限のハッシュ値 |
|
ltl | - |
LightboxTextLink |
パラメーターの内容が空、あるいパラメーター自体がない場合は、サムネイルが表示されます。 Lightboxタグでのみ表示されます。 |
lfs |
- |
LiveFeedSelect |
メインは「1」を指定 |
プレイヤーの機能設定情報
「S」パラメーターに属する添え字
添え字 | 必須 | 値 | フォーマット | デフォルト値 | 備考 |
wp | ○ | Width(Player) プレイヤーエンベッドサイズ(横幅) |
数値 | 無し | ピクセル単位での指定のみ対応 |
hp | ○ | Height(Player) プレイヤーエンベッドサイズ(高さ) |
数値 | 無し | ピクセル単位での指定のみ対応 |
rp | - | Responsive レスポンシブ対応の有無 |
fit/off | off | |
lu | - | loop_use 単独動画のループ再生の有無 |
on/off | off | |
plac | - | playlist autoChange プレイリスト連続再生の有無 |
on/off | off | プレイリストを設定している時に動画を完視聴すると、プレイリストの次の動画に切り替わる |
dq | - | Default Quality 再生する動画のデフォルト画質 |
0/1/2/3/4/5 | 2 | 0: 自動、1: 低画質、2: 標準画質、3: 高画質、4: HD画質、5:フルHD画質 |
mdq | - | Mobile Quality 再生する動画のデフォルト画質 (スマートフォン向け) |
0/1/2/3/4/5 | 2 | 0: 自動、1: 低画質、2: 標準画質、3: 高画質、4: HD画質、5:フルHD画質 |
pb | - | Play Button 再生ボタンの有無 |
on/off | on | |
wm | - | Water Mark 中央再生ボタンの表示有無 |
on/off | on | |
wd | - | Water Mark Design 中央再生ボタンのデザイン |
1/2 | 1 |
1:四角、2:丸 |
cp | - | Control panel コントロールパネルの有無 |
on/off | on | |
vc | - | Volume Control 音声ミュート/音量調節の有無 |
on/off | on | |
sb | - | Seek Bar シークバーの有無 |
on/off | on | |
fs | - | Full Screen 全画面ボタンの有無 |
on/off | on | |
ft | - | Footer Text フッター文字列 |
文字列 URL エンコード |
"" | 空文字以外の値が存在する場合はフッターをonとする |
fa | - | Footer Align フッター表示位置 |
left/center/right | right | |
ti | - | Title タイトル表示の有無 |
on/off | on | |
is | - | Init Sound 初期音声の有無 |
on/off | on | |
ip | - | Init Play 自動再生の有無 |
on/off | off | |
el | - | ExLink 外部リンク表示の有無 |
on/off | on | |
tg | - | Tag タグ表示の有無 |
on/off | on | |
il | - | Inbound Link インバウンドリンクの有無 |
on/off | on | |
mb | - | Multi Bitrate 画質選択ボタン表示の有無 |
on/off | on | |
rb | - | Return Button 「もう一度見る」ボタンの表示有無 |
on/off | on | |
sn | - | SNS 表示するSNSボタンのリスト 最大3つまで指定可 |
SNS ID (カンマ区切り) |
f,t,l | Facebook: f, Twitter: t, LINE:l |
rs | - | Resume レジューム機能の有無 |
on/off | off | |
pr | - | PlaybackRate 速度設定 |
文字列 | "" | 0.5~2.0の数値(小数点第一位まで) 1.0は登録不可 5つまで登録可能 1つは必須 |
cc | - | Closed Caption 字幕表示の有無 |
on/off | on | |
skb | - | skip button 秒数送り/戻しボタンの秒数指定 |
1~90の半角 整数、off |
“10" | |
bskb | - |
back skip button |
1~90の半角 整数、off |
未設定 | |
fskb | - | fast-forward skip button 秒数送りボタンの秒数指定 |
1~90の半角 整数、off |
未設定 | |
prl | - | Preload プリロード |
auto/off | off | |
cpt | - | chapter チャプター機能の有無 |
on/off | on | |
sbt | - | SeekBarThumbnail シークバーサムネイル機能の有無 |
on/off | on | |
va | - | VideoAnalytics Cookie 動画視聴解析系Cookieの使用可否 |
on/off | on |
on:動画視聴解析系Cookieを有効 Cookie制御機能の詳細についてはこちら |
fc | - | Functionality Cookie プレイヤーレジューム機能系Cookieの使用可否 |
on/off | on |
on:プレイヤーレジューム機能系Cookieを有効 Cookie制御機能の詳細についてはこちら |
※ 「dq」で指定した画質の動画がEquipmedia上に存在しない場合は、「標準画質」が指定されます。
※ 「dq」で「0」を指定した場合において、画質の動画がEquipmedia上に存在しない場合は、
以下の優先順にて画質が指定されます。
「低画質」→「標準画質」→「高画質」→「HD画質」→「フルHD画質」
ただし、旧プレイヤーバージョン(ver2.4.2以前)では、「標準画質」が指定されます。
※ フォーマットが「数値」以外の添え字を記述する際は、
""(半角ダブルクォーテーション)で囲んでください。(例)dq:"0"
※「fc: "on"」と「rs: "off"」を同時に設定した場合は、
レジューム再生機能(EQPlayer_resume_CurrentTime_{動画ID}_{CID})のCookieのみが無効になります。
「o」パラメーターに属する添え字
「o」パラメーターは、動画視聴解析機能(VA)のカスタム解析変数を利用する際に、設定するパラメーターです。
詳細情報につきましては、「EQ Management Console 利用マニュアル」配信関連機能の各種設定をご確認ください。
添え字 | 必須 | 値 | 備考 |
任意 | - |
Key/Value形式で、最大5項目まで設定可能 ・【Value】対応文字列 : マルチバイト可能 |
6項目以上設定された場合は、上限値を超えた項目が無視されます。 URIエンコードの値が不正で合った場合は、エラーとなりプレイヤーが表示されなくなります。 |
※集計されたデータの確認方法につきましては、「動画視聴解析(Video Analytics)利用マニュアル」カスタム解析変数をご確認ください。
target:プレイヤーを配置するブロック要素のIDを指定します。このパラメーターを省略した場合は、
このメソッドを実行した箇所にプレイヤーが書き出されます。(オプションパラメーター)
すでにプレイヤーを配置したブロック要素に対して、新たにプレイヤーを配置することができます。
ページ遷移をさせずに再生する動画を変更したい場合などにご使用ください。
■秒数送り/戻しボタン skbパラメーターについて
シークバー設定(sb)と中央のウォーターマーク(wm)の連動については、以下をご参照ください。
秒数送り/戻しボタンの表示 | |||||
シークバー (sb) |
ウォーターマーク (wm) |
秒数送り/戻し(一括取得)(skb) |
秒数送り/戻し(fskb/bskb) | 画面中央 |
左下コントロールパネル上 ※cp : on前提 |
on | on | on(1~90) | off | 表示する | 表示する |
on | on | off | off | 表示しない | 表示しない |
on | off | on(1~90) | off | 表示しない | 表示する |
on | off | off | off | 表示しない | 表示しない |
off | on/off | on/off | off | 表示しない | 表示しない |
※秒数送り/戻し(fskb/bskb)が有効(on)の場合は、シークバー設定(sb)と連動しません。
参考)その場にプレイヤーを配置する場合
var player = jstream_t3.PlayerFactoryIF.create({ b: "eq********.eq.webcdn.stream.ne.jp/www**/eq********/jmc_pub/jmc_swf/player/", c: "****", m: "****", t: "10", s: { ft : "%28C%29%20J%2dStream%20Inc%2e", ti: "off", sn: "f,t", wp: 640, hp: 380 }, o: { "userid":"*****" } }); |
参考)eqplayer要素にプレイヤーを配置する場合
var player = jstream_t3.PlayerFactoryIF.create({ b: "eq********.eq.webcdn.stream.ne.jp/www**/eq********/jmc_pub/jmc_swf/player/", c: "***", m: "***", t: "10", s: { ft : "%28C%29%20J%2dStream%20Inc%2e", ti: "off", sn: "f,t", wp: 640, hp: 380 } }, "eqplayer"); |
■ご留意点
上記サンプル内「o」パラメーター(カスタム解析変数)及び、「t」パラメーター(再生開始位置)は上記機能をご利用いただく想定でのサンプルとなっております為、ご使用されない場合は、削除していただいても問題ございません。