VideoController

fun mute(mute: Boolean): Unit

Sets the video mute state.

This video control method only works when isCustomControlsEnabled returns true.

fun pause(): Unit

Pauses the video ad if applicable. This method is a no-op if the video is already paused or the video has ended.

This video control method only works when isCustomControlsEnabled returns true.

fun play(): Unit

Play the video ad if applicable. This method is a no-op if the video is already playing.

This video control method only works when isCustomControlsEnabled returns true.

fun stop(): Unit

Stops video playback. Subsequent calls to play will resume at the beginning of the video. This method is a no-op if the video has already been stopped.

The ad unit must be in the allowlist to be able to use this API. If you are interested in using this feature, reach out to your account manager.

val isCustomControlsEnabled: Boolean

Returns true if the video ad is using custom video playback controls. When custom controls are enabled, it is the app's responsibility to render and provide play/pause and mute/unmute controls and call play, pause, and mute at the appropriate times.

Use VideoOptions.Builder.customControlsRequested to enable custom controls.

This feature is currently only available for Ad Manager reservation ads.

val isMuted: Boolean

true if the video is currently muted, false otherwise.

var videoLifecycleCallbacks: VideoController.VideoLifecycleCallbacks?

Callback for receiving video events.