クラス: StreamManager

ストリーム マネージャー

class

ダイナミック広告挿入ストリームを処理します。DAI バックエンドの操作を管理し、トラッキング ping を処理するとともに、ストリーム イベントと広告イベントをパブリッシャーに転送します。このマネージャーは特定の広告ではなく、ストリーム全体に対する管理者であるため、BaseModifier から継承されません。

コンストラクタ

ストリーム マネージャー

new StreamManager（videoElement、adUiElement、uiSettings）

パラメータ

動画要素

再生を行う HTML 動画要素。

値を null にすることはできません。

adUiElement

任意

広告 UI 要素を保持するために使用する HTML 要素。この要素は動画再生と同じ高さ、幅で、直接オーバーレイする必要があります。指定しない場合、UI は表示されません。また、UI を必要とする広告（スキップ可能な広告など）もリクエストされません。

値を null にすることはできません。

UI 設定

任意

このストリームに使用する UI 設定。

値を null にすることはできません。
実装
EventTarget
例外

入力パラメータが要件を満たさない場合。

Methods

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) は数値を返す

指定した配信時間の広告のないコンテンツ時間を返します。ライブ ストリームの指定されたストリーム時間を返します。

パラメータ

streamTime

数値

挿入された広告のストリーミング時間（秒単位）。
戻り値

number 広告が削除された後の特定のストリーム時間に対応するコンテンツ時間。

ピント

focus()

スキップボタンがある場合は、ボタンにフォーカスを合わせます。存在しない場合は、アイコンやインタラクティブ クリエイティブなどのインタラクティブな要素にフォーカスが当てられます。

onTimedMetadata

onTimedMetadata（メタデータ）

処理されたメタデータの辞書を渡します。この辞書では、キー「TXXX」とユーザー定義のメタデータ文字列を値とする必要があります。プレーヤーが未加工のメタデータを提供している場合は、代わりに StreamManager.processMetadata を呼び出します。

パラメータ

metadata

オブジェクト

メタデータの辞書。

値を null にすることはできません。

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) は CuePoint を返す

特定のストリーム時間の前のキューポイントを返します。そのようなキューポイントが存在しない場合は null を返します。これはスナップバックなどの機能を実装するために使用されます。パブリッシャーが、ユーザーを広告ブレークに戻すためにユーザーがシークしていることを検出すると呼び出されます。

パラメータ

streamTime

数値

対象のストリーミング時間。
戻り値

nullable CuePoint: 特定のストリーム時間の前のキューポイント。

processMetadata

processMetadata(type, data, timestamp)

ライブ配信の時限メタデータを処理します。動画プレーヤーが解析されないメタデータとタイムスタンプを提供する場合に使用します。それ以外の場合は StreamManager.onTimedMetadata を呼び出します。

パラメータ

type

string

メタデータのタイプ。HLS の場合は「ID3」、DASH のイベント メッセージ スキーム ID URI にする必要があります。

​

（null 以外の Uint8Array または文字列）

未加工のタグデータ。ID3 の場合は、未加工のタグデータ全体を指定する必要があります。DASH イベント メッセージの場合、これはメッセージ データ文字列です。

timestamp

数値

データを処理するまでの時間（秒）。DASH の場合、これはイベント メッセージの開始時間です。

replaceAdTagParameters

replaceAdTagParameters（adTagParameters）

ライブ ストリームで予定されている広告リクエストに使用されるすべての広告タグ パラメータに置き換わります。

パラメータ

adTagParameters

文字列プロパティを持つオブジェクト

新しい広告タグ パラメータ。 文字列値が必要です。

値を null にすることはできません。

requestStream

requestStream（streamRequest）

指定されたストリーム パラメータを使用して、ストリームの読み込みをリクエストします。

パラメータ

streamRequest

StreamRequest

ストリーム メタデータを読み込むパラメータが含まれています。

値を null にすることはできません。

リセット

reset()

ストリーム マネージャーをリセットし、継続的なポーリングを削除します。

setClickElement

setClickElement(clickElement)

広告のクリックスルー要素を設定します。この要素は、広告の再生中にクリックまたはタップレシーバーとして使用され、現在のページから移動する可能性があります。これはサポートが終了しているため、代わりに adUiElement を StreamManager に渡す必要があります。adUiElement を StreamManager コンストラクタに渡すと、このメソッドは no-op になります。

パラメータ

clickElement

要素

広告のリンク先として使用する要素。

値は null でもかまいません。
非推奨
代わりに、StreamManager コンストラクタに adUiElement を提供します。

streamTimeForContentTime

streamTimeForContentTime(contentTime) は数値を返す

特定のコンテンツ時間の広告を含むストリーム時間を返します。ライブ ストリームの指定されたコンテンツ時間を返します。

パラメータ

contentTime

数値

広告のないコンテンツ時間（秒）。
戻り値

number: 広告の挿入後の特定のコンテンツ時間に対応する配信時間。