cast. 框架。 中断。 BreakManager
用于管理广告插播的类。
方法
getBreakById
getBreakById(id) 返回 cast.framework.messages.Break
按 ID 获取当前媒体段。
参数 |
|
---|---|
id |
字符串 广告插播 ID。 |
- 返回
-
nullable cast.framework.messages.Break
getBreakClipById
getBreakClipById(id) 返回 cast.framework.messages.BreakClip
按 ID 获取当前媒体广告插播剪辑。
参数 |
|
---|---|
id |
字符串 剪辑 ID。 |
- 返回
-
nullable cast.framework.messages.BreakClip
getBreakClipCurrentTimeSec
getBreakClipCurrentTimeSec() 返回编号
返回当前正在播放的广告插播剪辑中的当前时间(以秒为单位)。
- 返回
-
nullable number
当前广告插播片段内的当前时间(以秒为单位)。如果播放器未播放广告插播剪辑,则为 null。
getBreakClipDurationSec
getBreakClipDurationSec() 返回数字
返回当前播放的广告插播剪辑的时长(以秒为单位)。
- 返回
-
nullable number
:当前广告插播剪辑的时长。如果播放器未播放广告插播剪辑,则为 null。
getBreakClip
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
getPlayWatchedBreak
getPlayWatchedBreak() 返回布尔值
如果应播放已观看的广告插播时间点,则返回 true。
- 返回
-
boolean
setBreakClipLoadInterceptor
setBreakClipLoadInterceptor(拦截器)
提供拦截器,以允许开发者在广告插播开始前插入更多广告插播剪辑或修改当前广告插播剪辑。
如果拦截器为 null,它会将拦截器重置为默认拦截器。 默认情况下,VAST 提取和解析逻辑位于默认拦截器中。 因此,如果开发者设置了自定义拦截器,那么 VAST 逻辑将被替换,开发者应在提供的拦截器中实现自己的 VAST 提取和解析逻辑。
参数 |
|
---|---|
拦截器 |
函数(非 null cast.framework.messages.BreakClip,可选非 null cast.framework.breaks.BreakClipLoadInterceptorContext) 默认广告插播剪辑拦截器会返回与输入内容相同的广告插播剪辑。 值可以为 null。 |
setBreakSeekInterceptor
setBreakSeekInterceptor(seekInterceptor)
为开发者提供拦截器,以指定他们希望跳转后播放哪些断点。
参数 |
|
---|---|
findInterceptor |
函数(非 null cast.framework.breaks.BreakSeekData) 拦截器;如果开发者想要将其重置为默认处理程序,则为 null。 默认的中断定位拦截器将从 findTo 值返回最接近的中断。 值可以为 null。 |
setPlayWatchedBreak
setPlayWatchedBreak(playWatchedBreak)
设置一个标志,以控制是否应播放观看到的客户端拼接时间点。
参数 |
|
---|---|
playWatchedBreak |
布尔值 |
setVastTrackingInterceptor
setVastTrackingInterceptor(拦截器)
提供拦截器,以便在将 VAST 跟踪网址发送到服务器之前修改该网址。 拦截器的输入是跟踪网址的字符串。拦截器可以返回修改后的网址字符串,也可以返回经过修改的网址字符串的 Promise。 如果您希望通过自己的代码而不是 CAF 发送跟踪网址,拦截器也可以返回 null。
参数 |
|
---|---|
拦截器 |
函数(字符串) 在发送之前修改网址的拦截器。 值可以为 null。 |