adswizz-common/com.adswizz.common/AdPlayer

AdPlayer

interface AdPlayer

AdPlayer is an interface that describes the functionality of our media player and should be extended to create an SDK-compatible ad player.

Types

interface Listener

Callbacks that the player must fire.

data class MetadataItem(val key: String, val value: String)

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

enum Status : Enum<AdPlayer.Status>

Various player states

Properties

cacheAssetsHint

abstract var cacheAssetsHint: Boolean

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

enqueueEnabledHint

abstract var enqueueEnabledHint: Boolean

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

isBufferingWhilePaused

abstract val isBufferingWhilePaused: Boolean

Is buffering while paused

abstract val name: String

Name of the player, e.g. MyExternalImplementationOfAdPlayer

playerCapabilities

abstract val playerCapabilities: List<PlayerCapabilities>

Player capabilities as described in the VAST 4.0 document

abstract val playerState: List<PlayerState>

abstract val version: String

Player version, e.g. 1.0.0

abstract var volume: Float

Volume

Functions

abstract fun addListener(listener: AdPlayer.Listener)

Adds an AdPlayer.Listener callback.

clearVideoSurface

open fun clearVideoSurface(surface: Surface)

Removes a surface previously set to render the video content.

open fun dequeue(index: Int)

Dequeue - removes a creative from the playlist.

open fun enqueue(creativeUrlString: String, index: Int)

Enqueue - enqueues a new URL into the player.

abstract fun getCurrentTime(): Double

Gets the current time.

abstract fun getDuration(): Double?

Gets the duration.

abstract fun load(creativeUrlString: String)

Loads a new creative into the player.

abstract fun pause()

Pauses the current ad.

abstract fun play()

Plays the current ad.

open fun release()

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

abstract fun removeListener(listener: AdPlayer.Listener)

Removes an AdPlayer.Listener callback.

abstract fun reset()

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

abstract fun seekTo(position: Double)

Skips to a certain position.

abstract fun seekToTrackEnd()

Skips the current ad.

open fun setVideoState(videoState: AdVideoState?)

Sets the video view state for viewability purposes.

setVideoSurface

open fun setVideoSurface(surface: Surface)

Sets a surface to render the video content.

abstract fun status(): AdPlayer.Status

Status