クラス: StreamManager

StreamManager

class   public

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

コンストラクタ

StreamManager

new StreamManager(videoElement, adUiElement, uiSettings)

コンストラクタ。

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

例外

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

プロパティ

clickElement

null 以外の HTMLElement

clickElement

null 以外の HTMLElement

streamMonitor

null 以外の PodServingStreamMonitor

メソッド

addEventListener

addEventListener(type, listener) returns void

指定されたイベント タイプに対するリスナーを追加します。

パラメータ
type	文字列 リッスンするイベントのタイプ。
listener	function(non-null StreamEvent) このタイプのイベントが発生するたびに呼び出される関数。

戻り値

void 

contentTimeForStreamTime

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

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

パラメータ
streamTime	数値 挿入された広告を含む配信時間（秒単位）。

戻り値

number 広告が削除された後の、指定された配信時間に対応するコンテンツ時間。

ピント

focus() は void を返します。

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

戻り値

void 

getAdSkippableState

getAdSkippableState() returns boolean

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

戻り値

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

loadStreamMetadata

loadStreamMetadata() は void を返します。

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

戻り値

void 

onTimedMetadata

onTimedMetadata(metadata) が void を返す

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

パラメータ
metadata	（null または文字列プロパティを持つ null 以外のオブジェクト） メタデータのディクショナリ。

戻り値

void 

previousCuePointForStreamTime

previousCuePointForStreamTime(streamTime) returns (null or CuePoint)

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

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

戻り値

(null or non-null CuePoint) 指定された配信時間の前のキューポイント。

processMetadata

processMetadata(type, data, timestamp) は void を返します。

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

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

戻り値

void 

removeEventListener

removeEventListener(type, listener) returns void

指定されたイベントタイプのリスナーを削除します。リスナー関数は、以前に addEventListener に渡された関数と参照によって等しくする必要があります。

パラメータ
type	文字列 リスナーを削除するイベントのタイプ。
listener	function(non-null StreamEvent) リスナーとして削除する関数。

戻り値

void 

replaceAdTagParameters

replaceAdTagParameters(adTagParameters) は void を返します

今後のライブ ストリームの広告リクエストに使用されるすべての広告タグ パラメータを置き換えます。

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

戻り値

void 

requestStream

requestStream(streamRequest) が void を返す

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

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

戻り値

void 

リセット

reset() は void を返します。

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

戻り値

void 

setClickElement

setClickElement(clickElement) は void を返します

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

パラメータ
clickElement	（null または null 以外の要素） 広告のクリックスルーとして使用される要素。

非推奨

代わりに、StreamManager コンストラクタに adUiElement を指定します。

戻り値

void 

streamTimeForContentTime

streamTimeForContentTime(contentTime) returns number

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

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

戻り値

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