新增插播

addBreak(breakData, breakClips, broadCastMediaStatus) 會傳回布林值

新增動態中斷和中斷片段。 廣告插播片段會與中斷片段相關聯 (breaksbreak.breakClipIds 和 Break.duration)。

傳回

boolean 如果成功新增插播廣告，則為 True。

getBreakById

getBreakById(id) 會傳回 cast.framework.messages.Break

按 ID 取得目前的媒體廣告插播。

傳回

nullable cast.framework.messages.Break 

getBreakClipById

getBreakClipById(id) 會傳回 cast.framework.messages.BreakClip

根據 ID 取得目前的媒體廣告插播片段。

傳回

nullable cast.framework.messages.BreakClip 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() 傳回數字

傳回目前播放中的片段片段 (以秒為單位)。

傳回

nullable number：在目前中斷片段內，以秒為單位。如果播放器並未播放中斷片段，則為空值。

getBreakClipDurationSec

getBreakClipDurationSec() 傳回數字

傳回目前播放中的片段片段 (以秒為單位)。

傳回

nullable number目前中斷片段片段的時間長度。如果播放器並未播放中斷片段，則為空值。

getBreakClips

getBreakClips() 傳回非空值的 cast.framework.messages.BreakClip 陣列

取得目前的媒體中斷片段。

傳回

non-null Array of non-null cast.framework.messages.BreakClip 

getBreaks

getBreaks() 傳回非空值的 cast.framework.messages.Break 陣列

取得目前的媒體中斷點。

傳回

non-null Array of non-null cast.framework.messages.Break 

getCreativeInfoByClipId

getCreativeInfoByClipId(breakClipId) 會傳回 cast.framework.breaks.CreativeInformation

根據 ID 取得與廣告素材插播相關聯的廣告素材資訊。

傳回

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak 活動

getPlayWatchedBreak() 會傳回布林值

如果應播放已觀看廣告插播的時間點，則傳回「是」。

傳回

boolean 

移除中斷 ID

removeBreakById(breakId) 傳回布林值

移除休息時間與相關聯的中斷片段。

傳回

boolean 如果成功移除廣告時段，則為 True。

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(攔截器)

提供攔截器，讓開發人員在中斷之前插入更多中斷片段或修改目前的中斷片段。

如果攔截器為空值，系統會將攔截器重設為預設值。根據預設，VAST 擷取及剖析預設攔截邏輯。因此，如果自訂攔截器是由開發人員設定，則系統會覆寫 VAST 邏輯，且開發人員應在提供的攔截器中實作自己的 VAST 擷取和剖析邏輯。

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

為開發人員提供攔截器，讓他們在跳轉後指定要在哪個時間點播放影片。

setPlayWatchedBreak 設定

setPlayWatchedBreak(playWatchedBreak)

設定旗標，控制是否播放已觀看的用戶端拼接中斷情形。

setVastTrackingInterceptor

setVastTrackingInterceptor(攔截器)

提供攔截器修改 VAST 追蹤網址，然後再將其傳送至伺服器。 攔截器的輸入則是追蹤網址的字串。攔截器可以傳回修改後的網址字串，或是修改後字串的 Promise。 如果想透過自己的程式碼 (而非 CAF) 傳送追蹤網址，攔截器也可能會傳回空值。