Types

Link copied to clipboard

Emitted when a playback session was started. This event is emitted immediately after the load call und does not wait for actual data to be loaded.

Link copied to clipboard
data class AdBreakFinished(val adBreak: AdBreak? = null) : PlayerEvent

Emitted when an ad break has finished.

Link copied to clipboard
data class AdBreakStarted(val adBreak: AdBreak? = null) : PlayerEvent

Emitted when an ad break has started.

Link copied to clipboard
data class AdClicked(val clickThroughUrl: String?) : PlayerEvent

Emitted when an ad was clicked.

Link copied to clipboard
data class AdError(val adItem: AdItem?, val code: Int, val message: String?, val adConfig: AdConfig? = null) : PlayerEvent

Emitted when an error with the ad playback occurs.

Link copied to clipboard
data class AdFinished(val ad: Ad? = null) : PlayerEvent

Emitted when an ad has finished playback.

Link copied to clipboard
data class AdLinearityChanged(val isLinear: Boolean) : PlayerEvent

Emitted when the linearity of a VPAID ad changes.

Link copied to clipboard
data class AdManifestLoad(val adConfig: AdConfig, val adBreak: AdBreak? = null) : PlayerEvent

Emitted when the download of an ad manifest is started.

Link copied to clipboard
data class AdManifestLoaded(val adConfig: AdConfig, val adBreak: AdBreak? = null, val downloadTime: Long) : PlayerEvent

Emitted when an ad manifest was successfully loaded.

Link copied to clipboard
data class AdQuartile(val quartile: AdQuartile) : PlayerEvent

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

Link copied to clipboard
data class AdScheduled(val numberOfAds: Int) : PlayerEvent

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

Link copied to clipboard
data class AdSkipped(val ad: Ad? = null) : PlayerEvent

Emitted when an ad was skipped.

Link copied to clipboard
data class AdStarted(val clientType: AdSourceType?, val clickThroughUrl: String?, val indexInQueue: Int, val duration: Double, val timeOffset: Double, val position: String?, val skipOffset: Double, val ad: Ad? = null) : PlayerEvent

Emitted when the playback of an ad has started.

Link copied to clipboard
data class AudioPlaybackQualityChanged(val oldAudioQuality: AudioQuality?, val newAudioQuality: AudioQuality?) : PlayerEvent

Emitted when the current audio playback quality has changed.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
data class CastStarted(val deviceName: String?) : PlayerEvent

Emitted when the cast app is launched successfully.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
data class CastWaitingForDevice(val 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.

Link copied to clipboard
data class CueEnter(val cue: Cue) : PlayerEvent

Emitted when a subtitle cue transitions into the active status.

Link copied to clipboard
data class CueExit(var cue: Cue) : PlayerEvent

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

Link copied to clipboard

Emitted when the player was destroyed.

Link copied to clipboard
data class DroppedVideoFrames(val droppedFrames: Int, val elapsedTime: Double) : PlayerEvent

Emitted when video frames have been dropped.

Link copied to clipboard

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

Link copied to clipboard
data class Error(val code: PlayerErrorCode, val message: String, val data: Any? = null) : PlayerEvent, ErrorEvent

Emitted when a player error occurred.

Link copied to clipboard
data class FrameAboutToBeRendered(val presentationTimeUs: Long, val releaseTimeNs: Long) : PlayerEvent

Emitted for every frame that will be rendered onto the video surface. This event needs to be enabled via setting the TweaksConfig.enableFrameAboutToBeRenderedEvent to true. The event will be emitted on the playback thread. It is very important that handling this event must be done very efficient to not block the playback thread.

Link copied to clipboard

Emitted when the fullscreen functionality has been disabled.

Link copied to clipboard

Emitted when the fullscreen functionality has been enabled.

Link copied to clipboard

Emitted when the player enters fullscreen mode.

Link copied to clipboard

Emitted when the player exits fullscreen mode.

Link copied to clipboard
data class Impression(val data: ImpressionData) : PlayerEvent

Emitted when an impression call succeeded.

Link copied to clipboard

Emitted when the active playback session was stopped.

Link copied to clipboard
data class Info(val message: String) : PlayerEvent, InfoEvent

Emitted for neutral information provided by the player. The information provided with this event is only for analytical purposes and are subject to change. Thus, neither the timing nor the content should be used to trigger workflows, but may be used for logging.

Link copied to clipboard
data class LicenseValidated(val data: LicenseData) : PlayerEvent

Emitted when a licensing call succeeded.

Link copied to clipboard
data class Metadata(val metadata: Metadata, val type: String) : PlayerEvent

Emitted when metadata (e.g. Id3Frame in HLS and EventMessage in DASH) is encountered.

Link copied to clipboard

Emitted when the player is muted on either the local device or on a cast-compatible device.

Link copied to clipboard
data class Paused(val time: Double) : PlayerEvent

Emitted when the player is paused.

Link copied to clipboard
data class PictureInPictureAvailabilityChanged(val isPictureInPictureAvailable: Boolean) : PlayerEvent

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
data class Play(val time: Double) : PlayerEvent

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

Link copied to clipboard

Emitted when playback of the Source has finished. If multiple sources are loaded into the player via a PlaylistConfig, the event is emitted when playback of the last Source in the playlist finished.

Link copied to clipboard
data class Playing(val time: Double) : PlayerEvent

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

Link copied to clipboard
data class PlaylistTransition(val from: Source, val to: Source) : PlayerEvent

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
data class ScalingModeChanged(val from: ScalingMode, val to: ScalingMode) : PlayerEvent

Emitted when the PlayerView.getScalingMode is changed.

Link copied to clipboard
data class Seek(val from: SeekPosition, val to: SeekPosition) : PlayerEvent

Emitted when the player starts seeking. Only applies to VoD streams. Refer to TimeShift for live streams.

Link copied to clipboard

Emitted when seeking has finished and data is available to continue playback. Only applies to VoD streams. Refer to TimeShifted for live streams.

Link copied to clipboard
data class SourceAdded(val source: Source, val index: Int) : PlayerEvent

Emitted when a Source was added to an active playback session.

Link copied to clipboard
data class SourceRemoved(val source: Source, val index: Int) : PlayerEvent

Emitted when a Source was removed from an active playback session.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
data class TimeChanged(val time: Double) : PlayerEvent

Emitted when the current playback time has changed.

Link copied to clipboard
data class TimeShift(val position: Double, val target: Double) : PlayerEvent

Emitted when the player starts time shifting. Only applies to live streams. Refer to Seek for VoD streams.

Link copied to clipboard

Emitted when time shifting has finished and data is available to continue playback. Only applies to live streams. Refer to Seeked for VoD streams.

Link copied to clipboard

Emitted when the player is unmuted on either the local device or on a cast-compatible device.

Link copied to clipboard
data class VideoPlaybackQualityChanged(val oldVideoQuality: VideoQuality?, val newVideoQuality: VideoQuality?) : PlayerEvent

Emitted when the current video playback quality has changed.

Link copied to clipboard
data class VideoSizeChanged(val width: Int, val height: Int, val aspectRatio: Float) : PlayerEvent

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

Link copied to clipboard
data class VrStereoChanged(val isStereo: Boolean) : PlayerEvent

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

Link copied to clipboard

Emitted when the VR viewing direction changes. The minimal interval between two consecutive event callbacks is specified through VrConfig.viewingDirectionChangeEventInterval.

Link copied to clipboard

Emitted when the VR viewing direction did not change more than the specified threshold in the last interval, after the VrViewingDirectionChange event was triggered. The threshold can be set through setVRViewingDirectionChangeThreshold.

Link copied to clipboard
data class Warning(val code: PlayerWarningCode, val message: String) : PlayerEvent, WarningEvent

Emitted when a player warning occurred.