クラス: StreamManager

StreamManager

class

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

コンストラクタ

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

パラメータ
videoElement	再生を行う HTML 動画要素。 値を null にすることはできません。
adUiElement	任意 広告 UI 要素の保持に使用する HTML 要素。この要素は、動画再生と同じ高さと幅にし、直接オーバーレイする必要があります。指定しない場合、UI は表示されず、UI を必要とする広告（スキップ可能な広告など）はリクエストされません。 値を null にすることはできません。
uiSettings	任意 この配信に使用する UI 設定。 値を null にすることはできません。

例外

エラーが発生することがあります。

メソッド

contentTimeForStreamTime

contentTimeForStreamTime(streamTime) は数値を返します。

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

パラメータ
streamTime	数値 挿入された広告のストリーム時間（秒単位）。

戻り値

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

ピント

Focus()

スキップ ボタンが存在する場合は、そのボタンにフォーカスが移動します。存在しない場合は、アイコンやインタラクティブなクリエイティブなどのインタラクティブな要素がフォーカスされます。

getAdSkippableState

getAdSkippableState() は ブール値を返す

広告が現在スキップできる場合は true を返します。この値が変更されると、StreamManager によって StreamEvent.SKIPPABLE_STATE_CHANGED イベントが発生します。

戻り値

boolean 広告をスキップできる場合は true、それ以外の場合は false。

loadStreamMetadata

loadStreamMetadata()

SDK に広告メタデータを読み込んでから StreamEvent.LOADED をブロードキャストするようリクエストします。サードパーティの動画スティッチャーからストリーム マニフェストを取得したら、手動でトリガーする必要があります。これは、サードパーティの動画スティッチャーを使用した Pod Serving VOD にのみ使用され、他のストリーム リクエストには影響しません。

onTimedMetadata

onTimedMetadata(metadata)

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

パラメータ
メタデータ	オブジェクト メタデータのディクショナリ。 値を null にすることはできません。

previousCuePointForStreamTime

beforeCuePointForStreamTime(streamTime) は CuePoint を返します。

指定された配信時間の前キューポイントを返します。該当するキューポイントが存在しない場合は null を返します。これはスナップバックなどの機能を実装するために使用され、ユーザーをミッドロール挿入点に戻すためにユーザーがシークしたことをパブリッシャーが検出したときに呼び出されます。

パラメータ
streamTime	数値 シークされたストリーム時間。

戻り値

nullable CuePoint: 指定されたストリーム時間の前キューポイント。

processMetadata

processMetadata(type, data, timestamp)

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

パラメータ
type	string メタデータのタイプ。HLS の場合は「ID3」、DASH の場合はイベント メッセージ スキーム ID URI にする必要があります。
data	（非 null の Uint8Array または string） 未加工のタグデータ。ID3 の場合は、未加工のタグデータ全体である必要があります。DASH イベント メッセージの場合、これはメッセージ データ文字列です。
タイムスタンプ	数値 データを処理する時間（秒）。 DASH の場合、これはイベント メッセージの開始時間です。

replaceAdTagParameters

replaceAdTagParameters(adTagParameters)

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

パラメータ
adTagParameters	文字列プロパティを持つオブジェクト 新しい広告タグのパラメータ。 文字列値にする必要があります。 値を null にすることはできません。

requestStream

requestStream(streamRequest)

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

パラメータ
streamRequest	StreamRequest ストリーム メタデータを読み込むためのパラメータが含まれます。 値を null にすることはできません。

reset

reset()

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

setClickElement

setClickElement(clickElement)

広告のクリックスルー要素を設定します。この要素は、広告の再生中にクリックまたはタップのレシーバーとして使用され、現在のページから離れる原因になることがあります。これはサポートが終了しているため、代わりに adUiElement を StreamManager に渡す必要があります。adUiElement が StreamManager コンストラクタに指定された場合、このメソッドは何も行いません。

パラメータ
clickElement	要素 広告のクリックスルーとして使用される要素。 値は null の場合もあります。

非推奨

代わりに adUiElement を StreamManager コンストラクタに提供してください。

streamTimeForContentTime

StreamTimeForContentTime(contentTime) が数値を返す

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

パラメータ
contentTime	数値 広告なしのコンテンツの時間（秒単位）。

戻り値

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