# class PlayerApiEvents

#### package com.turner.top.sdk.core.api.events

#### extends EventCollection<PlayerEventType, Dynamic>

Collection of all events dispatched by the player.

See:

Integration - Events

### Constructor

###

`new (?ctx:Dynamic)`

### Variables

###

`read onlyadBlocked:AdBlockedEvent`

When ad playback is blocked due to invalid autoplay configuration

###

`read onlyadCreativeEnded:AdCreativeEndedEvent`

When an ad creative is complete

###

`read onlyadCreativeStarted:AdCreativeStartedEvent`

When an ad creative has begun

###

`read onlyadError:AdErrorEvent`

When an error occurs with ads

###

`read onlyadFinished:AdFinishedEvent`

When ads are complete

###

`read onlyadLoaded:AdLoadedEvent`

When ads have loaded

###

`read onlyadMuteChanged:AdMuteChangedEvent`

When the ad player muted value has changed

###

`read onlyadPaused:AdPausedEvent`

When ads have been paused

###

`read onlyadRequestCanceled:AdRequestCanceledEvent`

When an ad request has been canceled

###

`read onlyadRequestCompleted:AdRequestCompletedEvent`

When an ad request has been received successfully

###

`read onlyadRequestError:AdRequestErrorEvent`

When an error occurs with an ad request

###

`read onlyadRequestStateChanged:AdRequestStateChangedEvent`

When the state of an ad request changes

###

`read onlyadRequesting:AdRequestingEvent`

When an ad request is being sent out and a response has not been received yet

###

`read onlyadResumed:AdResumedEvent`

When ads have begun playing again from a paused state

###

`read onlyadSlotEnded:AdSlotEndedEvent`

When an ad slot is complete

###

`read onlyadSlotStarted:AdSlotStartedEvent`

When an ad slot has begun

###

`read onlyadStarted:AdStartedEvent`

When ads have begun

###

`read onlyadStarting:AdStartingEvent`

When ads get going

###

`read onlyadStateChanged:AdStateChangedEvent`

When the state of ads has changed

###

`read onlyadStopped:AdStoppedEvent`

When ads have been manually stopped

###

`read onlyadTimeChanged:AdTimeChangedEvent`

When the playhead for ads has updated

###

`read onlyadVolumeChanged:AdVolumeChangedEvent`

When the ad player volume level has changed

###

`read onlycaptionSettingsUpdated:CCSettingsUpdatedEvent`

When the closed captions settings have been updated

###

`read onlycaptionsError:CCErrorEvent`

When there is a closed captions issue

###

`read onlycaptionsStateChanged:CCStateChangedEvent`

When the state of closed captions changes

###

`read onlycaptionsTrackAvailabilityChanged:CCTrackAvailabilityChangedEvent`

When closed captions track becomes available to the player

###

`read onlycaptionsTrackSelected:CCTrackSelectedEvent`

When a closed captions track has been selected

###

`read onlycontentBeginning:ContentBeginningEvent`

When content is being set up

###

`read onlycontentCompleted:ContentCompletedEvent`

When the content is complete

###

`read onlycontentEnded:ContentEndedEvent`

When either content errors, completes, or is interrupted

###

`read onlycontentError:ContentErrorEvent`

When there is an issue with content playback

###

`read onlycontentInterrupted:ContentInterruptedEvent`

When the content is interrupted

###

`read onlycontentSetup:ContentSetupEvent`

When content is ready to be played

###

`read onlycontentStateChanged:ContentStateChangedEvent`

When the state of content changes

###

`read onlycontentWaiting:ContentWaitingEvent`

If content is set to not auto play, the player wait for user intervention to move forward

See:

IPlayerApi.proceed
PlayerConfigPlayerData.autoPlay

###

`read onlycueActivated:CueActivatedEvent`

When a cue has been triggered

###

`read onlycueMessageDispatched:CueMessageDispatchedEvent`

When a cue message has been dispatched

###

`read onlycueProcessed:CueProcessedEvent`

When a cue has been parsed and is ready to be triggered

###

`read onlycueStateChanged:CueStateChangedEvent`

When a cue state change occurs

###

`read onlymediaBlocked:MediaBlockedEvent`

When media playback is blocked due to an error returned from the play promise

###

`read onlymediaBufferingFinished:MediaBufferingFinishedEvent`

When the media player has finished buffering content

###

`read onlymediaBufferingStarted:MediaBufferingStartedEvent`

When the media player has started buffering content

###

`read onlymediaCommandReceived:MediaCommandReceivedEvent`

When the media player has triggered a command

###

`read onlymediaError:MediaErrorEvent`

When the media player has an issue with content playback

###

`read onlymediaFinished:MediaFinishedEvent`

When the media player content playback is complete

###

`read onlymediaLoaded:MediaLoadedEvent`

When the media player has loaded content manifest

###

`read onlymediaMuteChanged:MediaMuteChangedEvent`

When the media player muted value has changed

###

`read onlymediaPaused:MediaPausedEvent`

When the media player has paused content playback

###

`read onlymediaProfileChanged:MediaProfileChangedEvent`

When the media player has successfully switched bitrates

###

`read onlymediaProfileChanging:MediaProfileChangingEvent`

When the media player is about to switch bitrates

###

`read onlymediaRecoveryFinished:MediaRecoveryFinishedEvent`

When the media player has finished recovering from errored playback

###

`read onlymediaRecoveryStarted:MediaRecoveryStartedEvent`

When the media player has started recovering from errored playback

###

`read onlymediaRequestProfileChanged:MediaRequestProfileChangedEvent`

When the media player has updated with the recently loaded stream level manifest

###

`read onlymediaResized:MediaResizedEvent`

When the media player view port dimensions have been changed

###

`read onlymediaResumed:MediaResumedEvent`

When the media player has resumed content playback

###

`read onlymediaSeekingFinished:MediaSeekingFinishedEvent`

When the media player has finished a seek command

###

`read onlymediaSeekingStarted:MediaSeekingStartedEvent`

When the media player has started a seek command

###

`read onlymediaStarted:MediaStartedEvent`

When the media player is has started to play content

###

`read onlymediaStarting:MediaStartingEvent`

When the media player is starting to play media

###

`read onlymediaStateChanged:MediaStateChangedEvent`

When the state of the media player has changed

###

`read onlymediaStopped:MediaStoppedEvent`

When the media player content playback has been manually stopped

###

`read onlymediaTimeChanged:MediaTimeChangedEvent`

When the playhead for the media player has updated

###

`read onlymediaTimedMetadataReceived:MediaTimedMetadataRecievedEvent`

When metadata about a loaded fragment has been received

###

`read onlymediaVolumeChanged:MediaVolumeChangedEvent`

When the media player volume level has changed

###

`read onlyplayerInitialized:PlayerInitializedEvent`

When the player is initialized and ready to be attached to the DOM

###

`read onlyplayerListening:PlayerListeningEvent`

When the player has been attached to the DOM and is listening to player events

###

`read onlyplayerReady:PlayerReadyEvent`

When the player api's can be used and start to play content

###

`read onlyplayerStateChanged:PlayerStateChangedEvent`

When the state of the player changes

###

`read onlytimelineMarkerActivated:TimelineMarkerActivatedEvent`

When the current time is within the range of a content marker

###

`read onlytimelineMarkerAdded:TimelineMarkerAddedEvent`

When a content marker has been added to the timeline

###

`read onlytimelineMarkerApproaching:TimelineMarkerApproachingEvent`

When the current time gets close to the beginning of a content marker's range

###

`read onlytimelineMarkerDeactivated:TimelineMarkerDeactivatedEvent`

When the current time has passed the end of a content marker's range

###

`read onlytimelineMarkerFinishing:TimelineMarkerFinishingEvent`

When the current time gets close to the end of a content marker's range

###

`read onlytimelineMarkerRemoved:TimelineMarkerRemovedEvent`

When a content marker has been removed from the timeline

###

`read onlyvalidationError:ValidationErrorEvent`

When at least one configured validator has failed, pre-play or in-play

See:

Integration - Validation

###

`read onlyvalidationSuccess:ValidationSuccessEvent`

When all configured validators are successful, pre-play or in-play

See:

Integration - Validation

###

`read onlyviewFullscreenEntered:ViewFullscreenEnteredEvent`

When the view enters fullscreen

###

`read onlyviewFullscreenExited:ViewFullscreenExitedEvent`

When the view exits fullscreen

###

`read onlyviewStateChanged:ViewStateChangedEvent`

When the view state changes

### Inherited Variables

### Inherited Methods

#### Defined by EventCollection

###

`after ():ISimpleEventCollection<T, R>`

###

`around ():ISimpleEventCollection<T, R>`

###

`before ():ISimpleEventCollection<T, R>`

###

`each (f:EventSignal1<T, R> ‑> Void):ISimpleEventCollection<T, R>`

Public API

###

`length ():UInt`

###

`listen (handler:ListenableHandler):ISimpleEventCollection<T, R>`

###

`listenFor (f:ListenForMap):ISimpleEventCollection<T, R>`

###

`once (handler:ListenableHandler):ISimpleEventCollection<T, R>`

###

`unlisten (handler:ListenableHandler):ISimpleEventCollection<T, R>`

###

`unlistenFor (f:ListenForMap):ISimpleEventCollection<T, R>`