StreamManager
處理動態廣告插播串流。這個外掛程式能管理與 DAI 後端的互動，並處理追蹤連線偵測 (ping) 以及將串流和廣告事件轉送給發布商。這個管理員不會繼承 BaseAD 的特定廣告，因為該管理員並非特定廣告的管理工具，而是整個串流的管理器。
建構函式
StreamManager
new StreamManager(videoElement、adUiElement、uiSettings)
參數 |
|
|---|---|
|
videoElement |
要播放的 HTML 影片元素。 值不得為空值。 |
|
adUiElement |
選用 用來存放廣告 UI 元素的 HTML 元素。這個元素的高度和寬度應與影片播放相同，且應直接重疊。如未提供，系統就不會顯示任何使用者介面，也不會要求不需要 UI 的廣告 (例如可略過的廣告)。 值不得為空值。 |
|
uiSettings |
選用 這個串流使用的 UI 設定。 值不得為空值。 |
- 實作
- EventTarget
- 擲回
-
。
方法
contentTimeForStreamTime
contentTimeForStreamTime(streamTime) 傳回數字
傳回指定串流時間不含廣告的內容時間。傳回直播指定的串流時間。
參數 |
|
|---|---|
|
streamTime |
號碼 插入廣告的串流時間 (以秒為單位)。 |
- 傳回
-
number廣告移除後與指定串流時間相對應的內容時間。
主軸
聚焦()
將焦點放在略過按鈕 (如果有的話)。如果沒有，則焦點會放在互動式元素，包括圖示或互動式廣告素材。
getAdSkippableState
getAd 可略過 State() 傳回布林值
如果廣告目前可以略過，則傳回 true。當這個值有所變更，StreamManager 會觸發 StreamEvent.SKIPPABLE_STATE_CHANGED 事件。
- 傳回
-
boolean如果廣告目前可以略過，則為 True，否則為 false。
loadStreamMetadata
loadStreamMetadata()
要求 SDK 載入廣告中繼資料，然後播送 StreamEvent.LOADED。 從第三方影片拼接工具擷取串流資訊清單後，您應該手動觸發這個動作。這個類型僅適用於具有第三方影片拼接工具的 Pod 放送 VOD，其他串流要求免人工管理。
onTimedMetadata
onTimedMetadata(metadata)
傳送到已處理中繼資料的字典。字典預期鍵「TXXX」鍵以及使用者定義的中繼資料字串做為值。如果您的播放器提供原始中繼資料，請改為呼叫 StreamManager.processMetadata。
參數 |
|
|---|---|
|
中繼資料 |
物件 中繼資料字典。 值不得為空值。 |
previousCuePointForStreamTime
beforeCuePointForStreamTime(streamTime) 會傳回 CuePoint
傳回指定串流時間的上一個提示點。如果沒有這類提示點，則傳回空值。這會用於實作復原等功能，並在發布商偵測到使用者為了將使用者返回廣告插播時間點而搜尋時呼叫的功能。
參數 |
|
|---|---|
|
streamTime |
號碼 要求的串流時間 |
- 傳回
-
nullable CuePoint是指定串流時間的上一個提示點。
processMetadata
processMetadata(type, data, timestamp)
處理直播的中繼資料。如果您的影片播放器提供未剖析的中繼資料與時間戳記，請使用此欄位，否則請呼叫 StreamManager.onTimedMetadata。
參數 |
|
|---|---|
|
類型 |
字串 中繼資料類型。必須是 HLS 的「ID3」或是 DASH 的事件訊息配置 ID URI。 |
|
資料或曾存取這類資料的人員 |
(非空值 Uint8Array 或字串) 原始代碼資料。ID3 必須是完整的原始標記資料。如果是 DASH 事件訊息，這是指訊息資料字串。 |
|
時間戳記 |
號碼 處理資料的時間 (以秒為單位)。 對於 DASH，這是事件訊息開始時間。 |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)
針對即將放送的直播活動廣告請求，替換使用的所有廣告代碼參數。
參數 |
|
|---|---|
|
adTagParameters |
含有字串屬性的物件 新的廣告代碼參數。 必須包含字串值。 值不得為空值。 |
requestStream
requestStream(streamRequest)
要求使用提供的串流參數載入串流。
參數 |
|
|---|---|
|
streamRequest |
包含用來載入串流中繼資料的參數。 值不得為空值。 |
重設
重設()
重設直播管理員，並移除任何持續進行的輪詢。
setClickElement
setClickElement(clickElement)
設定廣告點擊元素。廣告播放時，這個元素會用來當做點擊或輕觸接收器，而且可能會導致使用者離開目前頁面。現已淘汰，應改為將 adUiElement 傳入 StreamManager。如果為 StreamManager 建構函式提供 adUiElement，這個方法就會成為免人工管理。
參數 |
|
|---|---|
|
clickElement |
元素 做為廣告點擊的元素。 值可以是空值。 |
- 已淘汰
- 將 adUiElement 提供給 StreamManager 建構函式。
streamTimeForContentTime
StreamTimeForContentTime(contentTime) 會傳回數字
傳回特定內容時間含廣告的串流時間。傳回直播的指定內容時間。
參數 |
|
|---|---|
|
contentTime |
號碼 不含任何廣告的內容時間 (以秒為單位)。 |
- 傳回
-
number插入廣告後與指定內容時間對應的串流時間。