SourceListener Protocol Reference


                    
                    
                    onDurationChanged(_:source:)

Called when the source duration has changed. Not emitted for the initial duration.

Declaration

Swift

@objc
optional func onDurationChanged(_ event: DurationChangedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSourceLoad(_:source:)

Called when the Source that started loading.

Declaration

Swift

@objc
optional func onSourceLoad(_ event: SourceLoadEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSourceLoaded(_:source:)

Called when a Source was loaded. This does not mean that the source is immediately ready for playback.

Declaration

Swift

@objc
optional func onSourceLoaded(_ event: SourceLoadedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSourceUnload(_:source:)

Called when the Source started unloading.

Declaration

Swift

@objc
optional func onSourceUnload(_ event: SourceUnloadEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSourceUnloaded(_:source:)

Called when a Source was unloaded.

Declaration

Swift

@objc
optional func onSourceUnloaded(_ event: SourceUnloadedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSourceWarning(_:source:)

Called when a source warning occurred.

Declaration

Swift

@available(*, deprecated, message: "Warnings are now communicated through logs with level `.warning`. These logs are printed to the console by default. You can also access them by providing your own logger to `DebugConfig.logging.logger`\"")
@objc
optional func onSourceWarning(_ event: SourceWarningEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSourceError(_:source:)

Called when a source error occurred.

Faulty Sources in a playlist can be removed from this event listener using Player.playlist.remove(sourceAt:). Limitation: The active Source cannot be removed. Important: The Source has to be removed synchronously.

Declaration

Swift

@objc
optional func onSourceError(_ event: SourceErrorEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onMetadataParsed(_:source:)

Called when metadata is parsed.

Declaration

Swift

@objc
optional func onMetadataParsed(_ event: MetadataParsedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onEvent(_:source:)

Called for each occurring player event.

Declaration

Swift

@objc
optional func onEvent(_ event: SourceEvent, source: Source)

Parameters

`event`	An event object holding specific event data. Use `event.name` or `event is Type` to check the specific event type.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onDrmDataParsed(_:source:)

Called when the drm data was parsed for the specific source.

Declaration

Swift

@objc
optional func onDrmDataParsed(_ event: DrmDataParsedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onAudioAdded(_:source:)

Called when an audio track is added.

Declaration

Swift

@objc
optional func onAudioAdded(_ event: AudioAddedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onAudioRemoved(_:source:)

Called when an audio track is removed.

Declaration

Swift

@objc
optional func onAudioRemoved(_ event: AudioRemovedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onAudioChanged(_:source:)

Called when the audio track is changed.

Declaration

Swift

@objc
optional func onAudioChanged(_ event: AudioChangedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onCueParsed(_:source:)

Called when a sideloaded subtitle cue has been parsed.

Declaration

Swift

@objc
optional func onCueParsed(_ event: CueParsedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSubtitleAdded(_:source:)

Called when a new SubtitleTrack is added, for example using the Player.addSubtitle() call.

Declaration

Swift

@objc
optional func onSubtitleAdded(_ event: SubtitleAddedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSubtitleRemoved(_:source:)

Called when an external SubtitleTrack has been removed so it is possible to update the controls accordingly.

Declaration

Swift

@objc
optional func onSubtitleRemoved(_ event: SubtitleRemovedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onSubtitleChanged(_:source:)

Called when the active SubtitleTrack is changed.

Declaration

Swift

@objc
optional func onSubtitleChanged(_ event: SubtitleChangedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onVideoDownloadQualityChanged(_:source:)

Called when the current video download quality has changed.

Declaration

Swift

@objc
optional func onVideoDownloadQualityChanged(_ event: VideoDownloadQualityChangedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onVideoPlaybackQualityChanged(_:source:)

Called when the current video playback quality has changed.

Declaration

Swift

@objc
optional func onVideoPlaybackQualityChanged(_ event: VideoPlaybackQualityChangedEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.


                    
                    
                    onFairplayLicenseAcquired(_:source:)

Called when FairPlay license was successfully acquired. The object held by property contentKeyRequest on the event can be used for renewing expiring licenses via Source.drm.fairplay.renewExpiringLicense API

Declaration

Swift

@objc
optional func onFairplayLicenseAcquired(_ event: FairplayLicenseAcquiredEvent, source: Source)

Parameters

`event`	An object holding specific event data.
`source`	The source instance which is associated with the emitted event.