adswizz-common/com.adswizz.common/MediaPlayerState/PlayerEvent

PlayerEvent

sealed class PlayerEvent

Various player states send as event changes through playerStatusFlow

Inheritors

Types

Buffering

data class Buffering(val id: String) : MediaPlayerState.PlayerEvent

This event should be triggered when the playback has paused when a buffering state occurred. This event should be triggered only for current playing ad creative. Specifies the instanceId from AdData as the required id parameter.

BufferingFinished

data class BufferingFinished(val id: String) : MediaPlayerState.PlayerEvent

This event is triggered when a media item has resumed after buffering finishes. This event should be triggered only for current media file (ad creative) during its playing phase Specifies the instanceId from AdData as the required id parameter.

Failed

data class Failed(val id: String, val error: MediaPlayerState.PlayerError) : MediaPlayerState.PlayerEvent

This event should be triggered when the media file (ad creative) for the corresponding ad failed to load or failed during playback. Specifies the instanceId from AdData as the required id parameter.

Finished

data class Finished(val id: String) : MediaPlayerState.PlayerEvent

This event should be triggered when the player finishes playing the current media file (ad creative). hSpecifies the instanceId from AdData as the required id parameter.

data class Loading(val id: String) : MediaPlayerState.PlayerEvent

This event should be triggered when the player starts loading the media file (ad creative) for the corresponding ad. Specifies the instanceId from AdData as the required id parameter.

LoadingFinished

data class LoadingFinished(val id: String) : MediaPlayerState.PlayerEvent

This event should be triggered when the player finishes loading the media file (ad creative) for the corresponding ad. Specifies the instanceId from AdData as the required id parameter.

Pause

data class Pause(val id: String) : MediaPlayerState.PlayerEvent

This event should be triggered when the player paused current the media file (ad creative). Specifies the instanceId from AdData as the required id parameter.

Resume

data class Resume(val id: String) : MediaPlayerState.PlayerEvent

This event should be triggered when the player resumes the current media file (ad creative). Specifies the instanceId from AdData as the required id parameter.

SkipAd

data class SkipAd(val id: String, val error: MediaPlayerState.PlayerError? = null) : MediaPlayerState.PlayerEvent

This event should be triggered when the player skipped the current media file (ad creative). Specifies the instanceId from AdData as the required id parameter and an optional PlayerError. error: PlayerError should be passed when the skip action is done due to Playback Exceptions.

StartPlaying

data class StartPlaying(val id: String) : MediaPlayerState.PlayerEvent

This event should be triggered when the player will begin to play the media file (ad creative). Specifies the instanceId from AdData as the required id parameter.

Properties

open val id: String