StreamManager
處理動態廣告插播串流。這個平台會管理與 DAI 後端的互動，並處理追蹤連線偵測 (ping)，以及將串流和廣告事件轉送至發布商。這個管理員並非特定廣告的管理員，而是整個串流的管理程式，因此不會繼承 BaseAdsManager
建構函式
StreamManager
new StreamManager(videoElement, adUiElement, uiSettings)
參數 |
|
|---|---|
|
videoElement |
要播放的 HTML 影片元素。 值不得為空值。 |
|
adUiElement |
選用 用來存放廣告 UI 元素的 HTML 元素。這個元素的高度和寬度應與影片播放相同，且應直接重疊。如未提供，系統不會顯示任何使用者介面，也不會請求任何需要 UI 的廣告 (例如可略過的廣告)。 值不得為空值。 |
|
uiSettings |
選用 要用於這個串流的 UI 設定。 值不得為空值。 |
- 擲回
-
輸入參數不符合要求時
方法
contentTimeForStreamTime
contentTimeForStreamTime(streamTime) 傳回數字
傳回特定串流時間不含廣告的內容時間。傳回直播的特定串流時間。
參數 |
|
|---|---|
|
streamTime |
號碼 加入插播廣告的串流時間 (以秒為單位)。 |
- 傳回
-
number廣告移除後，與該串流時間相對應的內容時間。
主軸
Focus()
將焦點移至略過按鈕 (如果有的話)。如未顯示，焦點會放在互動式元素，包括圖示或互動式廣告素材。
getAdSkippableState
getAd 可略過 State() 傳回布林值
如果廣告目前可以略過，則傳回 true。當這個值變更時，StreamManager 會觸發 StreamEvent.SKIPPABLE_STATE_CHANGED 事件。
- 傳回
-
boolean如果目前可以略過廣告，則為「是」，否則傳回「否」。
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。
參數 |
|
|---|---|
|
類型 |
字串 中繼資料的類型。如果是 HTTP 即時串流，請使用「ID3」，或 DASH 的事件訊息配置 ID URI。 |
|
data |
(非空值 Uint8Array 或字串) 原始代碼資料。如果是 ID3，請提供完整的原始代碼資料。對於 DASH 事件訊息，這是訊息資料字串。 |
|
時間戳記 |
號碼 處理資料的時間 (以秒為單位)。 在 DASH 中，這是事件訊息開始時間。 |
replaceAdTagParameters
replaceAdTagParameters(adTagParameters)
替換即將用於直播廣告請求的所有廣告代碼參數。
參數 |
|
|---|---|
|
adTagParameters |
具有字串屬性的物件 新廣告代碼參數。 必須含有字串值。 值不得為空值。 |
requestStream
requestStream(streamRequest)
使用提供的串流參數要求載入串流。
參數 |
|
|---|---|
|
streamRequest |
包含用來載入串流中繼資料的參數。 值不得為空值。 |
重設
重設
重設直播管理員並移除任何連續輪詢。
setClickElement
setClickElement(clickElement)
設定廣告點閱元素。這個元素會在廣告播放時用來當做點擊或輕觸接收器，且使用者可能會離開目前的頁面。現已淘汰，且 adUiElement 應改為傳入 StreamManager。如果將 adUiElement 指派給 StreamManager 建構函式，這個方法就會成為免人工管理。
參數 |
|
|---|---|
|
clickElement |
元素 做為廣告點擊用的元素。 值可以是空值。 |
- 已淘汰
- 請改為將 adUiElement 提供給 StreamManager 建構函式。
streamTimeForContentTime
streamTimeForContentTime(contentTime) 傳回數字
傳回特定內容時間中含廣告的串流時間。傳回直播的特定內容時間。
參數 |
|
|---|---|
|
contentTime |
號碼 沒有廣告的內容時間 (以秒為單位)。 |
- 傳回
-
number的串流時間，會在廣告插入後與指定內容時間相對應。