StreamManager
處理動態廣告插播串流。它會管理與 DAI 後端的互動,並處理追蹤 ping 以及將串流和廣告事件轉送至發布商。整合 CAF API,用於廣告 UI。
建構函式
StreamManager
new StreamManager(mediaElement)
                      參數 | 
                  |
|---|---|
| 
                         mediaElement  | 
                      
                         選用 播放媒體的 HTML 媒體元素。只有在使用自訂播放器時才提供。  | 
                    
- 擲回
 - 
                  
未提供必要參數時。
 
屬性
streamMonitor
非空值 PodServingStreamMonitor
方法
addEventListener
addEventListener(type, listener) 會傳回 void
為指定事件類型新增監聽器。
                      參數 | 
                  |
|---|---|
| 
                         類型  | 
                      
                         字串 要監聽的事件類型。  | 
                    
| 
                         事件監聽器  | 
                      
                         function(non-null StreamEvent) 每當發生這類事件時,系統就會呼叫這個函式。  | 
                    
- 傳回
 - 
                  
void 
getStreamId
getStreamId() 傳回值 (null 或字串)
傳回目前串流的串流 ID。
- 傳回
 - 
                  
(null or string) 
loadStreamMetadata
loadStreamMetadata() 傳回無效值
要求 SDK 載入廣告中繼資料,然後廣播 StreamEvent.LOADED。從第三方影片拼接器擷取串流資訊清單後,應手動觸發這項作業。這項參數僅用於搭配第三方影片拼接器的 VOD 連播放送,其他串流要求則不會執行。
- 傳回
 - 
                  
void 
removeEventListener
removeEventListener(type, listener) 會傳回 void
移除指定事件類型的監聽器。事件監聽器函式必須參照先前傳遞至 addEventListener 的函式。
                      參數 | 
                  |
|---|---|
| 
                         類型  | 
                      
                         字串 要移除事件監聽器的事件類型。  | 
                    
| 
                         事件監聽器  | 
                      
                         function(non-null StreamEvent) 要移除的事件監聽器函式。  | 
                    
- 傳回
 - 
                  
void 
replaceAdTagParameters
replaceAdTagParameters(adTagParameters) 會傳回 void
取代直播活動即將發出的廣告請求中使用的所有廣告代碼參數。
                      參數 | 
                  |
|---|---|
| 
                         adTagParameters  | 
                      
                         含有字串屬性的物件 新的廣告代碼參數。必須是字串值。 值不得為空值。  | 
                    
- 傳回
 - 
                  
void 
requestStream
requestStream(loadRequest, streamRequest) returns Promise containing (null, non-null cast.framework.messages.LoadRequestData, or non-null cast.framework.messages.ErrorData)
要求使用提供的串流參數載入串流。使用已載入的串流資料填入 loadRequest。
                      參數 | 
                  |
|---|---|
| 
                         loadRequest  | 
                      
                         cast.framework.messages.LoadRequestData 值不得為空值。  | 
                    
| 
                         streamRequest  | 
                      
                        
                         值不得為空值。  | 
                    
- 傳回
 - 
                  
non-null Promise containing (null, non-null cast.framework.messages.LoadRequestData, or non-null cast.framework.messages.ErrorData) 
重設
reset() 傳回無效值
重設串流管理員,並移除任何持續輪詢。
- 傳回
 - 
                  
void