EQPlayerAccessAPIクラス

EQPlayerAccessAPIクラスは、プレイヤーの操作や状態の取得を行います。

 

EQPlayerAccessAPIへのアクセスは、プレイヤーインスタンス自体ではなく、プレイヤーインスタンスのaccessorオブジェクトに対して行ってください。

プレイヤーインスタンスが player の場合は、player.method() や player.property　ではなく、player.accessor.method() や player.accessor.property としてください。

 

また、生成したプレイヤーインスタンス、accessorオブジェクトは、プレイヤーの状態に応じて参照先が変わる場合がございます。

そのため、別の変数への受け渡しをした上でのご利用はしないでください。非推奨の例）var accessor2 = player.accessor;

 

EQPlayerAccessAPIへのアクセスは、プレイヤー準備完了のイベントを取得してからのご使用を推奨いたしまします。

※プレイヤー準備完了イベントについては当ページ下部にある【■イベント】をご参照ください。

 

推奨例)

 

---

■メソッド

 

・getCurrentAPI()

配信するプレイヤー種別を取得します。

 

■戻り値

“HTML5API”：HTML5プレイヤー

“NativeHLS”：Android端末搭載プレイヤー(ストリーミング)

“SWFAPI”：Flashプレイヤー

“isNotReady”：Landingイベント前に呼ばれるとこちらを返します

 

・addEventListener()

プレイヤーから発生するイベントに対するイベントリスナーを登録します。

 

■パラメーター

type：リッスンするイベントタイプ(使用できるイベントタイプは後述のイベントを参照ください。)

callback：typeパラメーターで指定したイベントが発生した時に実行する関数

 

・removeEventListener()

イベントリスナーを削除します。

 

　■パラメーター

type：削除するイベントタイプ(使用できるイベントタイプは後述のイベントを参照ください。)

callback：typeパラメーターで指定したイベントが発生した時に実行する関数

 

・play()

動画の再生を開始します。(一時停止からの再開時にも使用します。)

Androidの一部端末ではサポートされません。

 

・pause()

動画の再生を一時停止します。(一時停止からの再開には、playメソッドを使用してください。)

Androidの一部端末ではサポートされません。

 

・getCurrentTime()

現在の再生位置を取得します。(秒単位。小数点以下の表記はミリ秒オーダー)

Androidの一部端末ではサポートされません。

 

・setCurrentTime()

再生中の動画の再生位置を指定します。

シーク操作を行う場合などに使用します。動画の再生中、または一時停止中にのみ使用できます。

Androidの一部端末ではサポートされません。

 

■パラメーター

time：再生位置(秒単位。ミリ秒オーダーでの指定は小数点以下で表記。正の数値以外や動画の長さ(尺)

　　を超える数値を指定した場合は、無視されます。）

 

・getTotalTime()

動画の長さ（尺）を秒単位で取得します。メタ情報から取得しますが、動画再生後に取得する場合は

videoタグから取得する場合があります。

Androidの一部端末ではサポートされません。

 

・changeQuality ()

動画の画質を変更します。

Androidの一部端末ではサポートされません。

 

■パラメーター

quality：画質 （PlayerFactoryIF.create()のdefault_qualityパラメータに準じます。）

 

・mute()

音声ミュート・アンミュートを指定します。

iOS・Androidの一部端末ではサポートされません。

 

■パラメーター

enabled：音声ミュート状態（true: 有効, false: 無効）

 

■戻り値

設定後のミュート状態。（enabledパラメーターに準じます。）

 

・isMuted ()

現在のミュート状態を取得します。（戻り値はenabledパラメーターに準じます。）

iOS・Androidの一部端末ではサポートされません。

 

・setVolume ()

ボリューム（音量）を設定します。

iOS全般・Androidの一部端末ではサポートされません。

※ミュート状態でこのメソッドがコールされた場合、ミュートは無効（解除）となります。

 

■パラメーター

vol：ボリューム（0から100までの整数）

 

・getVolume ()

現在のボリュームを取得します。（setVolume()のvolパラメーターに準じます。）

iOS全般・Androidの一部端末ではサポートされません。

 

・getPlaybackRate ()

現在の再生速度を取得します。

Flashプレイヤー、ならびにAndroidではサポートされません。

 

・setPlayback Rate()

■パラメーター

pr：PlaybackRate 速度設定（0.5～2.0の数値）

　　1.0は登録できません。

　　5つまで、登録可能です。(1つは必須で設定が必要)

 

再生速度を変更します。

指定範囲は0.5～2までの小数点第一位までとなります。

Flashプレイヤー、ならびにAndroidではサポートされません。

 

・getSubtitles

現在の字幕の表示順序番号を取得します。

 

・changeSubtitles

■パラメーター

Subtitles：字幕の表示順序番号（※字幕オフは１となります。）

字幕の言語を変更します。

 

・setVideoAnalyticsEnabled()

動画視聴解析系Cookieの制御状態を指定します。（Cookie制御機能の詳細についてはこちら）

※基本的にはこちらで指定した設定が最優先となりますが、
ブラウザの更新ボタンを押す等、画面のリロードを行った場合、
APIで設定した値は破棄され、プレイヤータグのvaで設定された値が有効になります。

 

■パラメーター

enabled：動画視聴解析系Cookieの制御状態（true: 動画視聴解析系Cookieを有効, false: 動画視聴解析系Cookieを無効）

 

・setFunctionalityCookieEnabled()

プレイヤーレジューム機能系Cookieの制御状態を指定します。（Cookie制御機能の詳細についてはこちら）
※基本的にはこちらで指定した設定が最優先となりますが、
ブラウザの更新ボタンを押す等、画面のリロードを行った場合、
APIで設定した値は破棄され、プレイヤータグのfcで設定された値が有効になります。

 

■パラメーター

enabled：プレイヤーレジューム機能系Cookieの制御状態（true: プレイヤーレジューム機能系Cookieを有効, false: プレイヤーレジューム機能系Cookieを無効）

 

 

---

■プロパティ

 

・progressRate

progressイベントの1秒間あたりの発生回数を取得・設定します。（デフォルト値:10）Read/Write

プロパティです。再生中の設定はサポートしていません。次回の再生時から適用されます。

視聴するデバイスの性能などにより、progressイベントが設定した回数通り発生しないことがあります。

 

・state

動画プレイヤーの状態を取得します。戻り値は、イベントで定義しているイベントタイプの文字列です。

（change_state, progressを除きます。）

 

・getMetaId

現在表示している動画IDを取得します。

 

---

■イベント

EQPlayerAccessAPI.{addEventListener,removeEventListener} におけるイベントでは、

以下のイベントタイプ（イベント名）を使用してください。

EQPlayerAccessAPI.stateで取得するステータスは、これらのイベントタイプ（イベント名）と

同じ文字列です。※change_state、progressのステータスは取得できません。

 

・landing

　ー　プレイヤー設定情報・動画メタ情報の読み込みと初回のバッファリングが完了し、プレイヤーの

　　　準備が完了した。

　　　このイベントの発生は1回のみです。

 

・change_state

　ー　プレイヤーの状態が変化しました。

　　　change_stateイベントでプレイヤーの状態を把握する場合は、

　　　イベントリスナーでEQPlayerAccessAPI.stateの値を参照してください。

 

・buffering

　ー　バッファリングを開始しました。

　　　HTML5プレイヤーではサポートされません。

　　　一時停止中のシーク操作によるバッファリングではこのイベントは発生しません。

 

・playing

　ー　再生を開始しました。（一時停止からの再開を含む）

 

・progress

ー　動画を再生しています。（このイベントは動画の再生中に定期的に発生します。発生タイミングは EQPlayerAccessAPI.progressRate の設定で変更可能です。）

 

・paused

　ー　一時停止しました。

 

・seek_start

　ー　シークを開始しました。

 

・complete

　ー　動画を完視聴（最後まで視聴）しました。

 

・fullscreen

　ー　全画面表示しました。

 

・exitFullscreen

　ー　全画面表示を解除しました。

 

---

■プレイリスト用　メソッド

 

・autoadvance()

再生している動画が視聴完了したときにプレイリストの次の動画を表示する。

 

　■パラメータ

enable：true であれば再生している動画が視聴完了したときにプレイリストの次の動画を表示する。
falseであれば次の動画を表示しない。連続再生の設定を上書きする。

 

・currentIndex()

再生している動画のインデックスを返す。

 

　■戻り値

　正常であれば0以上のインデックスを返す。異常であれば-1を返す。

 

・currentItem()

再生している動画の情報を返す、またはプレイリスト中の動画を表示する。

 

　■パラメータ

　index：(省略可) 0以上のプレイリスト中の動画のインデックス。

 

　■戻り値

フォーマット

{

　　　　　mid:”mid_text”,

　　　　　title:”title_text”,

　　　　　thumbnail:”thumbnail_URL”,

　　　　　duration:duration_number

}

indexを指定した場合、動画が存在すればその動画の情報を返し、動画を表示する。

存在しない場合indexを指定しない場合と同じとする。

indexを指定しない場合、正常であれば再生中(表示中)の動画の情報を返す。

異常であれば{}を返す。

 

・first()

プレイリストの最初の動画を表示する。

 

・indexOf()

プレイリストの最初からmidで検索し、最初に一致した動画のインデックスを返す。

 

　■パラメータ

　mid：動画のmid(数値or難読化mid)。

 

　■戻り値

一致するデータがある場合0以上のインデックスを返す。見つからない場合-1を返す。

 

・last()

プレイリストの最後の動画を表示する。

 

・lastIndex()

プレイリストの最後の動画のインデックスを返す。

 

　■戻り値

正常であればプレイリストの最後の動画のインデックスを0以上の数値で返す。

異常であれば-1を返す。

 

・next()

再生している動画の次の動画を表示する。

再生している動画が最後の動画の場合、最初の動画を表示する。

 

・nextIndex()

再生している動画の次の動画のインデックスを返す。

 

　■戻り値

再生している動画の次の動画のインデックスを0以上の数値で返す。

再生している動画が最後の動画の場合、プレイリストの最初の動画のインデックスを返す。

 

・previous()

再生している動画の前の動画を表示する。

再生している動画が最初の動画の場合、最後の動画を表示する。

 

・previousIndex()

再生している動画の前の動画のインデックスを返す。

 

　■戻り値

再生している動画の前の動画のインデックスを0以上の数値で返す。

再生している動画が最初の動画の場合、プレイリストの最後の動画のインデックスを返す。

 

・repeat()

プレイリスト内の動画を最後まで再生した後、プレイリストの最初の動画を表示する。

 

　■パラメータ

enable：trueのときプレイリストの最初から再生する処理を行う。

　　　　falseのときプレイリストの最初から再生する処理を行わない。

 

・playOnSelect

プレイリスト内で新しい動画に切り替わった時、表示後再生するようにする。

 

　■パラメータ

enable：trueのとき表示後再生する処理を行う。

　　　　falseのとき表示後再生する処理を行わない。

 

---

■プレイリスト用　イベント

 

・beforeplaylistitem

　ー　プレイリスト内で新しい動画に切り替わる前に通知。

 

・playlistitem

　ー　プレイリスト内で新しい動画に切り替わった後に通知。

 

参考)プレイリスト

 

---

 

・error

　ー　エラーが発生しました。