ビットレートとバッファJavaScript API

ビットレート選択APIで、デベロッパーは、バッファ情報の取得やビットレート取得、設定をプログラムで行うことができます。

JavaScript ビットレート選択API

ビットレートを選択するには、次のオプションのどちらかを使ってください。
  • 品質ベースのビットレートを選択(auto、low、medium、high)。 たとえば、ビットレート品質 をhighに設定すると、プレイヤーは利用可能な最高のエンコーディングを決定します。
  • kbps数ベースのビットレートを選択(オーディオ及びビデオ両方のエンコーディング合計)。たとえば、     次のビットレートが利用できるとします。[600 kbps, 1000 kbps, 3000 kbps, 4000 kbps].この値のいずれかをビットレート品質として設定できます。

JavaScriptビットレート選択関数

次の表がビットレートとバッファに関連付けられたすべてのJavaScriptメソッド(オブジェクトによって呼び出す関数)を示します。

関数 説明
getBitrateQualitiesAvailable()

文字列の配列を返します。

形式: 読み取り専用。

タイプ:文字列配列

配列のサイズは利用できるエンコーディングの数によります。

  • 利用できるエンコーディングが1つだけの時は、関数は[‘auto’]を戻します。
  • 2つのエンコーディングが利用できる時は、関数は[‘auto’,’low’,’high’]を返します。
  • 3つのエンコーディングが利用できる時は、関数は[‘auto’,’low’, ‘medium’, ’high’]を返します。
  • ビットレート品質情報がない時は、関数は[‘auto’]を返します。
getBitratesAvailable()

ビットレート合計数(kbps)を含む配列、またはエンコーディング数が有効でない場合には空の配列を返します。たとえば、[250, 500, 1000]は3つのビットレートが利用できることを示します。 250 kbps、500 kbps、1000 kbpsです。

形式: 読み取り専用

タイプ:整数配列

例:[250, 500, 1000]は3つのビットレートが利用できることを示します。250 kbps、500 kbps、1000 kbpsです。

getTargetBitrate()

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

形式: 読み取り専用

タイプ:番号 戻り値: kbps | -1

getTargetBitrateQuality()

ターゲットビットレート品質を取得します。

形式:読み取り専用。

タイプ:文字列

戻り値:auto、low、medium、highのいずれか1つ。

setTargetBitrate(bitrate)

kbpsでターゲットビットレートを設定します。インプットは利用できるビットレートである必要があります。 getBitratesAvailable()にコールすると、利用できるビットレートが決定できます。

:この設定はビデオからビデオに持ち越しません。

形式:書き込みのみ。

タイプ:数字

例:1つ目が1000kbpsの最高ビットレートで、2つ目は1000kbpsの中ビットレートと2000kbpsの最高ビットレートという2つのビデオがあるチャンネルを考えてみてください。 もし1000 kbpsにビットレートを設定するなら、この番号がビットレートクオリティに変換され、この例では、highに変換されます。ビットレート品質を引き継ぐので、最初のビデオは、最高ビットレートである1000 kbpsで再生し、2番目のビデオは最高ビットレートの2000 kbpsで再生します。

getBufferLength()

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

タイプ:数字。

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

setTargetBitrateQuality(quality)

ターゲットビットレート品質を設定します。

形式:書き込みのみ。

有効値:次の内どれか1つを選んでください:

  • auto—適応ビットレートアルゴリズムを選んで、ユーザーが現在使用しているバンド幅とCPU使用量に合わせた最高のビットレートを提供します。 この設置は特定の埋め込み内でビデオからビデオに持ち越されます。
  • low—利用できる中で最低のビットレート
  • medium—利用できるビットレートの中央値
  • high—利用できる中で最高のビットレート

例:1つ目が1000kbpsの最高ビットレートで、2つ目は1000kbpsの中ビットレートと2000kbpsの最高ビットレートという2つのビデオがあるチャンネルを考えてみてください。 もしビットレートクオリティをhighに設定していると、最初のビデオは1000 kbpsで再生し、2番目のビデオは最高ビットレートの2000 kbpsで再生します。

JavaScript ビットレート選択イベント

次の表はビットレートに関連付けられたすべてのJavaScriptを示します。
関数 説明
changeCurrentItem(embedCode)

ターゲットビットレート品質が変更されました。

targetBitrateQualityChanged ターゲットビットレート品質が変更されました。

関連情報

次の一覧は、ビットレートとバッファに関する一般的な情報を記載したBacklotドキュメンテーションへのリンクを提供します。

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