クラス StreamManager

ダイナミック広告挿入ストリームを処理します。このクラスは、DAI サーバーとのやり取りを管理し、 トラッキング ping を処理して、ストリーム イベントと広告イベントを生成します。
コンストラクタ
constructor
メソッド
addEventListener
指定されたイベントタイプのリスナーを追加します。
contentTimeForStreamTime
指定されたストリーム時間に対する広告なしのコンテンツ時間を返します。
focus
スキップ ボタンがある場合は、そのボタンにフォーカスを合わせます。
getAdSkippableState
ユーザーが現在の広告をスキップできる場合は true 値を返します。
loadStreamMetadata
DAI SDK に広告メタデータの読み込みをリクエストし、LOADED ストリーム イベントを生成します。
onTimedMetadata
処理済みのメタデータの辞書を渡します。
previousCuePointForStreamTime
指定されたストリーム時間に対する前のキューポイントを返します。
processMetadata
ストリームのタイミング付きメタデータを処理します。
removeEventListener
指定された StreamEvent イベントタイプのリスナーを削除します。
replaceAdTagParameters
今後のライブ ストリームの広告リクエストに使用されるすべての広告タグ パラメータを置き換えます。
requestStream
指定されたストリーム パラメータを使用して読み込むストリームを IMA DAI にリクエストします。
reset
ストリーム マネージャーをリセットし、継続的なポーリングを削除します。
streamTimeForContentTime
指定されたコンテンツ時間に対する広告付きの合計ストリーム時間を返します。

コンストラクタ

constructor

new StreamManager(videoElement: HTMLVideoElement, adUiElement?: HTMLElement, uiSettings?: UiSettings): StreamManager
パラメータ
videoElement: HTMLVideoElement 再生が行われる HTML 動画要素。
Optional adUiElement: HTMLElement 広告 UI がレンダリングされる要素。
Optional uiSettings: UiSettings このストリームに使用する UI 設定。
戻り値
StreamManager

メソッド

addEventListener

addEventListener(type: Type | Type[], listener: ((event: StreamEvent) => void)): void
指定されたイベントタイプのリスナーを追加します。
パラメータ
type: Type | Type[] 広告イベントタイプまたはイベントタイプの配列。
listener: ((event: StreamEvent) => void) 広告リスナーのコールバック関数。

contentTimeForStreamTime

contentTimeForStreamTime(streamTime: number): number
指定されたストリーム時間に対する広告なしのコンテンツ時間を返します。ライブ ストリームの場合は、指定されたストリーム 時間を返します。
パラメータ
streamTime: number コンテンツと広告を合わせたストリーム時間（秒単位）。
戻り値
number 指定されたストリーム時間に対するコンテンツ時間（広告は含まれません）。

focus

focus(): void
スキップ ボタンがある場合は、そのボタンにフォーカスを合わせます。ない場合は、フォーカスは インタラクティブ要素に戻ります。

getAdSkippableState

getAdSkippableState(): boolean
ユーザーが現在の広告をスキップできる場合は true 値を返します。この値が変更されると、StreamManager クラスは SKIPPABLE_STATE_CHANGED ストリーム イベントを生成します。
戻り値
boolean true ユーザーが現在の広告をスキップできる場合は、 false それ以外の場合は。

loadStreamMetadata

loadStreamMetadata(): void
DAI SDK に広告メタデータの読み込みをリクエストし、LOADED ストリーム イベントを生成します。 サードパーティの 動画スティッチャーからストリーム マニフェストを取得したら、このメソッドを手動で呼び出します。このメソッドは、サードパーティの動画 スティッチャー を使用するポッド配信 VOD ストリーム専用です。

onTimedMetadata

onTimedMetadata(metadata: {
  [key: string]: string;
}): void
処理済みのメタデータの辞書を渡します。辞書には、ユーザー定義のメタデータ文字列を値とする正確なキー "TXXX" が必要です。プレーヤーが未加工のメタデータを提供している場合は、代わりに StreamManager.processMetadata メソッドを呼び出します。
パラメータ
metadata: {
  [key: string]: string;
} 		メタデータの辞書。

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime: number): CuePoint
指定されたストリーム時間に対する前のキューポイントを返します。前のキューポイント が存在しない場合は、nullを返します。ユーザーがミッドロール挿入点に戻るようにシークしたときに メソッドを呼び出すことで、スナップバックなどの機能を実装できます。
パラメータ
streamTime: number ユーザーがシークするストリーム時間。
戻り値
CuePoint 指定されたストリーム時間に対する前のキューポイント。

processMetadata

processMetadata(type: string, data: string | Uint8Array, timestamp: number): void
ストリームのタイミング付きメタデータを処理します。動画プレーヤーが タイムスタンプ付きの解析されていないメタデータを提供している場合は、このメソッドを使用します。それ以外の場合は、 StreamManager.onTimedMetadata. を呼び出します。
パラメータ
type: string メタデータのタイプ。HLS の場合は 'ID3' 文字列、DASH の場合はイベント メッセージ スキーム ID URI にする必要があります。
data: string | Uint8Array 未加工のタグデータ。ID3 の場合は、未加工のタグデータ全体にする必要があります。DASH イベント メッセージの場合、 これはメッセージ データ文字列です。
timestamp: number データを処理する時間（秒単位）。DASH の場合、このパラメータはイベント メッセージの開始時間です。

removeEventListener

removeEventListener(type: Type, listener: ((event: StreamEvent) => void)): void
指定された StreamEvent イベントタイプのリスナーを削除します。リスナーを正常に削除するには、この メソッドに渡すリスナー パラメータが、以前に addEventListener メソッドに渡されたものと参照によって等しい必要があります。
パラメータ
type: Type リスナーを削除するイベントのタイプ。
listener: ((event: StreamEvent) => void) リスナーとして削除する関数。

replaceAdTagParameters

replaceAdTagParameters(adTagParameters: {
  [key: string]: string;
}): void
今後のライブ ストリームの広告リクエストに使用されるすべての広告タグ パラメータを置き換えます。
パラメータ
adTagParameters: {
  [key: string]: string;
} 		置き換える広告タグ パラメータ。文字列値にする必要があります。

requestStream

requestStream(streamRequest: StreamRequest): void
指定されたストリーム パラメータを使用して読み込むストリームを IMA DAI にリクエストします。
パラメータ
streamRequest: StreamRequest ストリーム メタデータを読み込むパラメータが含まれています。

reset

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

streamTimeForContentTime

streamTimeForContentTime(contentTime: number): number
指定されたコンテンツ時間に対する広告付きの合計ストリーム時間を返します。ライブ ストリームの場合は、指定された コンテンツ時間を返します。
パラメータ
contentTime: number 広告なしのコンテンツ時間（秒単位）。
戻り値
number DAI が広告を挿入した後の、指定されたコンテンツ時間に対応する合計ストリーム時間。