PlayerEvent

sealed class PlayerEvent : Event

Includes all possible events that only the Player can emit.

Types

Active

class Active : PlayerEvent

Emitted when a Source or PlaylistConfig is loaded into the player.

AdBreakFinished

data class AdBreakFinished(adBreak: AdBreak?) : PlayerEvent

Emitted when an ad break has finished.

AdBreakStarted

data class AdBreakStarted(adBreak: AdBreak?) : PlayerEvent

Emitted when an ad break has started.

AdClicked

data class AdClicked(clickThroughUrl: String?) : PlayerEvent

Emitted when an ad was clicked.

AdError

data class AdError(adItem: AdItem?, code: Int, message: String?, adConfig: AdConfig?) : PlayerEvent

Emitted when an error with the ad playback occurs.

AdFinished

data class AdFinished(ad: Ad?) : PlayerEvent

Emitted when an ad has finished playback.

AdLinearityChanged

data class AdLinearityChanged(isLinear: Boolean) : PlayerEvent

Emitted when the linearity of a VPAID ad changes.

AdManifestLoad

data class AdManifestLoad(adConfig: AdConfig, adBreak: AdBreak?) : PlayerEvent

Emitted when the download of an ad manifest is started.

AdManifestLoaded

data class AdManifestLoaded(adConfig: AdConfig, adBreak: AdBreak?, downloadTime: Long) : PlayerEvent

Emitted when an ad manifest was successfully loaded.

AdQuartile

data class AdQuartile(quartile: AdQuartile) : PlayerEvent

Emitted when the playback of an ad has progressed over a quartile boundary.

AdScheduled

data class AdScheduled(numberOfAds: Int) : PlayerEvent

Emitted when an ad manifest was successfully downloaded, parsed and added into the ad break schedule.

AdSkipped

data class AdSkipped(ad: Ad?) : PlayerEvent

Emitted when an ad was skipped.

AdStarted

data class AdStarted(clientType: AdSourceType?, clickThroughUrl: String?, indexInQueue: Int, duration: Double, timeOffset: Double, position: String?, skipOffset: Double, ad: Ad?) : PlayerEvent

Emitted when the playback of an ad has started.

AudioPlaybackQualityChanged

data class AudioPlaybackQualityChanged(oldAudioQuality: AudioQuality?, newAudioQuality: AudioQuality?) : PlayerEvent

Emitted when the current audio playback quality has changed.

CastAvailable

class CastAvailable : PlayerEvent

Emitted when casting to a cast-compatible device is available.

CastPaused

class CastPaused : PlayerEvent

Emitted when the playback on a cast-compatible device was paused.

CastPlaybackFinished

class CastPlaybackFinished : PlayerEvent

Emitted when the playback on a cast-compatible device has finished.

CastPlaying

class CastPlaying : PlayerEvent

Emitted when playback on a cast-compatible device has started.

CastStart

class CastStart : PlayerEvent

Emitted when casting is initiated, but the user still needs to choose which device should be used.

CastStarted

data class CastStarted(deviceName: String?) : PlayerEvent

Emitted when the cast app is launched successfully.

CastStopped

class CastStopped : PlayerEvent

Emitted when casting to a cast-compatible device is stopped.

CastTimeUpdated

class CastTimeUpdated : PlayerEvent

Emitted when the time update from the currently used cast-compatible device is received.

CastWaitingForDevice

data class CastWaitingForDevice(castPayload: CastPayload) : PlayerEvent

Emitted when a cast-compatible device has been chosen and the player is waiting for the device to get ready for playback.

CueEnter

data class CueEnter(cue: Cue) : PlayerEvent

Emitted when a subtitle cue transitions into the active status.

CueExit

data class CueExit(cue: Cue) : PlayerEvent

Emitted when an active subtitle cue transitions into the inactive status.

Destroy

class Destroy : PlayerEvent

Emitted when the player was destroyed.

DroppedVideoFrames

data class DroppedVideoFrames(droppedFrames: Int, elapsedTime: Double) : PlayerEvent

Emitted when video frames have been dropped.

DvrWindowExceeded

class DvrWindowExceeded : PlayerEvent

Emitted when the player is paused or in buffering state and the timeShift offset has exceeded the available timeShift window.

Error

data class Error(code: PlayerErrorCode, message: String, data: Any?) : PlayerEvent, ErrorEvent

Emitted when a player error occurred.

FullscreenDisabled

class FullscreenDisabled : PlayerEvent

Emitted when the fullscreen functionality has been disabled.

FullscreenEnabled

class FullscreenEnabled : PlayerEvent

Emitted when the fullscreen functionality has been enabled.

FullscreenEnter

class FullscreenEnter : PlayerEvent

Emitted when the player enters fullscreen mode.

FullscreenExit

class FullscreenExit : PlayerEvent

Emitted when the player exits fullscreen mode.

Impression

data class Impression(data: ImpressionData) : PlayerEvent

Emitted when an impression call succeeded.

Inactive

class Inactive : PlayerEvent

Emitted when the player was unloaded.

LicenseValidated

data class LicenseValidated(data: LicenseData) : PlayerEvent

Emitted when a licensing call succeeded.

Metadata

data class Metadata(metadata: Metadata, type: String) : PlayerEvent

Emitted when metadata (e.g.

Muted

class Muted : PlayerEvent

Emitted when the player is muted.

Paused

data class Paused(time: Double) : PlayerEvent

Emitted when the player is paused.

PictureInPictureAvailabilityChanged

data class PictureInPictureAvailabilityChanged(isPictureInPictureAvailable: Boolean) : PlayerEvent

Emitted when the availability of the Picture-in-Picture mode changed.

PictureInPictureEnter

class PictureInPictureEnter : PlayerEvent

Emitted when the player enters Picture-In-Picture mode.

PictureInPictureExit

class PictureInPictureExit : PlayerEvent

Emitted when the player exits Picture-In-Picture mode.

Play

data class Play(time: Double) : PlayerEvent

Emitted when the player receives an intention to play (i.

PlaybackFinished

class PlaybackFinished : PlayerEvent

Emitted when playback of the Source has finished.

Playing

data class Playing(time: Double) : PlayerEvent

Emitted when the player enters the playing state after calling Player.play.

PlaylistTransition

data class PlaylistTransition(from: Source, to: Source) : PlayerEvent

Emitted when the player transitions between two sources in a playlist.

Ready

class Ready : PlayerEvent

Emitted when the player is ready to play and to handle API calls.

RenderFirstFrame

class RenderFirstFrame : PlayerEvent

Emitted when the first frame of the current video is rendered onto the video surface.

ScalingModeChanged

data class ScalingModeChanged(from: ScalingMode, to: ScalingMode) : PlayerEvent

Emitted when the PlayerView.

Seek

data class Seek(from: SeekPosition, to: SeekPosition) : PlayerEvent

Emitted when the player starts seeking.

Seeked

class Seeked : PlayerEvent

Emitted when seeking has finished and data is available to continue playback.

StallEnded

class StallEnded : PlayerEvent

Emitted when the player ends stalling due to enough data being buffered.

StallStarted

class StallStarted : PlayerEvent

Emitted when the player begins to stall and to buffer due to an empty buffer.

TimeChanged

data class TimeChanged(time: Double) : PlayerEvent

Emitted when the current playback time has changed.

TimeShift

data class TimeShift(position: Double, target: Double) : PlayerEvent

Emitted when the player starts time shifting.

TimeShifted

class TimeShifted : PlayerEvent

Emitted when time shifting has finished and data is available to continue playback.

Unmuted

class Unmuted : PlayerEvent

Emitted when the player is unmuted.

VideoPlaybackQualityChanged

data class VideoPlaybackQualityChanged(oldVideoQuality: VideoQuality?, newVideoQuality: VideoQuality?) : PlayerEvent

Emitted when the current video playback quality has changed.

VideoSizeChanged

data class VideoSizeChanged(width: Int, height: Int, aspectRatio: Float) : PlayerEvent

Emitted when the current size of the video content has changed.

VrStereoChanged

data class VrStereoChanged(isStereo: Boolean) : PlayerEvent

Emitted when the VR stereo mode during playback of VR content changes.

VrViewingDirectionChange

class VrViewingDirectionChange : PlayerEvent

Emitted when the VR viewing direction changes.

VrViewingDirectionChanged

class VrViewingDirectionChanged : PlayerEvent

Emitted when the VR viewing direction did not change more than the specified threshold in the last interval, after the VrViewingDirectionChange event was triggered.

Warning

data class Warning(code: PlayerWarningCode, message: String) : PlayerEvent, WarningEvent

Emitted when a player warning occurred.

Inherited properties

timestamp

var timestamp: Long

The time at which the event was emitted.

Inheritors

PlayerEvent