類別：BreakManager

cast.架構。破壞。BreakManager

class   static

用於管理廣告插播時間點的類別。

方法

addBreak

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

新增動態廣告插播及中斷片段。廣告插播片段和廣告插播相關聯 (break.breakClipIds 和 break.duration，會根據片段更新)。

參數
breakData	cast.framework.messages.Break 值不得為空值。
breakClips	非空值 cast.framework.messages.BreakClip 陣列 值不得為空值。
broadCastMediaStatus	選用 boolean 指定 CAF 是否應檢查目前的廣告插播狀態是否已變更。這可能無法在開始播放前提出，因為接收方可能仍需新增更多插播時間點，例如在載入完成期間。

傳回

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

getBreakById

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

依據 ID 取得目前的媒體廣告插播時間點。

參數
id	字串 中斷 ID。

傳回

nullable cast.framework.messages.Break 

getBreakClipById

getBreakClipById(id) returns cast.framework.messages.BreakClip

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

參數
id	字串 剪輯片段 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 相關聯的廣告素材資訊。

參數
breakClipId	字串 剪輯片段 ID。

傳回

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

getPlayWatchedBreak() 傳回布林值

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

傳回

boolean 

removeBreakById

removeBreakById(breakId) 傳回布林值

移除廣告插播片段和相關的廣告插播片段。

參數
breakId	字串 廣告插播 ID

傳回

boolean 如果已成功移除廣告插播時間點，則為 True。

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(interceptor)

提供攔截器，讓開發人員在休息前插入更多分段片段，或修改目前的廣告插播片段。

如果攔截器為 null，則會將攔截器重設為預設值。根據預設，VAST 擷取及剖析預設攔截器中的邏輯。 因此，如果開發人員設定自訂攔截器，VAST 邏輯將遭到覆寫，開發人員應在提供的攔截器中導入自己的 VAST 擷取和剖析邏輯。

參數
攔截器	function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext) 預設的中斷剪輯載入攔截器會傳回與輸入相同的中斷剪輯。 值可以是空值。

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

為開發人員提供攔截器，指定他們在跳轉後想要播放的中斷點。

參數
seekInterceptor	function(non-null cast.framework.breaks.BreakSeekData) 攔截器或空值 (如果開發人員想將其重設為預設值)。預設中斷搜尋攔截器會從 findTo 值傳回最接近的中斷時間點。 值可以是空值。

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

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

參數
playWatchedBreak	boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(interceptor)

提供攔截器，在網址傳送至伺服器之前修改 VAST 追蹤網址。 攔截器的輸入是追蹤網址的字串。 攔截器可能會傳回修改後的網址字串，或是網址經過修改的字串。如果您想使用自己的程式碼 (而非 CAF) 傳送追蹤網址，則攔截器也可能會傳回空值。

參數
攔截器	function(字串) 攔截器在傳送前修改網址。 值可以是空值。