SourceEvent

sealed class SourceEvent : Event

Includes all possible events that the Source or Player can emit.

Inheritors


AudioAdded
AudioTrackAdded
AudioTrackChanged
AudioChanged
AudioTracksChanged
AudioDownloadQualityChanged
AudioQualityChanged
AudioQualityAdded
AudioQualityRemoved
AudioQualitiesChanged
AudioRemoved
AudioTrackRemoved
DownloadFinished
DrmDataParsed
DurationChanged
Error
Warning
Info
Load
Loaded
Unloaded
MetadataParsed
PeriodChanged
SubtitleTrackAdded
SubtitleAdded
SubtitleTrackChanged
SubtitleChanged
SubtitleTrackRemoved
SubtitleRemoved
SubtitleTracksChanged
VideoDownloadQualityChanged
VideoQualityChanged
VideoQualityAdded
VideoQualityRemoved
VideoQualitiesChanged
StartPositionCorrection
RetryPlaybackAttempt

Types

Name	Summary
AudioAdded	data class ~~AudioAdded~~(val audioTrack: AudioTrack, val time: Double) : SourceEvent Emitted when an AudioTrack is added.
AudioChanged	data class ~~AudioChanged~~(val oldAudioTrack: AudioTrack?, val newAudioTrack: AudioTrack?) : SourceEvent Emitted when the selected AudioTrack changed.
AudioDownloadQualityChanged	data class AudioDownloadQualityChanged(val oldAudioQuality: AudioQuality?, val newAudioQuality: AudioQuality?) : SourceEvent Emitted when the current audio download quality has changed.
AudioQualitiesChanged	data class AudioQualitiesChanged(val oldAudioQualities: List<AudioQuality>, val newAudioQualities: List<AudioQuality>) : SourceEvent Emitted when the Source.availableAudioQualities changed.
AudioQualityAdded	data class AudioQualityAdded(val audioQuality: AudioQuality) : SourceEvent Emitted when an AudioQuality has been added to the source.
AudioQualityChanged	data class AudioQualityChanged(val oldAudioQuality: AudioQuality?, val newAudioQuality: AudioQuality?) : SourceEvent Emitted when the selected audio quality has changed.
AudioQualityRemoved	data class AudioQualityRemoved(val audioQuality: AudioQuality) : SourceEvent Emitted when an AudioQuality has been removed from the source.
AudioRemoved	data class ~~AudioRemoved~~(val audioTrack: AudioTrack, val time: Double) : SourceEvent Emitted when an audio track is removed.
AudioTrackAdded	data class AudioTrackAdded(val audioTrack: AudioTrack) : SourceEvent Emitted when an AudioTrack is added.
AudioTrackChanged	data class AudioTrackChanged(val oldAudioTrack: AudioTrack?, val newAudioTrack: AudioTrack?) : SourceEvent Emitted when the selected AudioTrack changed.
AudioTrackRemoved	data class AudioTrackRemoved(val audioTrack: AudioTrack) : SourceEvent Emitted when an AudioTrack is removed.
AudioTracksChanged	data class AudioTracksChanged(val oldAudioTracks: List<AudioTrack>, val newAudioTracks: List<AudioTrack>) : SourceEvent Emitted when the Source.availableAudioTracks changed.
DownloadFinished	data class DownloadFinished(val downloadType: HttpRequestType, val url: String, val lastRedirectLocation: String?, val downloadTime: Double, val httpStatus: Int, val size: Long, val isSuccess: Boolean) : SourceEvent Emitted when a download was finished.
DrmDataParsed	data class DrmDataParsed(val data: DrmData) : SourceEvent Emitted when Widevine PSSH boxes are parsed in an HLS manifest
DurationChanged	data class DurationChanged(val from: Double, val to: Double) : SourceEvent Emitted when the source duration has changed. Not emitted for the initial duration.
Error	data class Error(val code: SourceErrorCode, val message: String, val data: Any? = null, val deficiencyData: DeficiencyData? = null) : ErrorEvent, SourceEvent Emitted when a source error occurred.
Info	data class Info(val message: String) : InfoEvent, SourceEvent Emitted for neutral information provided by the source. 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.
Load	data class Load(val source: Source) : SourceEvent Emitted when a Source starts loading.
Loaded	data class Loaded(val source: Source) : SourceEvent Emitted when a Source was loaded. This does not mean that the source is immediately ready for playback.
MetadataParsed	data class MetadataParsed(val metadata: Metadata, val type: String) : SourceEvent Emitted when metadata is first seen and parsed.
PeriodChanged	data class PeriodChanged(val from: PeriodData?, val to: PeriodData) : SourceEvent Emitted when the active period in a DASH stream was changed.
RetryPlaybackAttempt	data class RetryPlaybackAttempt(val errorEvent: ErrorEvent, val retryAction: RetryPlaybackAction) : SourceEvent Emitted when playback is retried after an error due to RetryPlaybackConfig.retryPlaybackCallback.
StartPositionCorrection	data class StartPositionCorrection(val from: Double, val to: Double) : SourceEvent Emitted for live sources when the player preserves the initially selected start position by applying a time shift before playback begins.
SubtitleAdded	data class ~~SubtitleAdded~~(val subtitleTrack: SubtitleTrack) : SourceEvent Emitted when a new SubtitleTrack is added.
SubtitleChanged	data class ~~SubtitleChanged~~(val oldSubtitleTrack: SubtitleTrack?, val newSubtitleTrack: SubtitleTrack?) : SourceEvent Emitted when the selected SubtitleTrack changed.
SubtitleRemoved	data class ~~SubtitleRemoved~~(val subtitleTrack: SubtitleTrack) : SourceEvent Emitted when a SubtitleTrack is removed.
SubtitleTrackAdded	data class SubtitleTrackAdded(val subtitleTrack: SubtitleTrack) : SourceEvent Emitted when a new SubtitleTrack is added.
SubtitleTrackChanged	data class SubtitleTrackChanged(val oldSubtitleTrack: SubtitleTrack?, val newSubtitleTrack: SubtitleTrack?) : SourceEvent Emitted when the selected SubtitleTrack changed.
SubtitleTrackRemoved	data class SubtitleTrackRemoved(val subtitleTrack: SubtitleTrack) : SourceEvent Emitted when a SubtitleTrack is removed.
SubtitleTracksChanged	data class SubtitleTracksChanged(val oldSubtitleTracks: List<SubtitleTrack>, val newSubtitleTracks: List<SubtitleTrack>) : SourceEvent Emitted when the Source.availableSubtitleTracks changed.
Unloaded	class Unloaded : SourceEvent Emitted when a Source was unloaded.
VideoDownloadQualityChanged	data class VideoDownloadQualityChanged(val oldVideoQuality: VideoQuality?, val newVideoQuality: VideoQuality?) : SourceEvent Emitted when current video download quality has changed.
VideoQualitiesChanged	data class VideoQualitiesChanged(val oldVideoQualities: List<VideoQuality>, val newVideoQualities: List<VideoQuality>) : SourceEvent Emitted when the Source.availableVideoQualities changed.
VideoQualityAdded	data class VideoQualityAdded(val videoQuality: VideoQuality) : SourceEvent Emitted when a VideoQuality has been added to the source.
VideoQualityChanged	data class VideoQualityChanged(val oldVideoQuality: VideoQuality, val newVideoQuality: VideoQuality) : SourceEvent Emitted when the selected video quality has changed.
VideoQualityRemoved	data class VideoQualityRemoved(val videoQuality: VideoQuality) : SourceEvent Emitted when a VideoQuality has been removed from the source.
Warning	data class Warning(val code: SourceWarningCode, val message: String, val deficiencyData: DeficiencyData? = null) : WarningEvent, SourceEvent Emitted when a source warning occurred.