VideoController

class VideoController

用于为视频广告提供播放控制的对象。

摘要

嵌套类型

用于接收视频广告生命周期事件更新的回调。

公共函数
VideoController.VideoLifecycleCallbacks?

返回之前提供的 VideoLifecycleCallbacks；如果未提供实例，则返回 null。
Boolean

如果当前广告包含视频内容，则返回 true。
Boolean

如果视频广告使用的是“点击展开”行为，则返回 true。
Boolean

如果视频广告使用自定义播放器控件，则返回 true。
Boolean

如果视频当前处于静音状态，则返回 true，否则返回 false。
Unit
mute(mute: Boolean)

设置视频静音状态。
Unit

暂停视频广告（如果适用）。
Unit

播放视频广告（如果适用）。
Unit

设置将接收视频事件回调的监听器。
Unit

停止播放视频。

公共函数

getVideoLifecycleCallbacks

fun getVideoLifecycleCallbacks(): VideoController.VideoLifecycleCallbacks?

返回之前提供的 VideoLifecycleCallbacks；如果未提供实例，则返回 null。

hasVideoContent

fun hasVideoContent(): Boolean

如果当前广告包含视频内容，则返回 true。

isClickToExpandEnabled

fun isClickToExpandEnabled(): Boolean

如果视频广告使用的是“点击展开”行为，则返回 true。

isCustomControlsEnabled

fun isCustomControlsEnabled(): Boolean

如果视频广告使用自定义播放器控件，则返回 true。如果使用自定义播放器控件，则应用有责任呈现播放/暂停和静音/取消静音控件，并在适当的时间调用 play、pause 和 mute。

使用 setCustomControlsRequested 启用自定义控件。

自定义控件目前仅适用于 Ad Manager 预订。

isMuted

fun isMuted(): Boolean

如果视频当前处于静音状态，则返回 true，否则返回 false。

静音

fun mute(mute: Boolean): Unit

设置视频静音状态。

只有当 isCustomControlsEnabled 返回 true 时，此视频控制方法才有效。

参数
mute: Boolean

如果应将视频静音，则为 true；否则为 false

暂停

fun pause(): Unit

暂停视频广告（如果适用）。如果视频已暂停或已结束，此方法将不执行任何操作。

只有当 isCustomControlsEnabled 返回 true 时，此视频控制方法才有效。

播放

fun play(): Unit

播放视频广告（如果适用）。如果视频已在播放，此方法将不执行任何操作。

只有当 isCustomControlsEnabled 返回 true 时，此视频控制方法才有效。

setVideoLifecycleCallbacks

fun setVideoLifecycleCallbacks(
    callbacks: VideoController.VideoLifecycleCallbacks?
): Unit

设置将接收视频事件回调的监听器。

参数
callbacks: VideoController.VideoLifecycleCallbacks?

要接收生命周期回调的对象

停止

fun stop(): Unit

停止播放视频。对 play 的后续调用将从视频开头继续。如果视频已停止，此方法将不执行任何操作。

广告单元必须列入许可名单，才能使用此 API。如果您有兴趣使用此功能，请与您的客户经理联系。