StreamManager
ダイナミック広告挿入のストリームを処理します。DAI バックエンドとの通信の管理、トラッキング ping の処理、パブリッシャーへのストリームや広告イベントの転送を行います。このマネージャーは特定の広告のマネージャーではないため、BaseAdsManager から継承されませんが、ストリーム全体のマネージャーとなります。
コンストラクタ
StreamManager
new StreamManager(videoElement, adUiElement, uiSettings)
パラメータ |
|
---|---|
videoElement |
再生が行われる HTML 動画要素。 値を null にすることはできません。 |
adUiElement |
省略可 広告 UI 要素を保持するために使用する HTML 要素。この要素は動画再生と同じ高さと幅で、直接重ねる必要があります。指定しない場合、UI は表示されず、UI を必要とする広告(スキップ可能な広告など)はリクエストされません。 値を null にすることはできません。 |
uiSettings |
省略可 このストリームに使用する UI 設定。 値を null にすることはできません。 |
- 実装
- EventTarget
- 例外
-
入力パラメータが要件を満たしていない場合。
Methods
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 |
文字列 メタデータのタイプ。HLS の場合は「ID3」、DASH の場合はイベント メッセージ スキーム ID URI を指定する必要があります。 |
data |
(非 null Uint8Array または文字列) 元のタグデータ。ID3 の場合は、未加工のタグデータ全体を指定する必要があります。DASH イベント メッセージの場合、これはメッセージ データの文字列です。 |
timestamp |
数値 データを処理する時間(秒)。 DASH の場合、これはイベント メッセージの開始時間です。 |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)
ライブ ストリームの今後の広告リクエストに使用されるすべての広告タグパラメータを置き換えます。
パラメータ |
|
---|---|
adTagParameters |
文字列プロパティを持つオブジェクト 新しい広告タグのパラメータ。 文字列値を指定する必要があります。 値を null にすることはできません。 |
requestStream
requestStream(streamRequest)
指定されたストリーム パラメータを使用してストリームの読み込みをリクエストします。
パラメータ |
|
---|---|
streamRequest |
ストリーム メタデータを読み込むためのパラメータが格納されます。 値を null にすることはできません。 |
リセット
reset()
ストリーム マネージャーをリセットし、継続的なポーリングを削除します。
setClickElement
setClickElement(clickElement)
広告のクリック スルー要素を設定します。この要素は、広告の再生中にクリック レシーバーまたはタップ レシーバーとして使用され、現在のページから離れる場合もあります。これは非推奨となったため、代わりに adUiElement を StreamManager に渡す必要があります。adUiElement が StreamManager コンストラクタに渡されると、このメソッドは処理を行いません。
パラメータ |
|
---|---|
clickElement |
要素 広告のクリックスルーに使用される要素。 値を null にすることもできます。 |
- 非推奨
- 代わりに、adUiElement を StreamManager コンストラクタに提供してください。
streamTimeForContentTime
streamTimeForContentTime(contentTime) は、数値を返します。
指定されたコンテンツ時間での広告のストリーミング時間を返します。ライブ ストリームに指定されたコンテンツ時刻を返します。
パラメータ |
|
---|---|
contentTime |
数値 広告なしのコンテンツの時間(秒) |
- 戻り値
-
number
: 広告が挿入されたとき、特定のコンテンツ時間に対応するストリーム時間。