An object that provides playback control for video ads.
Nested Class Summary
class | VideoController.VideoLifecycleCallbacks | Callback for receiving updates on video ad lifecycle events. |
Public Method Summary
VideoController.VideoLifecycleCallbacks |
getVideoLifecycleCallbacks()
Returns the previously provided
VideoController.VideoLifecycleCallbacks or null if no instance was
provided.
|
boolean |
hasVideoContent()
Returns true if the current ad has video content.
|
boolean |
isClickToExpandEnabled()
Returns true if the video ad is using click to expand behavior.
|
boolean |
isCustomControlsEnabled()
Returns true if the video ad is using custom player controls.
|
boolean |
isMuted()
Returns true if the video is currently muted, false otherwise.
|
void |
mute(boolean mute)
Sets the video mute state.
|
void |
pause()
Pauses the video ad if applicable.
|
void |
play()
Play the video ad if applicable.
|
void |
setVideoLifecycleCallbacks(VideoController.VideoLifecycleCallbacks
callbacks)
Sets a listener that will receive callbacks for video events.
|
void |
stop()
Stops video playback.
|
Inherited Method Summary
Public Methods
public VideoController.VideoLifecycleCallbacks getVideoLifecycleCallbacks ()
Returns the previously provided
VideoController.VideoLifecycleCallbacks
or null if no instance was
provided.
public boolean hasVideoContent ()
Returns true if the current ad has video content.
public boolean isClickToExpandEnabled ()
Returns true if the video ad is using click to expand behavior.
public boolean isCustomControlsEnabled ()
Returns true if the video ad is using custom player controls. If custom player
controls are used, then it is the app's responsibility to render provide play/pause and
mute/unmute controls and call play()
,
pause()
,
and
mute(boolean)
at the appropriate times.
Use
VideoOptions.Builder.setCustomControlsRequested(boolean)
to enable custom
controls.
Custom controls are currently only available for Ad Manager reservations.
public boolean isMuted ()
Returns true if the video is currently muted, false otherwise.
public void mute (boolean mute)
Sets the video mute state.
This video control method only works when
isCustomControlsEnabled()
returns true.
Parameters
mute | true if video should be muted, false for unmuted |
---|
public void pause ()
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.
public void play ()
Play the video ad if applicable. This method is a no-op if the video is already playing or the video has ended.
This video control method only works when
isCustomControlsEnabled()
returns true.
public void setVideoLifecycleCallbacks (VideoController.VideoLifecycleCallbacks callbacks)
Sets a listener that will receive callbacks for video events.
Parameters
callbacks | the object that is to receive lifecycle callbacks |
---|
public void stop ()
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 allow list to be able to use this api. If you are interested in using this feature, reach out to your account manager.