Player Events Reference


                    
                    
                    PlayerEventTypes

The types of Player events.

Declaration

Swift

public struct PlayerEventTypes


                    
                    
                    SourceChangeEvent

Fired when PlayerEventTypes.SOURCE_CHANGE occurs for the THEOplayer.

Declaration

Swift

@objc(THEOplayerSourceChangeEvent)
public class SourceChangeEvent : PlayerEvent


                    
                    
                    ReadyStateEvent

The base event for all events that change the ReadyState of the player.

Declaration

Swift

@objc(THEOplayerReadyStateEvent)
public class ReadyStateEvent : CurrentTimeEvent


                    
                    
                    PlayEvent

Fired when PlayerEventTypes.PLAY occurs for the THEOplayer.

Remark

The player is no longer paused.
Triggered when play() has returned or when autoplay has caused playback to begin.

Declaration

Swift

@objc(THEOplayerPlayEvent)
public class PlayEvent : CurrentTimeEvent


                    
                    
                    PlayingEvent

Fired when PlayerEventTypes.PLAYING occurs for the THEOplayer.

Remark

Playback is ready to start after having been paused or delayed due to lack of media data.
Even if this event fires, the player might still not be potentially playing, e.g. if the player is paused for user interaction or paused for in-band content.

Declaration

Swift

@objc(THEOplayerPlayingEvent)
public class PlayingEvent : CurrentTimeEvent


                    
                    
                    PauseEvent

Fired when PlayerEventTypes.PAUSE occurs for the THEOplayer.

Declaration

Swift

@objc(THEOplayerPauseEvent)
public class PauseEvent : CurrentTimeEvent


                    
                    
                    ProgressEvent

Fired when PlayerEventTypes.PROGRESS occurs for the THEOplayer.

Remark

Triggered when the player is fetching media data.
For progress in time, please see TimeUpdateEvent.

Declaration

Swift

@objc(THEOplayerProgressEvent)
public class ProgressEvent : CurrentTimeEvent


                    
                    
                    DurationChangeEvent

Fired when PlayerEventTypes.DURATION_CHANGE occurs for the THEOplayer.

Remark

One of the cases where the duration is updated, is when you set a new source.

Declaration

Swift

@objc(THEOplayerDurationChangeEvent)
public class DurationChangeEvent : PlayerEvent


                    
                    
                    SeekingEvent

Fired when PlayerEventTypes.SEEKING occurs for the THEOplayer.

Remark

This event means that the player is currently seeking, thus THEOplayer.seeking will return true.

Declaration

Swift

@objc(THEOplayerSeekingEvent)
public class SeekingEvent : CurrentTimeEvent


                    
                    
                    SeekedEvent

Fired when PlayerEventTypes.SEEKED occurs for the THEOplayer.

Remark

This event means that the player has completed seeking, thus THEOplayer.seeking will return false.

Declaration

Swift

@objc(THEOplayerSeekedEvent)
public class SeekedEvent : CurrentTimeEvent


                    
                    
                    WaitingEvent

Fired when PlayerEventTypes.WAITING occurs for the THEOplayer.

Remark

Playback has stopped because the next frame is not available, but the user agent expects that frame to become available in due course.
ReadyState is equal to or less than HAVE_CURRENT_DATA, and THEOplayer.paused is false.

Declaration

Swift

@objc(THEOplayerWaitingEvent)
public class WaitingEvent : CurrentTimeEvent


                    
                    
                    TimeUpdateEvent

Fired when PlayerEventTypes.TIME_UPDATE occurs for the THEOplayer.

Remark

Periodically thrown during playback to indicate that the currentTime property is changing to indicate the new playback position.
Will be kept up-to-date in case of discontinuous playback, e.g. because of a seek.

Declaration

Swift

@objc(THEOplayerTimeUpdateEvent)
public class TimeUpdateEvent : CurrentTimeEvent


                    
                    
                    EndedEvent

Fired when PlayerEventTypes.ENDED occurs for the THEOplayer.

Remark

currentTime has reached the end of the current source.

Declaration

Swift

@objc(THEOplayerEndedEvent)
public class EndedEvent : CurrentTimeEvent


                    
                    
                    RateChangeEvent

Fired when PlayerEventTypes.RATE_CHANGE occurs for the THEOplayer.

Remark

The effective playback rate changes, which is the speed at which the media resource plays, as a multiple of its intrinsic speed.

Declaration

Swift

@objc(THEOplayerRateChangeEvent)
public class RateChangeEvent : CurrentTimeEvent


                    
                    
                    ReadyStateChangeEvent

Fired when PlayerEventTypes.READY_STATE_CHANGE occurs for the THEOplayer.

Remark

For all possible values, see ReadyState.

Declaration

Swift

@objc(THEOplayerReadyStateChangeEvent)
public class ReadyStateChangeEvent : ReadyStateEvent


                    
                    
                    LoadedMetaDataEvent

Fired when PlayerEventTypes.LOADED_META_DATA occurs for the THEOplayer.

Remark

The player has just determined the duration and dimensions of the media resource.
Thrown the first time the readyState property goes from 0: HAVE_NOTHING to 1: HAVE_METADATA.
Additionally, the text tracks are ready.

Declaration

Swift

@objc(THEOplayerLoadedMetaDataEvent)
public class LoadedMetaDataEvent : ReadyStateEvent


                    
                    
                    LoadedDataEvent

Fired when PlayerEventTypes.LOADED_DATA occurs for the THEOplayer.

Remark

The player is able to render the content for the first time, from the current position.
Thrown the first time the readyState property goes from 1: HAVE_METADATA to 2: HAVE_CURRENT_DATA.

Declaration

Swift

@objc(THEOplayerLoadedDataEvent)
public class LoadedDataEvent : ReadyStateEvent


                    
                    
                    CanPlayEvent

Fired when PlayerEventTypes.CAN_PLAY occurs for the THEOplayer.

Remark

The player already has some data and can play, with a readyState property value of 3: HAVE_FUTURE_DATA.
The player does not have sufficient future data to guarantee a smooth playthrough.
With the current playback rate, until the end of the stream, the player might have to stop for further buffering of the media data.
Fired to indicate that the player can now continue playback, usually after a ‘waiting’ event.

Declaration

Swift

@objc(THEOplayerCanPlayEvent)
public class CanPlayEvent : ReadyStateEvent


                    
                    
                    CanPlayThroughEvent

Fired when PlayerEventTypes.CAN_PLAY_THROUGH occurs for the THEOplayer.

Remark

The player has sufficient data to offer a smooth playthrough.
With the current playback rate, until the end of the stream, the player won’t have to stop for further buffering of the media data.
Fired to indicate that the player can now continue playback uninterrupted with a readyState property value of 4: HAVE_ENOUGH_DATA.

Declaration

Swift

@objc(THEOplayerCanPlayThroughEvent)
public class CanPlayThroughEvent : ReadyStateEvent


                    
                    
                    ErrorEvent

Fired when PlayerEventTypes.ERROR occurs for the THEOplayer.

Declaration

Swift

@objc(THEOplayerErrorEvent)
public class ErrorEvent : PlayerEvent


                    
                    
                    PresentationModeChangeEvent

Fired when PlayerEventTypes.PRESENTATION_MODE_CHANGE occurs for the THEOplayer.

Remark

Can be triggered when switching from inline to fullscreen, or the other way around.

Declaration

Swift

@objc(THEOplayerPresentationModeChangeEvent)
public class PresentationModeChangeEvent : PlayerEvent


                    
                    
                    VolumeChangeEvent

Fired when PlayerEventTypes.VOLUME_CHANGE occurs for the THEOplayer.

Remark

The device’s volume percentage as a rational number between 0 and 1.
Changes the value of THEOplayer.volume.
This is not triggered by muting the player.

Declaration

Swift

@objc(THEOplayerVolumeChangeEvent)
public class VolumeChangeEvent : CurrentTimeEvent


                    
                    
                    ResizeEvent

Fired when PlayerEventTypes.RESIZE occurs for the THEOplayer.

Remark

The playing video has been resized.

Declaration

Swift

@objc(THEOplayerResizeEvent)
public class ResizeEvent : PlayerEvent


                    
                    
                    LoadStartEvent

Fired when PlayerEventTypes.LOAD_START occurs for the THEOplayer.

Remark

The player begins looking for media data, as part of the resource selection algorithm.

Declaration

Swift

@objc(THEOplayerLoadStartEvent)
public class LoadStartEvent : CurrentTimeEvent


                    
                    
                    DestroyEvent

Fired when PlayerEventTypes.DESTROY occurs for the THEOplayer.

Remark

After receiving this event, the player should not be used anymore.

Declaration

Swift

@objc(THEOplayerDestroyEvent)
public class DestroyEvent : PlayerEvent