类：BreakManager

cast.framework.break。BreakManager

class   static

用于管理广告插播的类。

方法

addBreak

addBreak(breakData, breakClips, broadCastMediaStatus) 返回布尔值

添加动态插播和广告插播剪辑。 插播时间点剪辑将与插播时间点相关联（break.breakClipIds 和 break.duration 将根据剪辑进行更新）。

参数

breakData

cast.framework.messages.Break

值不能为 null。

breakClips

非 null cast.framework.messages.BreakClip 数组

值不能为 null。

broadCastMediaStatus

可选

boolean

CAF 是否应检查当前广告插播状态是否已更改。在播放开始之前，这可能是不可取的，因为接收器可能仍需添加更多中断时间（例如，在加载完成期间）。
返回

boolean：如果成功添加广告插播时间点，则为 true。

getBreakById

getBreakById(id) 会返回 cast.framework.messages.Break

按 ID 获取当前的媒体插播时间点。

参数

id

string

广告插播时间点 ID。
返回

nullable cast.framework.messages.Break 

getBreakClipById

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

根据 ID 获取当前的媒体插播片段。

参数

id

string

剪辑 ID。
返回

nullable cast.framework.messages.BreakClip 

getBreakClipCurrentTimeSec

getBreakClipCurrentTimeSec() 返回数字

返回当前播放的广告插播时间点中的当前时间（以秒为单位）。

返回

nullable number：当前广告插播剪辑中的当前时间（以秒为单位）。如果播放器未播放广告插播时间点，则为 null。

getBreakClipDurationSec

getBreakClipDurationSec() 会返回数字

返回当前播放的广告插播时间点的时长（以秒为单位）。

返回

nullable number 当前广告插播片段的持续时间。如果播放器未播放广告插播时间点，则为 null。

getBreakClips

getBreakClips() 返回非 null cast.framework.messages.BreakClip 的数组

获取当前的媒体广告插播片段。

返回

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

getBreaks

getBreaks() 返回非 null cast.framework.messages.Break 的数组

获取当前的媒体插播时间点。

返回

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

getCreativeInfoByClipId

getCreativeInfoByClipId(breakClipId) 会返回 cast.framework.breaks.CreativeInformation

按 ID 获取与 Breakclip 相关联的广告素材信息。

参数

breakClipId

string

剪辑 ID。
返回

nullable cast.framework.breaks.CreativeInformation 

getPlayWatchedBreak

getPlayWatchedBreak() 返回布尔值

如果应播放已观看的插播时间点，则返回 true。

返回

boolean 

removeBreakById

removeBreakById(breakId) 返回布尔值

移除广告插播时间点和关联的插播片段。

参数

breakId

string

广告插播时间点 ID
返回

boolean：如果成功移除广告插播时间点，则为 true。

setBreakClipLoadInterceptor

setBreakClipLoadInterceptor(interceptor)

提供拦截器，让开发者能够在广告插播开始之前插入更多广告插播时间点剪辑或修改当前的广告插播时间点。

如果拦截器为 null，它会将拦截器重置为默认值。默认情况下，默认拦截器中的 VAST 提取和解析逻辑。 因此，如果开发者设置了自定义拦截器，VAST 逻辑将被替换，开发者应在提供的拦截器中实现自己的 VAST 提取和解析逻辑。

参数

拦截器

function(non-null cast.framework.messages.BreakClip, optional non-null cast.framework.breaks.BreakClipLoadInterceptorContext)

默认的插播时间点加载拦截器将返回与输入相同的插播时间点片段。

值可能为 null。

setBreakSeekInterceptor

setBreakSeekInterceptor(seekInterceptor)

为开发者提供拦截器，以指定要在跳转后播放的广告插播时间点。

参数

seekInterceptor

function(non-null cast.framework.breaks.BreakSeekData)

如果开发者想要将其重置为默认值，则 Interceptor 或 null。 默认的广告插播拦截器将返回与 SeedTo 值最接近的广告插播时间点。

值可能为 null。

setPlayWatchedBreak

setPlayWatchedBreak(playWatchedBreak)

设置一个标记，以控制是否应播放受监视的客户端拼接中断。

参数

playWatchedBreak

boolean

setVastTrackingInterceptor

setVastTrackingInterceptor(interceptor)

提供一个拦截器，用于在 VAST 跟踪网址被发送到服务器之前对其进行修改。 拦截器的输入是跟踪网址的字符串。拦截器可以返回修改后的网址字符串，也可以返回由网址字符串的修改后的 Promise 构成。 如果您想通过您自己的代码（而不是通过 CAF）发送跟踪网址，拦截器也可以返回 null。

参数

拦截器

function（字符串）

在发送之前修改网址的拦截器。

值可能为 null。