AdPlayer

Callbacks that the player must fire.

MetadataItem encapsulates one key-value item used in the onMetadata callback

Various player states

Cache assets hint - the AdPlayer may or may not implement this AdManager hint.

Enqueue enabled hint - the AdPlayer may or may not implement this AdManager hint.

Is buffering while paused. Returns:
true if the player buffers the content while paused and starts from that same point when it resumes;
false if the player does not buffer while paused, and when it resumes the playback starts from the live frame of the stream

Name of the player, e.g. MyExternalImplementationOfAdPlayer

Player capabilities as described in the VAST 4.0 document

Player version, e.g. 1.0.0

return Current player volume. The value will be between 0.0f and 1.0f

Adds an AdPlayer.Listener callback.
listener: AdPlayer.Listener callback to be add

Removes a surface previously set to render the video content.
surface - the surface that was used to render the video content

Dequeue - removes a creative from the playlist.
index - the position from which we want to remove the creative

Enqueue - enqueues a new URL into the player.
creativeUrlString - the url we want to enqueue
index - the position on the playlist we want to enqueue it on.

Gets the current time. return the current playback time in seconds

Gets the duration. return the current track duration in seconds

Loads a new creative into the player.
creativeUrlString - the url we want to load

Pauses the current ad.

Plays the current ad.

This method will be called when any instance of: AdManager, AdswizzAdStreamManager, AdswizzAdPodcastManager wants to free up the resources used is their lifecycle.

Removes an AdPlayer.Listener callback.
listener: AdPlayer.Listener callback to be removed

Resets the player. Should be able to rerun ads from the beginning.

Skips to a certain position.
position: where to jump player playhead

Skips the current ad.

Sets the video view state for viewability purposes.
videoState - the state of the video view. Possible values: MINIMIZED, COLLAPSED, NORMAL, EXPANDED, FULLSCREEN

Sets a surface to render the video content.
surface - the surface to be used to render the video content

return the current status for a player. The enum with all possible values is defined here: Status