プレイヤーAPI関数

プレイヤーJavaScript関数は、プレイヤーの挙動と外観のカスタマイズに使用します。

プレイヤー関数

次の表は、主要なプレイヤーJavaScript関数を示します。

destroy() アイテムを破棄します。コールされると、プレイヤーを削除し、すべてのアクティビティを停止、ビデオを すべてアンロードします。
pause() 現在のビデオ再生を一時停止します。
play() 現在のビデオを再生します。
seek() 秒単位で指定したパラメータにシークします。

タイプ:数字

有効 値: 秒単位の時間

関数 説明

GET関数

次の表はすべてのプレイヤーJavaScriptの関数を取得を示します。

getBitrateQualitiesAvailable() 文字列の配列を返します。配列のサイズは、利用できるエンコーディング数によります。
  • 利用できるエンコーディングが1つだけの時は、関数は[‘auto’]を戻します。

  • 2つのエンコーディングが利用できる時は、関数は[‘auto’,’low’,’high’]を返します。

  • 3つ以上のエンコーディングが利用できる時は、関数は[‘auto’,’low’, ‘medium’, ’high’]を返します。

  • ビットレート品質情報がない時は、関数は[‘auto’]を返します。

タイプ:配列

getBitratesAvailable()

kbpsのビットレート合計数で配列を返すか、エンコーディング数が利用できない場合は、空配列を返します。

注: Flashプレイヤーの場合、前もって値を取得した場合、ターゲットビットレートを取得できます。 しかし、これはQuicktimeでは利用できません。Quicktimeのビットレートを取得する機能を制御する 方法がなく、この場合、デフォルトでは、ベストエフォートを基本として提案された時間を使います。

例: [250, 500, 1000]利用できる3つのビットレートを示します:250 kbps、500 kbpsと1000 kbps。FlashベースのOoyalaプレイヤーには、発行者はこのAPIを使って、 setTargetBitrate() API用に利用可能なビットレートの一覧を取得できます。

getBufferLength() バッファの長さをサポートしている場合には、現在のバッファのサイズを秒単位で返すか、あるいは0を返します。
注: 現在、YouTubeアセットとリモートアセットはバッファの長さをサポートしていません。

タイプ:数字


戻り値:秒単位の時間 | 0   
getCurrentItemClosedCaptionsLanguages()

現在再生中のアイテムの対応字幕言語の一覧を取得します。この一覧はBacklot経由でアップロードされたこのコンテンツの字幕XMLファイルから導き出されます。コンテンツの字幕ファイルに関する詳細は、字幕ファイルのアップロードと表示をご覧ください。 DFXPファイルがなければ、このメソッドは空の一覧を返します。ライブストリームモードでは、 字幕言語をストリーム自身から導き出します。

タイプ:一覧

戻り値:"language code"形式での一覧:"displayName"

:{ "en":"English",...}.

:このメソッドは、字幕ファイルが現在のembedコードにアップロードされていない場合、例外処理を実行します。

getDescription() Backlotから現在のビデオの説明を取得します。この関数は、Backlot管理>詳細タブまたはそれに相応する手動設定で設定する説明を読み出します。

タイプ:文字列    

戻り値:アセットの英数字の説明

例:Season 22 Opening Game

getDuration() 秒単位のビデオの合計の長さを取得します。

タイプ:数字

戻り値:秒単位の長さ

getEmbedCode() 現在のプレイヤーのembedCodeを取得します。

タイプ:文字列   

戻り値:NodXQ5NTq0Y8Nw4GvIWBHlf-irMiKy7P

getError() エラーコードが存在し、現在の状態がエラーなら、現在のエラーコードを返します。

タイプ:文字列  

戻り値:エラーが ローカライズされたエラーメッセージを返します。

getErrorText() エラーメッセージ文字列を返します。

タイプ: 文字列

戻り値:エラーのローカライズされたエラーメッセージ。

例: ”このビデオはこのドメインでは許可されていません。管理者にご連絡ください。”

getItem() 現在のビデオを説明するオブジェクトを取得します。

タイプ:オブジェクト

戻り値:次の属性を持つオブジェクト:
  • embedCode
  • title
  • description
  • time(秒単位の時間)
  • lineup
  • promo
  • hostedAtURL
getLiveTime() は、ライブストリームの時間を返します。基本的にはgetPlayheadTime()と変わりませんが、ウォールクロック オフセットがあれば、その値が含まれます。

タイプ:数字

getPlayheadTime() ミリ秒精度の秒単位でプレイヘッドのロケーションを返します。

タイプ: 数字

戻り値:秒単位の長さ

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

タイプ:文字列

戻り値:以下の内の1つになります。 LOADING : ‘loading’READY : ‘ready’PLAYING : ‘playing’PAUSED : ‘paused’BUFFERING : ‘buffering’ERROR : ‘error’DESTROYED : ‘destroyed’

getTargetBitrate() ターゲットビットレートがあらかじめ設定されている場合にターゲットビットレート品質(kbps)を取得します。そうでない場合には-1を取得します。
getTargetBitrateQuality() ターゲットビットレートの品質を返します。autolowmediumまたはhighの内1つを返します。

Flashプレイヤー でのみ機能します。

タイプ:文字列

getTitle() ビデオのタイトルを取得します。

タイプ:文字列

戻り値:ビデオタイトル

例:My Snowboarding Channel

getVolume()

実行するデバイスの制限により、ベストエフォートで現在のボリュームを 返します。

タイプ:数字

戻り値:0から1の数

isFullscreen() 全画面モードの場合にはtrue 、そうでない場合にはfalseを返します。 実行するデバイスの制限により、ベスト エフォートでフルスクリーンの実装を行います。

タイプ:ブーリアン

戻り値: true | false

関数 説明

SET関数

次の表はすべてのプレイヤーV3JavaScript関数設定を示します。

setClosedCaptionsLanguage(language)

プレイヤーで表示される字幕(CC)言語を設定します。字幕 ファイルをアップロードしない場合、コンテンツは字幕なしで再生します。 ライブストリーミングモードでは、字幕用言語はストリーム自体の言語を使用することになります。 iOSで字幕がサポートされている方法の関係で、リモートアセットのiOSウェブに字幕データを追加する      ことはできません。

パラメータ: language

有効値:ISO 639-1 言語コードに特定 | なし。中国語には、簡体中国語に"zh-hans"と繁体中国に "zh-hant" を使ってください。字幕を表示 しないようするには、languageを"none"に設定してください。

: en, de, ja.

setEmbedCode(embedcode, options)

現在のプレイヤーにembedCode を設定します。setEmbedCode関数も、動的に広告セットを embedコードに割り当てられるオプションを取ります。

タイプ: 文字列   

パラメータ:embedコードと任意パラメーターを取ります。任意パラメータ は、ユニーク広告コードを表すキー/値ペアのハッシュオブジェクトでなければいけません。

例:広告セットコードはembedコードと同じプロバイダーに属するようにしてください。

player.setEmbedCode(embedCode, {    adSetCode: 'foo'});
注: この機能は広告セットをBacklotの動画に関連付ける必要があります。詳しい情報は、 プレイヤーV3デベロッパーガイドで “広告セットを動的に割り当てる” のトピックをご覧ください。
setPlayheadTime(value)

秒単位でパラメータに指定された場所にプレイヘッドを移動します。

タイプ:数字

戻り値:秒単位の長さ

setTargetBitrate(bitrate) kbpsでターゲットビットレートを設定します。インプットは利用できるビットレートである必要があります。利用できるビットレートは getBitratesAvailable()へのコールで決定されます。    

ビットレートはビデオからビデオへ引き継ぎませんこの設定はビデオからビデオへ、引き継がれません。たとえば、1つ目が1000kbpsの最高 ビットレートで、2つ目は1000kbpsの中ビットレートと2000kbpsの最高ビットレートという2つのビデオが あるチャンネルを考えてみてください。ビットレートを1000kbpsに設定している 場合、この値をビットレート品質に変換し、この場合highになります。ビットレート 品質はビデオからビデオへ引き継がれるため、最初のビデオは1000kbpsで再生され、 2番目のビデオは最高ビットレートの2000 kbpsで再生されます。

ビットレート設定でのHDS制限

HDSを使用する際、ビットレートの変更に必要な要素を、HDSは弊社APIに対して公開していないことにご留意ください。そのため、ターゲットビットレートを設定しても、変更は行われません
setVolume(value) 実行するデバイスの制限により、ベストエフォートで現在のボリュームを設定します。

有効値:0から1の数

関数 説明

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