VideoController

public final class VideoController


一个为视频广告提供播放控制的对象。

摘要

嵌套类型

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

公共方法

@Nullable VideoController.VideoLifecycleCallbacks

返回之前提供的 VideoLifecycleCallbacks;如果没有提供任何实例,则返回 null。

boolean

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

boolean

如果视频广告采用点击展开行为,则返回 true。

boolean

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

boolean

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

void
mute(boolean mute)

设置视频静音状态。

void

暂停视频广告(如果适用)。

void

播放视频广告(如果适用)。

void

设置一个监听器,用于接收视频事件的回调。

void

停止播放视频。

公共方法

getVideoLifecycleCallbacks

public @Nullable VideoController.VideoLifecycleCallbacks getVideoLifecycleCallbacks()

返回之前提供的 VideoLifecycleCallbacks;如果没有提供任何实例,则返回 null。

hasVideoContent

public boolean hasVideoContent()

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

isClickToExpandEnabled

public boolean isClickToExpandEnabled()

如果视频广告采用点击展开行为,则返回 true。

isCustomControlsEnabled

public boolean isCustomControlsEnabled()

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

使用 setCustomControlsRequested 启用自定义控件。

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

isMuted

public boolean isMuted()

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

静音

public void mute(boolean mute)

设置视频静音状态。

此视频控制方法仅在 isCustomControlsEnabled 返回 true 时有效。

参数
boolean mute

如果视频应静音,则为 true;如果视频应取消静音,则为 false

暂停

public void pause()

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

此视频控制方法仅在 isCustomControlsEnabled 返回 true 时有效。

播放

public void play()

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

此视频控制方法仅在 isCustomControlsEnabled 返回 true 时有效。

setVideoLifecycleCallbacks

public void setVideoLifecycleCallbacks(
    @Nullable VideoController.VideoLifecycleCallbacks callbacks
)

设置一个监听器,用于接收视频事件的回调。

参数
@Nullable VideoController.VideoLifecycleCallbacks callbacks

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

停止

public void stop()

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

广告单元必须位于允许列表中,才能使用此 API。如果您有意使用此功能,请与您的客户经理联系。