プレイヤーActionScript API

プレイヤー/プレイヤーUI ActionScript APIは全画面モード、プレイヤー状態、音量、プレイヘッド、プレイヤー音量、ビデオ再生時間、状態などの要素を操作するために使用します。

プレイヤー/プレイヤーUIプロパティ

次の表はプレイヤーと関連付けることができるActionScriptプロパティを示しています。

プロパティ 説明
activePanel

各パネルが表示中の場合には、info、チャンネル、embed、シンジケーションを返します。

バインド可能

形式: 読み取り専用

description

プレイヤーソースの説明。

バインド可能

形式: 読み取り専用

fullscreen

プレイヤーが全画面モードになっている場合にはtrue、そうでない場合にはfalseを返します。

バインド可能

形式: 読み取り専用。

タイプ:ブーリアン

戻り値: true | false

playheadTime

ミリ秒単位で現在のプレイヘッド位置を返します。

バインド可能

形式: 読み書き両用。

タイプ:整数

戻り値:秒単位の時間

queryStringParameters

オブジェクトのパラメーター。

バインド不可能。

形式: 書き込み専用。

タイプ:文字列

戻り値:

state

現在のプレイヤーの状態を取得します。

戻り値:再生、一時停止、バッファリング、チャンネル、エラーの内1つ

totalTime

アクティブビデオの長さ(ミリ秒精度の秒単位)を取得します。

タイプ:整数

戻り値:秒単位の再生時間

volume

0から1までの数字による現在の音量。

バインド可能

形式: 読み書き両用。

タイプ:整数

戻し値: 0から1の数字

プレイヤー/プレイヤーUIイベント処理

下の表はプレイヤーUIイベントと関連付けることが出来るActionScriptイベントについて説明します。

イベント イベントトリガー 説明
playheadTimeChanged( )

アクティブビデオの再生時間を更新します。
activePanelChanged activePanel info、Embed、共有、またはチャンネルパネルが表示または非表示になりました。
apiReady プレイヤーのembedCode が変更されるたびに、このイベントが発動されます。 プレイヤーは、playMovie()getItem()等のAPIコールを受け取ることが出来ます。APIコールを実行する前にイベントがディスパッチされるのを待ちます。setEmbedCode()または setQueryStringParameters()経由で変更することが可能です。注:バージョン2以上に適用。
fullscreenChanged

Cancelable 例:形式(ビデオ)、ソース(doubleClick)、タイプ(adStarted)

全画面状態がトグルされました。
loadComplete プレイヤーが初期化されました。これは廃止予定です。代わりにapiReadyを お使いください。  
metadataReady

metadata

メタデータプロパティは名前/値ペアの配列です。

タイプ:配列

戻り値:名前/値ペアにはnameとvalueの2つのプロパティがあります。

例:{ name:"actor", value:"Johnny Depp" }

fetchMetadata()コールがリクエストしたメタデータが使える状態になりました。
playComplete ビデオまたはチャンネルの再生が終了しました。
ratingsApiReady レーティングAPIが読み込まれ、使える状態になりました。このイベントはloadRatingsApi()が コールされた後でディスパッチされます。  
relatedMediaReady

fetchRelatedMedia()コールによってリクエストされたrelatedMediaの準備が出来ました。

このイベントにはメディアアイテムの配列、 "relatedMedia" プロパティが備わっています。

タイプ:配列

戻り値:各アイテムは、 title、description、time、promoとembedCodeを含みます。

fetchRelatedMedia()コールがリクエストした関連メディアが使える状態になりました。

seeked newPlayheadTime, oldPlayheadTime. プレイヤー内でシークイベントが発生しました。このイベントは2つの方法で引き起こされます。ユーザーが シークバーを移動 (ユーザーがシークバーを離すとイベントが登録されることに注意して下さい)、 APIリクエストsetPlayheadTimeが発行された。
stateChanged

プレイヤー状態は再生中、一時停止、バッファリング、エラーの間で遷移します。

状態が変わりました。  
totalTimeChanged

現在のビデオの再生時間が変わりました

 
volumeChanged

プレイヤーの音量が変更されました。

関連情報

以下はプレイヤーに関する一般情報が記載されたBacklotドキュメントのリンク一覧です。

この記事はお役にたちましたか?