## AdaptationEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`VideoAdaptationEvent`](ref:web-sdk-event-types#videoadaptationevent) - [`AudioAdaptationEvent`](ref:web-sdk-event-types#audioadaptationevent) ## Properties ### representationID > **representationID**: `string` The id of the suggested representation --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AdBreakEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`AdManifestLoadedEvent`](ref:web-sdk-event-types#admanifestloadedevent) ## Properties ### adBreak > **adBreak**: [`AdBreak`](ref:web-sdk-advertising#adbreak) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AdClickedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### clickThroughUrl > **clickThroughUrl**: `string` The click through url of the ad --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AdEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`NonLinearAdEvent`](ref:web-sdk-event-types#nonlinearadevent) ## Properties ### ad > **ad**: [`Ad`](ref:web-sdk-advertising#ad) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AdInteractionEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### id? > `optional` **id?**: `string` Interaction id --- ### interactionType > **interactionType**: [`Vpaid`](ref:web-sdk-advertising#vpaid) Interaction type --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AdLinearityChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### isLinear > **isLinear**: `boolean` True if the ad is linear --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AdManifestLoadedEvent > Interface ## Extends - [`AdBreakEvent`](ref:web-sdk-event-types#adbreakevent) ## Properties ### adBreak > **adBreak**: [`AdBreak`](ref:web-sdk-advertising#adbreak) #### Inherited from [`AdBreakEvent`](ref:web-sdk-event-types#adbreakevent).[`adBreak`](ref:web-sdk-event-types#adbreak) --- ### adConfig > **adConfig**: [`AdConfig`](ref:web-sdk-advertising#adconfig) --- ### downloadTiming > **downloadTiming**: [`DownloadTiming`](ref:web-sdk-advertising#downloadtiming) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`AdBreakEvent`](ref:web-sdk-event-types#adbreakevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`AdBreakEvent`](ref:web-sdk-event-types#adbreakevent).[`type`](ref:web-sdk-event-types#type) --- ## AdQuartileEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### quartile > **quartile**: [`AdQuartile`](ref:web-sdk-advertising#adquartile) Quartile that has already been watched by the user. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AirplayChangedEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) ## Properties ### airplayEnabled > **airplayEnabled**: `boolean` Airplay status --- ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### time > **time**: `number` Current playback time (in seconds) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`time`](ref:web-sdk-event-types#time) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`type`](ref:web-sdk-event-types#type) --- ## AspectRatioChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### from > **from**: `number` The previously set aspect ratio of the player. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### to > **to**: `number` The newly set aspect ratio of the player. --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## AudioAdaptationEvent > Interface ## Extends - [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent) ## Properties ### representationID > **representationID**: `string` The id of the suggested representation #### Inherited from [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent).[`representationID`](ref:web-sdk-event-types#representationid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent).[`type`](ref:web-sdk-event-types#type) --- ## AudioChangedEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### sourceAudio > **sourceAudio**: [`AudioTrack`](ref:web-sdk-player-api#audiotrack) Previous audio track or null if no audio track was enabled before --- ### targetAudio > **targetAudio**: [`AudioTrack`](ref:web-sdk-player-api#audiotrack) New audio track --- ### time > **time**: `number` Current playback time (in seconds) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`time`](ref:web-sdk-event-types#time) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`type`](ref:web-sdk-event-types#type) --- ## AudioDownloadQualityChangedEvent > Interface ## Extends - [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent)\<[`AudioQuality`](ref:web-sdk-player-api#audioquality)\> ## Properties ### sourceQuality? > `optional` **sourceQuality?**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) Previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### sourceQualityId > **sourceQualityId**: `string` ID of the previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQualityId`](ref:web-sdk-event-types#sourcequalityid) --- ### targetQuality? > `optional` **targetQuality?**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) New quality #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### targetQualityId > **targetQualityId**: `string` ID of the new quality. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQualityId`](ref:web-sdk-event-types#targetqualityid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## AudioDownloadQualityChangeEvent > Interface ## Extends - [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent)\<[`AudioQuality`](ref:web-sdk-player-api#audioquality)\> ## Properties ### sourceQuality? > `optional` **sourceQuality?**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) Previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### sourceQualityId > **sourceQualityId**: `string` ID of the previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQualityId`](ref:web-sdk-event-types#sourcequalityid) --- ### targetQuality? > `optional` **targetQuality?**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) New quality #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### targetQualityId > **targetQualityId**: `string` ID of the new quality. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQualityId`](ref:web-sdk-event-types#targetqualityid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## AudioPlaybackQualityChangedEvent > Interface ## Extends - [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent)\<[`AudioQuality`](ref:web-sdk-player-api#audioquality)\> ## Properties ### sourceQuality > **sourceQuality**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) Previous quality #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### targetQuality > **targetQuality**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) New quality #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## AudioQualityChangedEvent > Interface ## Extends - [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent)\<[`AudioQuality`](ref:web-sdk-player-api#audioquality)\> ## Properties ### sourceQuality? > `optional` **sourceQuality?**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) Previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### sourceQualityId > **sourceQualityId**: `string` ID of the previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQualityId`](ref:web-sdk-event-types#sourcequalityid) --- ### targetQuality? > `optional` **targetQuality?**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) New quality #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### targetQualityId > **targetQualityId**: `string` ID of the new quality. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQualityId`](ref:web-sdk-event-types#targetqualityid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## AudioQualityEvent > Interface ## Extends - [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent)\<[`AudioQuality`](ref:web-sdk-player-api#audioquality)\> ## Properties ### quality > **quality**: [`AudioQuality`](ref:web-sdk-player-api#audioquality) #### Inherited from [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent).[`quality`](ref:web-sdk-event-types#quality) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent).[`type`](ref:web-sdk-event-types#type) --- ## AudioTrackEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### time > **time**: `number` Current playback time (in seconds) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`time`](ref:web-sdk-event-types#time) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### track > **track**: [`AudioTrack`](ref:web-sdk-player-api#audiotrack) The affected audio track --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`type`](ref:web-sdk-event-types#type) --- ## CastAvailableEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### receiverAvailable > **receiverAvailable**: `boolean` True if receivers have been detected on the network or if the remote implementation cannot detect receivers. False if no receivers have been detected or receivers went offline. **Since:** 7.5.3 --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## CastStartedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### deviceName > **deviceName**: `string` Friendly name of the connected remote Cast device --- ### resuming > **resuming**: `boolean` True if an existing session is resumed, false if a new session has been established --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## CastWaitingForDeviceEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### castPayload > **castPayload**: `object` #### currentTime > **currentTime**: `number` #### deviceName > **deviceName**: `string` #### timestamp > **timestamp**: `number` #### type > **type**: `string` --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## ContentLocationChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### reason > **reason**: [`ContentLocationChangedReason`](ref:web-sdk-player-api#contentlocationchangedreason) The reason for the content location change. --- ### sourceLocationId > **sourceLocationId**: `string` An ID that identifies the previous content location. It can be in the form of: - a Pathway ID or ServiceLocation ID if defined in the manifest - a URL or BaseURL of the previous CDN (in case of DASH streams) - the index of the redundant stream in the manifest that was used prior to the change (in case of HLS streams) --- ### targetLocationId > **targetLocationId**: `string` An ID that identifies the new content location. It can be in the form of: - a Pathway ID or ServiceLocation ID if defined in the manifest - a URL or BaseURL of the new CDN (in case of DASH streams) - the index of the redundant stream in the manifest that was selected as target for the change (in case of HLS streams) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## DownloadFinishedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### attempt > **attempt**: `number` Most requests are re-tried a few times if they fail. This marks how many attempts have been made. Starts at 1. --- ### downloadTime > **downloadTime**: `number` The time needed to finish the request. --- ### downloadType > **downloadType**: [`HttpRequestType`](ref:web-sdk-network#httprequesttype) Specifies which type of request this was. Valid types are currently manifest, media, and license (for DRM license requests). --- ### httpStatus > **httpStatus**: `number` The HTTP status code of the request. Status code 0 means a network or CORS error happened. --- ### maxAttempts > **maxAttempts**: `number` Most requests are re-tried a few times if they fail. This marks the maximum amount of tries to fulfill the request. --- ### mimeType > **mimeType**: `string` The MIME type of the downloaded data. --- ### size > **size**: `number` The size of the downloaded data, in bytes. --- ### success > **success**: `boolean` Indicates whether the request was successful (true) or failed (false). --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### timeToFirstByte > **timeToFirstByte**: `number` The time-to-first-byte for this request in seconds. --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ### url > **url**: `string` The URL of the request. --- ## DrmKidErrorEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### affectedKid > **affectedKid**: `string` --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## DrmLicenseAddedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### license > **license**: [`DrmLicense`](ref:web-sdk-drm#drmlicense) Information about the license which just became active. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## DurationChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### from > **from**: `number` The duration before the change happened. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### to > **to**: `number` The duration after the change happened. --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## ErrorEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### code > **code**: [`ErrorCode`](ref:web-sdk-errors#errorcode) The error code used to identify the occurred error --- ### data? > `optional` **data?**: `object` Additional data #### Index Signature \[`key`: `string`\]: `any` --- ### message? > `optional` **message?**: `string` The message associated with the error --- ### name > **name**: `string` The name of the error --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### troubleShootLink > **troubleShootLink**: `string` A link to a detailed troubleshooting guide for the current error event. --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## LatencyModeChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### from > **from**: [`LatencyMode`](ref:web-sdk-player-config#latencymode) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### to > **to**: [`LatencyMode`](ref:web-sdk-player-config#latencymode) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## LicenseValidatedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### data > **data**: `object` Additional data provided via the licensing backend #### Index Signature \[`key`: `string`\]: `any` --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## MediaPlaybackQualityChangeEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`VideoPlaybackQualityChangedEvent`](ref:web-sdk-event-types#videoplaybackqualitychangedevent) - [`AudioPlaybackQualityChangedEvent`](ref:web-sdk-event-types#audioplaybackqualitychangedevent) ## Type Parameters ### Q `Q` *extends* [`Quality`](ref:web-sdk-player-api#quality) ## Properties ### sourceQuality > **sourceQuality**: `Q` Previous quality --- ### targetQuality > **targetQuality**: `Q` New quality --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## MediaQualityChangeEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`VideoDownloadQualityChangeEvent`](ref:web-sdk-event-types#videodownloadqualitychangeevent) - [`AudioDownloadQualityChangeEvent`](ref:web-sdk-event-types#audiodownloadqualitychangeevent) - [`VideoDownloadQualityChangedEvent`](ref:web-sdk-event-types#videodownloadqualitychangedevent) - [`AudioDownloadQualityChangedEvent`](ref:web-sdk-event-types#audiodownloadqualitychangedevent) - [`VideoQualityChangedEvent`](ref:web-sdk-event-types#videoqualitychangedevent) - [`AudioQualityChangedEvent`](ref:web-sdk-event-types#audioqualitychangedevent) ## Type Parameters ### Q `Q` *extends* [`Quality`](ref:web-sdk-player-api#quality) ## Properties ### sourceQuality? > `optional` **sourceQuality?**: `Q` Previous quality or null if no quality was set before. --- ### sourceQualityId > **sourceQualityId**: `string` ID of the previous quality or null if no quality was set before. --- ### targetQuality? > `optional` **targetQuality?**: `Q` New quality --- ### targetQualityId > **targetQualityId**: `string` ID of the new quality. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## MediaQualityEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`AudioQualityEvent`](ref:web-sdk-event-types#audioqualityevent) - [`VideoQualityEvent`](ref:web-sdk-event-types#videoqualityevent) ## Type Parameters ### Q `Q` *extends* [`Quality`](ref:web-sdk-player-api#quality) ## Properties ### quality > **quality**: `Q` --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## MetadataChangedEvent > Interface ## Extends - [`MetadataEvent`](ref:web-sdk-event-types#metadataevent) ## Properties ### end? > `optional` **end?**: `number` The end time of the event. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`end`](ref:web-sdk-event-types#end) --- ### metadata > **metadata**: `Object` The metadata object as encountered in the stream. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`metadata`](ref:web-sdk-event-types#metadata) --- ### metadataType > **metadataType**: [`MetadataType`](ref:web-sdk-player-api#metadatatype) The type of the published metadata. See [MetadataType](ref:web-sdk-player-api#metadatatype) for details of the different MetadataType values. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`metadataType`](ref:web-sdk-event-types#metadatatype) --- ### start? > `optional` **start?**: `number` The start time of the event. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`start`](ref:web-sdk-event-types#start) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`type`](ref:web-sdk-event-types#type) --- ## MetadataEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`MetadataChangedEvent`](ref:web-sdk-event-types#metadatachangedevent) - [`MetadataParsedEvent`](ref:web-sdk-event-types#metadataparsedevent) ## Properties ### end? > `optional` **end?**: `number` The end time of the event. --- ### metadata > **metadata**: `Object` The metadata object as encountered in the stream. --- ### metadataType > **metadataType**: [`MetadataType`](ref:web-sdk-player-api#metadatatype) The type of the published metadata. See [MetadataType](ref:web-sdk-player-api#metadatatype) for details of the different MetadataType values. --- ### start? > `optional` **start?**: `number` The start time of the event. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## MetadataParsedEvent > Interface ## Extends - [`MetadataEvent`](ref:web-sdk-event-types#metadataevent) ## Properties ### ~~data~~ > **data**: `Object` **Deprecated:** It is recommended to use [metadata](ref:web-sdk-event-types#metadata). --- ### end? > `optional` **end?**: `number` The end time of the event. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`end`](ref:web-sdk-event-types#end) --- ### metadata > **metadata**: `Object` The metadata object as encountered in the stream. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`metadata`](ref:web-sdk-event-types#metadata) --- ### metadataType > **metadataType**: [`MetadataType`](ref:web-sdk-player-api#metadatatype) The type of the published metadata. See [MetadataType](ref:web-sdk-player-api#metadatatype) for details of the different MetadataType values. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`metadataType`](ref:web-sdk-event-types#metadatatype) --- ### start? > `optional` **start?**: `number` The start time of the event. #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`start`](ref:web-sdk-event-types#start) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MetadataEvent`](ref:web-sdk-event-types#metadataevent).[`type`](ref:web-sdk-event-types#type) --- ## ModuleReadyEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### name > **name**: [`ModuleName`](ref:web-sdk-modules#modulename) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## NonLinearAdEvent > Interface Describes a non-linear ad lifecycle event. ## Since v8.278.0 ## Extends - [`AdEvent`](ref:web-sdk-event-types#adevent) ## Properties ### ad > **ad**: [`NonLinearAd`](ref:web-sdk-advertising#nonlinearad) The non-linear ad associated with this event. #### Overrides [`AdEvent`](ref:web-sdk-event-types#adevent).[`ad`](ref:web-sdk-event-types#ad) --- ### position? > `optional` **position?**: `string` The position of the ad break associated with this non-linear ad. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`AdEvent`](ref:web-sdk-event-types#adevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`AdEvent`](ref:web-sdk-event-types#adevent).[`type`](ref:web-sdk-event-types#type) --- ## PeriodSwitchedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### sourcePeriod > **sourcePeriod**: [`PeriodSwitchObject`](ref:web-sdk-player-api#periodswitchobject) --- ### targetPeriod > **targetPeriod**: [`PeriodSwitchObject`](ref:web-sdk-player-api#periodswitchobject) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## PlaybackEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent) ## Extended by - [`AudioChangedEvent`](ref:web-sdk-event-types#audiochangedevent) - [`AirplayChangedEvent`](ref:web-sdk-event-types#airplaychangedevent) - [`AudioTrackEvent`](ref:web-sdk-event-types#audiotrackevent) - [`TimeChangedEvent`](ref:web-sdk-event-types#timechangedevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### time > **time**: `number` Current playback time (in seconds) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## PlaybackSpeedChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### from > **from**: `number` The playback speed before the change happened. --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### to > **to**: `number` The playback speed after the change happened. --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## PlayerEventBase > Interface ## Extended by - [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent) - [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) - [`PlayerResizedEvent`](ref:web-sdk-event-types#playerresizedevent) - [`ErrorEvent`](ref:web-sdk-event-types#errorevent) - [`WarningEvent`](ref:web-sdk-event-types#warningevent) - [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent) - [`DrmKidErrorEvent`](ref:web-sdk-event-types#drmkiderrorevent) - [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent) - [`SegmentPlaybackEvent`](ref:web-sdk-event-types#segmentplaybackevent) - [`DurationChangedEvent`](ref:web-sdk-event-types#durationchangedevent) - [`PlaybackSpeedChangedEvent`](ref:web-sdk-event-types#playbackspeedchangedevent) - [`PeriodSwitchedEvent`](ref:web-sdk-event-types#periodswitchedevent) - [`MetadataEvent`](ref:web-sdk-event-types#metadataevent) - [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent) - [`DownloadFinishedEvent`](ref:web-sdk-event-types#downloadfinishedevent) - [`SegmentRequestFinishedEvent`](ref:web-sdk-event-types#segmentrequestfinishedevent) - [`AdBreakEvent`](ref:web-sdk-event-types#adbreakevent) - [`AdEvent`](ref:web-sdk-event-types#adevent) - [`AdQuartileEvent`](ref:web-sdk-event-types#adquartileevent) - [`AdClickedEvent`](ref:web-sdk-event-types#adclickedevent) - [`AdInteractionEvent`](ref:web-sdk-event-types#adinteractionevent) - [`AdLinearityChangedEvent`](ref:web-sdk-event-types#adlinearitychangedevent) - [`CastAvailableEvent`](ref:web-sdk-event-types#castavailableevent) - [`CastWaitingForDeviceEvent`](ref:web-sdk-event-types#castwaitingfordeviceevent) - [`CastStartedEvent`](ref:web-sdk-event-types#caststartedevent) - [`SubtitleEvent`](ref:web-sdk-event-types#subtitleevent) - [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent) - [`RestoringContentEvent`](ref:web-sdk-event-types#restoringcontentevent) - [`VRStereoChangedEvent`](ref:web-sdk-event-types#vrstereochangedevent) - [`VRViewingDirectionChangeEvent`](ref:web-sdk-event-types#vrviewingdirectionchangeevent) - [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent) - [`ViewModeChangedEvent`](ref:web-sdk-event-types#viewmodechangedevent) - [`ModuleReadyEvent`](ref:web-sdk-event-types#modulereadyevent) - [`TargetLatencyChangedEvent`](ref:web-sdk-event-types#targetlatencychangedevent) - [`LatencyModeChangedEvent`](ref:web-sdk-event-types#latencymodechangedevent) - [`LicenseValidatedEvent`](ref:web-sdk-event-types#licensevalidatedevent) - [`DrmLicenseAddedEvent`](ref:web-sdk-event-types#drmlicenseaddedevent) - [`AspectRatioChangedEvent`](ref:web-sdk-event-types#aspectratiochangedevent) - [`VisibilityChangedEvent`](ref:web-sdk-event-types#visibilitychangedevent) - [`ContentLocationChangedEvent`](ref:web-sdk-event-types#contentlocationchangedevent) ## Properties ### timestamp > **timestamp**: `number` The time at which this event was fired --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' --- ## PlayerEventCallback > Interface ## Type Parameters ### T `T` *extends* [`PlayerEvent`](ref:web-sdk-events#playerevent) > **PlayerEventCallback**(`event`): `void` ## Parameters ### event [`PlayerEventMap`](ref:web-sdk-event-types#playereventmap)\[`T`\] ## Returns `void` --- ## PlayerEventMap > Interface The mapping of all player events to their corresponding event types. ## Properties ### adbreakfinished > **adbreakfinished**: [`AdBreakEvent`](ref:web-sdk-event-types#adbreakevent) --- ### adbreakstarted > **adbreakstarted**: [`AdBreakEvent`](ref:web-sdk-event-types#adbreakevent) --- ### adclicked > **adclicked**: [`AdClickedEvent`](ref:web-sdk-event-types#adclickedevent) --- ### aderror > **aderror**: [`ErrorEvent`](ref:web-sdk-event-types#errorevent) --- ### adfinished > **adfinished**: [`AdEvent`](ref:web-sdk-event-types#adevent) --- ### adinteraction > **adinteraction**: [`AdInteractionEvent`](ref:web-sdk-event-types#adinteractionevent) --- ### adlinearitychanged > **adlinearitychanged**: [`AdLinearityChangedEvent`](ref:web-sdk-event-types#adlinearitychangedevent) --- ### admanifestloaded > **admanifestloaded**: [`AdManifestLoadedEvent`](ref:web-sdk-event-types#admanifestloadedevent) --- ### adquartile > **adquartile**: [`AdQuartileEvent`](ref:web-sdk-event-types#adquartileevent) --- ### adskipped > **adskipped**: [`AdEvent`](ref:web-sdk-event-types#adevent) --- ### adstarted > **adstarted**: [`AdEvent`](ref:web-sdk-event-types#adevent) --- ### airplayavailable > **airplayavailable**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### airplaychanged > **airplaychanged**: [`AirplayChangedEvent`](ref:web-sdk-event-types#airplaychangedevent) --- ### aspectratiochanged > **aspectratiochanged**: [`AspectRatioChangedEvent`](ref:web-sdk-event-types#aspectratiochangedevent) --- ### audioadaptation > **audioadaptation**: [`AudioAdaptationEvent`](ref:web-sdk-event-types#audioadaptationevent) --- ### audioadded > **audioadded**: [`AudioTrackEvent`](ref:web-sdk-event-types#audiotrackevent) --- ### audiochanged > **audiochanged**: [`AudioChangedEvent`](ref:web-sdk-event-types#audiochangedevent) --- ### audiodownloadqualitychange > **audiodownloadqualitychange**: [`AudioDownloadQualityChangeEvent`](ref:web-sdk-event-types#audiodownloadqualitychangeevent) --- ### audiodownloadqualitychanged > **audiodownloadqualitychanged**: [`AudioDownloadQualityChangedEvent`](ref:web-sdk-event-types#audiodownloadqualitychangedevent) --- ### audioplaybackqualitychanged > **audioplaybackqualitychanged**: [`AudioPlaybackQualityChangedEvent`](ref:web-sdk-event-types#audioplaybackqualitychangedevent) --- ### audioqualityadded > **audioqualityadded**: [`AudioQualityEvent`](ref:web-sdk-event-types#audioqualityevent) --- ### audioqualitychanged > **audioqualitychanged**: [`AudioQualityChangedEvent`](ref:web-sdk-event-types#audioqualitychangedevent) --- ### audioqualityremoved > **audioqualityremoved**: [`AudioQualityEvent`](ref:web-sdk-event-types#audioqualityevent) --- ### audioremoved > **audioremoved**: [`AudioTrackEvent`](ref:web-sdk-event-types#audiotrackevent) --- ### castavailable > **castavailable**: [`CastAvailableEvent`](ref:web-sdk-event-types#castavailableevent) --- ### caststart > **caststart**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### caststarted > **caststarted**: [`CastStartedEvent`](ref:web-sdk-event-types#caststartedevent) --- ### caststopped > **caststopped**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### castwaitingfordevice > **castwaitingfordevice**: [`CastWaitingForDeviceEvent`](ref:web-sdk-event-types#castwaitingfordeviceevent) --- ### contentlocationchanged > **contentlocationchanged**: [`ContentLocationChangedEvent`](ref:web-sdk-event-types#contentlocationchangedevent) --- ### cueenter > **cueenter**: [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent) --- ### cueexit > **cueexit**: [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent) --- ### cueparsed > **cueparsed**: [`SubtitleCueParsedEvent`](ref:web-sdk-event-types#subtitlecueparsedevent) --- ### cueupdate > **cueupdate**: [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent) --- ### destroy > **destroy**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### downloadfinished > **downloadfinished**: [`DownloadFinishedEvent`](ref:web-sdk-event-types#downloadfinishedevent) --- ### drmlicenseadded > **drmlicenseadded**: [`DrmLicenseAddedEvent`](ref:web-sdk-event-types#drmlicenseaddedevent) --- ### durationchanged > **durationchanged**: [`DurationChangedEvent`](ref:web-sdk-event-types#durationchangedevent) --- ### dvrwindowexceeded > **dvrwindowexceeded**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### error > **error**: [`ErrorEvent`](ref:web-sdk-event-types#errorevent) --- ### latencymodechanged > **latencymodechanged**: [`LatencyModeChangedEvent`](ref:web-sdk-event-types#latencymodechangedevent) --- ### licensevalidated > **licensevalidated**: [`LicenseValidatedEvent`](ref:web-sdk-event-types#licensevalidatedevent) --- ### metadata > **metadata**: [`MetadataEvent`](ref:web-sdk-event-types#metadataevent) --- ### metadatachanged > **metadatachanged**: [`MetadataChangedEvent`](ref:web-sdk-event-types#metadatachangedevent) --- ### metadataparsed > **metadataparsed**: [`MetadataParsedEvent`](ref:web-sdk-event-types#metadataparsedevent) --- ### moduleready > **moduleready**: [`ModuleReadyEvent`](ref:web-sdk-event-types#modulereadyevent) --- ### muted > **muted**: [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent) --- ### nonlinearadfinished > **nonlinearadfinished**: [`NonLinearAdEvent`](ref:web-sdk-event-types#nonlinearadevent) --- ### nonlinearadskipped > **nonlinearadskipped**: [`NonLinearAdEvent`](ref:web-sdk-event-types#nonlinearadevent) --- ### nonlinearadstarted > **nonlinearadstarted**: [`NonLinearAdEvent`](ref:web-sdk-event-types#nonlinearadevent) --- ### overlayadstarted > **overlayadstarted**: [`AdEvent`](ref:web-sdk-event-types#adevent) --- ### paused > **paused**: [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) --- ### periodswitch > **periodswitch**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### periodswitched > **periodswitched**: [`PeriodSwitchedEvent`](ref:web-sdk-event-types#periodswitchedevent) --- ### play > **play**: [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) --- ### playbackfinished > **playbackfinished**: [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) --- ### playbackspeedchanged > **playbackspeedchanged**: [`PlaybackSpeedChangedEvent`](ref:web-sdk-event-types#playbackspeedchangedevent) --- ### playerresized > **playerresized**: [`PlayerResizedEvent`](ref:web-sdk-event-types#playerresizedevent) --- ### playing > **playing**: [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) --- ### ready > **ready**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### restoringcontent > **restoringcontent**: [`RestoringContentEvent`](ref:web-sdk-event-types#restoringcontentevent) --- ### seek > **seek**: [`SeekEvent`](ref:web-sdk-event-types#seekevent) --- ### seeked > **seeked**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### segmentplayback > **segmentplayback**: [`SegmentPlaybackEvent`](ref:web-sdk-event-types#segmentplaybackevent) --- ### segmentrequestfinished > **segmentrequestfinished**: [`SegmentRequestFinishedEvent`](ref:web-sdk-event-types#segmentrequestfinishedevent) --- ### showairplaytargetpicker > **showairplaytargetpicker**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### sourceloaded > **sourceloaded**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### sourceunloaded > **sourceunloaded**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### stallended > **stallended**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### stallstarted > **stallstarted**: [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) --- ### subtitleadded > **subtitleadded**: [`SubtitleEvent`](ref:web-sdk-event-types#subtitleevent) --- ### subtitledisable > **subtitledisable**: [`SubtitleEvent`](ref:web-sdk-event-types#subtitleevent) --- ### subtitledisabled > **subtitledisabled**: [`SubtitleEvent`](ref:web-sdk-event-types#subtitleevent) --- ### subtitleenable > **subtitleenable**: [`SubtitleEvent`](ref:web-sdk-event-types#subtitleevent) --- ### subtitleenabled > **subtitleenabled**: [`SubtitleEvent`](ref:web-sdk-event-types#subtitleevent) --- ### subtitleremoved > **subtitleremoved**: [`SubtitleEvent`](ref:web-sdk-event-types#subtitleevent) --- ### targetlatencychanged > **targetlatencychanged**: [`TargetLatencyChangedEvent`](ref:web-sdk-event-types#targetlatencychangedevent) --- ### timechanged > **timechanged**: [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) --- ### timeshift > **timeshift**: [`TimeShiftEvent`](ref:web-sdk-event-types#timeshiftevent) --- ### timeshifted > **timeshifted**: [`TimeShiftEvent`](ref:web-sdk-event-types#timeshiftevent) --- ### unmuted > **unmuted**: [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent) --- ### videoadaptation > **videoadaptation**: [`VideoAdaptationEvent`](ref:web-sdk-event-types#videoadaptationevent) --- ### videodownloadqualitychange > **videodownloadqualitychange**: [`VideoDownloadQualityChangeEvent`](ref:web-sdk-event-types#videodownloadqualitychangeevent) --- ### videodownloadqualitychanged > **videodownloadqualitychanged**: [`VideoDownloadQualityChangedEvent`](ref:web-sdk-event-types#videodownloadqualitychangedevent) --- ### videoplaybackqualitychanged > **videoplaybackqualitychanged**: [`VideoPlaybackQualityChangedEvent`](ref:web-sdk-event-types#videoplaybackqualitychangedevent) --- ### videoqualityadded > **videoqualityadded**: [`VideoQualityEvent`](ref:web-sdk-event-types#videoqualityevent) --- ### videoqualitychanged > **videoqualitychanged**: [`VideoQualityChangedEvent`](ref:web-sdk-event-types#videoqualitychangedevent) --- ### videoqualityremoved > **videoqualityremoved**: [`VideoQualityEvent`](ref:web-sdk-event-types#videoqualityevent) --- ### viewmodechanged > **viewmodechanged**: [`ViewModeChangedEvent`](ref:web-sdk-event-types#viewmodechangedevent) --- ### visibilitychanged > **visibilitychanged**: [`VisibilityChangedEvent`](ref:web-sdk-event-types#visibilitychangedevent) --- ### volumechanged > **volumechanged**: [`VolumeChangedEvent`](ref:web-sdk-event-types#volumechangedevent) --- ### vrstereochanged > **vrstereochanged**: [`VRStereoChangedEvent`](ref:web-sdk-event-types#vrstereochangedevent) --- ### vrviewingdirectionchange > **vrviewingdirectionchange**: [`VRViewingDirectionChangeEvent`](ref:web-sdk-event-types#vrviewingdirectionchangeevent) --- ### vrviewingdirectionchanged > **vrviewingdirectionchanged**: [`VRViewingDirectionChangedEvent`](ref:web-sdk-event-types#vrviewingdirectionchangedevent) --- ### warning > **warning**: [`WarningEvent`](ref:web-sdk-event-types#warningevent) --- ## PlayerResizedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### height > **height**: `string` new height (ex : "1080px") --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ### width > **width**: `string` new width (ex : "1920px") --- ## RestoringContentEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## SeekEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### position > **position**: `number` The current position (in seconds) --- ### seekTarget > **seekTarget**: `number` The target position (in seconds) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`type`](ref:web-sdk-event-types#type) --- ## SegmentPlaybackEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### dateTime? > `optional` **dateTime?**: `string` optional time string, based on the `#EXT-X-PROGRAM-DATE-TIME` HLS tag. --- ### discontinuitySequenceNumber? > `optional` **discontinuitySequenceNumber?**: `number` optional number based on `#EXT-X-DISCONTINUITY-SEQUENCE` and `#EXT-X-DISCONTINUITY` HLS tags --- ### duration > **duration**: `number` segment duration --- ### EXPERIMENTAL? > `optional` **EXPERIMENTAL?**: `object` optional experimental data #### hlsAttributes? > `optional` **hlsAttributes?**: `string`[] A list of all custom HLS tags that are associated to this segment. Global custom HLS tags are associated to the first segment. Custom tags in master playlists are not parsed. --- ### mediaInfo > **mediaInfo**: `object` coding parameters #### bitrate? > `optional` **bitrate?**: `number` #### frameRate? > `optional` **frameRate?**: `number` #### height? > `optional` **height?**: `number` #### sampleRate? > `optional` **sampleRate?**: `number` #### width? > `optional` **width?**: `number` --- ### mimeType > **mimeType**: `string` media mime type --- ### periodId? > `optional` **periodId?**: `string` optional period ID, as defined in the DASH manifest --- ### playbackTime > **playbackTime**: `number` Playback time of the segment in seconds --- ### presentationTimestamp > **presentationTimestamp**: `number` Playback time encoded in the segment --- ### representationId > **representationId**: `string` ID of the representation this segment belongs to --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ### uid > **uid**: `string` segment Unique ID --- ### url > **url**: `string` segment URL --- ### wallClockTime > **wallClockTime**: `number` UTC wall-clock time in milliseconds for the segment's presentation in case of a live stream. --- ## SegmentRequestFinishedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### downloadTime > **downloadTime**: `number` The time needed to finish the request. --- ### duration > **duration**: `number` The expected size of the segment in seconds. --- ### httpStatus > **httpStatus**: `number` The HTTP status code of the request. Status code 0 means a network or CORS error happened. --- ### isInit > **isInit**: `boolean` Indicates whether the segment is an init segment (true) or not (false). --- ### mimeType > **mimeType**: `string` The mimeType of the segment --- ### size > **size**: `number` The size of the downloaded data, in bytes. --- ### success > **success**: `boolean` Indicates whether the request was successful (true) or failed (false). --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### timeToFirstByte > **timeToFirstByte**: `number` The time-to-first-byte for this request in seconds. Returns -1 in case no bytes were received, i.e. the request has been cancelled before receiving the headers. --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ### uid > **uid**: `string` The Unique ID of the downloaded segment --- ### url > **url**: `string` The URL of the request. --- ## SubtitleCueEvent > Interface Event which is fired when a subtitle cue - should be shown ([CueEnter](ref:web-sdk-events#cueenter)) - changes ([CueUpdate](ref:web-sdk-events#cueupdate)) - should be hidden ([CueExit](ref:web-sdk-events#cueexit)) ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`SubtitleCueParsedEvent`](ref:web-sdk-event-types#subtitlecueparsedevent) ## Properties ### end > **end**: `number` The playback time when the subtitle should be hidden [getCurrentTime](ref:web-sdk-player-api#getcurrenttime) --- ### html? > `optional` **html?**: `string` The textual content prepared to be put into a html element --- ### image? > `optional` **image?**: `string` Data-URL containing the image data. --- ### position? > `optional` **position?**: [`SubtitleCuePosition`](ref:web-sdk-subtitles#subtitlecueposition) Only relevant for CEA-captions, provides information about where the cue should be positioned on a grid of 15 character rows times 32 columns. See https://dvcs.w3.org/hg/text-tracks/raw-file/default/608toVTT/608toVTT.html#positioning-in-cea-608 for detailed explanation. --- ### region? > `optional` **region?**: `string` The region in which the subtitle should be displayed. Will be filled with information of the region attribute in TTML subtitle cues --- ### regionStyle? > `optional` **regionStyle?**: `string` The style information of the region in which this subtitle should be displayed. Will be filled with the style information provided in the head of the TTML document if it matches the current cue's region attribute. --- ### start > **start**: `number` The playback time when the subtitle should be rendered [getCurrentTime](ref:web-sdk-player-api#getcurrenttime) --- ### subtitleId > **subtitleId**: `string` The id of the associated subtitle track defined in [id](ref:web-sdk-player-api#id) --- ### text > **text**: `string` The textual content of this subtitle --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ### vtt? > `optional` **vtt?**: [`VTTProperties`](ref:web-sdk-subtitles#vttproperties) Options for WebVTT subtitle styling and positioning, including region settings. --- ## SubtitleCueParsedEvent > Interface Event payload for [CueParsed](ref:web-sdk-events#cueparsed) events. ## Extends - [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent) ## Properties ### end > **end**: `number` The playback time when the subtitle should be hidden [getCurrentTime](ref:web-sdk-player-api#getcurrenttime) #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`end`](ref:web-sdk-event-types#end) --- ### html? > `optional` **html?**: `string` The textual content prepared to be put into a html element #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`html`](ref:web-sdk-event-types#html) --- ### image? > `optional` **image?**: `string` Data-URL containing the image data. #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`image`](ref:web-sdk-event-types#image) --- ### position? > `optional` **position?**: [`SubtitleCuePosition`](ref:web-sdk-subtitles#subtitlecueposition) Only relevant for CEA-captions, provides information about where the cue should be positioned on a grid of 15 character rows times 32 columns. See https://dvcs.w3.org/hg/text-tracks/raw-file/default/608toVTT/608toVTT.html#positioning-in-cea-608 for detailed explanation. #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`position`](ref:web-sdk-event-types#position) --- ### region? > `optional` **region?**: `string` The region in which the subtitle should be displayed. Will be filled with information of the region attribute in TTML subtitle cues #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`region`](ref:web-sdk-event-types#region) --- ### regionStyle? > `optional` **regionStyle?**: `string` The style information of the region in which this subtitle should be displayed. Will be filled with the style information provided in the head of the TTML document if it matches the current cue's region attribute. #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`regionStyle`](ref:web-sdk-event-types#regionstyle) --- ### start > **start**: `number` The playback time when the subtitle should be rendered [getCurrentTime](ref:web-sdk-player-api#getcurrenttime) #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`start`](ref:web-sdk-event-types#start) --- ### subtitleId > **subtitleId**: `string` The id of the associated subtitle track defined in [id](ref:web-sdk-player-api#id) #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`subtitleId`](ref:web-sdk-event-types#subtitleid) --- ### text > **text**: `string` The textual content of this subtitle #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`text`](ref:web-sdk-event-types#text) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`type`](ref:web-sdk-event-types#type) --- ### updates? > `optional` **updates?**: `object`[] Changes to the cue, that will result in [CueUpdate](ref:web-sdk-events#cueupdate) events. This will only be populated for WebVTT cues that contain inline timestamp tags. #### html > **html**: `string` The stringified HTML content, prepared to be put into an HTML element. #### updateTime > **updateTime**: `number` The time at which the update occurs, in seconds. --- ### vtt? > `optional` **vtt?**: [`VTTProperties`](ref:web-sdk-subtitles#vttproperties) Options for WebVTT subtitle styling and positioning, including region settings. #### Inherited from [`SubtitleCueEvent`](ref:web-sdk-event-types#subtitlecueevent).[`vtt`](ref:web-sdk-event-types#vtt) --- ## SubtitleEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### subtitle > **subtitle**: [`SubtitleTrack`](ref:web-sdk-subtitles#subtitletrack) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## TargetLatencyChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### from > **from**: `number` --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### to > **to**: `number` --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## TimeChangedEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### time > **time**: `number` Current playback time (in seconds) #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`time`](ref:web-sdk-event-types#time) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent).[`type`](ref:web-sdk-event-types#type) --- ## TimeShiftEvent > Interface Event to signal a timeshift event ## Extends - [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### position > **position**: `number` The position from which we start the timeshift (currentTime before the timeshift) --- ### target > **target**: `number` The position to which we want to jump for the timeshift ( currentTime after timeshift has completed) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`type`](ref:web-sdk-event-types#type) --- ## UserInteractionEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`PlaybackEvent`](ref:web-sdk-event-types#playbackevent) - [`SeekEvent`](ref:web-sdk-event-types#seekevent) - [`TimeShiftEvent`](ref:web-sdk-event-types#timeshiftevent) - [`VolumeChangedEvent`](ref:web-sdk-event-types#volumechangedevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## VideoAdaptationEvent > Interface ## Extends - [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent) ## Properties ### representationID > **representationID**: `string` The id of the suggested representation #### Inherited from [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent).[`representationID`](ref:web-sdk-event-types#representationid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`AdaptationEvent`](ref:web-sdk-event-types#adaptationevent).[`type`](ref:web-sdk-event-types#type) --- ## VideoDownloadQualityChangedEvent > Interface ## Extends - [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent)\<[`VideoQuality`](ref:web-sdk-player-api#videoquality)\> ## Properties ### sourceQuality? > `optional` **sourceQuality?**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) Previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### sourceQualityId > **sourceQualityId**: `string` ID of the previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQualityId`](ref:web-sdk-event-types#sourcequalityid) --- ### targetQuality? > `optional` **targetQuality?**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) New quality #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### targetQualityId > **targetQualityId**: `string` ID of the new quality. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQualityId`](ref:web-sdk-event-types#targetqualityid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## VideoDownloadQualityChangeEvent > Interface ## Extends - [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent)\<[`VideoQuality`](ref:web-sdk-player-api#videoquality)\> ## Properties ### sourceQuality? > `optional` **sourceQuality?**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) Previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### sourceQualityId > **sourceQualityId**: `string` ID of the previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQualityId`](ref:web-sdk-event-types#sourcequalityid) --- ### targetQuality? > `optional` **targetQuality?**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) New quality #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### targetQualityId > **targetQualityId**: `string` ID of the new quality. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQualityId`](ref:web-sdk-event-types#targetqualityid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## VideoPlaybackQualityChangedEvent > Interface ## Extends - [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent)\<[`VideoQuality`](ref:web-sdk-player-api#videoquality)\> ## Properties ### sourceQuality > **sourceQuality**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) Previous quality #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### targetQuality > **targetQuality**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) New quality #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaPlaybackQualityChangeEvent`](ref:web-sdk-event-types#mediaplaybackqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## VideoQualityChangedEvent > Interface ## Extends - [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent)\<[`VideoQuality`](ref:web-sdk-player-api#videoquality)\> ## Properties ### sourceQuality? > `optional` **sourceQuality?**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) Previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQuality`](ref:web-sdk-event-types#sourcequality) --- ### sourceQualityId > **sourceQualityId**: `string` ID of the previous quality or null if no quality was set before. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`sourceQualityId`](ref:web-sdk-event-types#sourcequalityid) --- ### targetQuality? > `optional` **targetQuality?**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) New quality #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQuality`](ref:web-sdk-event-types#targetquality) --- ### targetQualityId > **targetQualityId**: `string` ID of the new quality. #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`targetQualityId`](ref:web-sdk-event-types#targetqualityid) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityChangeEvent`](ref:web-sdk-event-types#mediaqualitychangeevent).[`type`](ref:web-sdk-event-types#type) --- ## VideoQualityEvent > Interface ## Extends - [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent)\<[`VideoQuality`](ref:web-sdk-player-api#videoquality)\> ## Properties ### quality > **quality**: [`VideoQuality`](ref:web-sdk-player-api#videoquality) #### Inherited from [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent).[`quality`](ref:web-sdk-event-types#quality) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`MediaQualityEvent`](ref:web-sdk-event-types#mediaqualityevent).[`type`](ref:web-sdk-event-types#type) --- ## ViewModeChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### from > **from**: [`ViewMode`](ref:web-sdk-vr#viewmode) --- ### legacy > **legacy**: `boolean` --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### to > **to**: [`ViewMode`](ref:web-sdk-vr#viewmode) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## VisibilityChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### isVisible > **isVisible**: `boolean` True if the player has reached the visibility threshold defined in VisibilityConfig, false otherwise. #### Inherited from `VisibilityInfo.isVisible` --- ### percentVisible > **percentVisible**: `number` The percentage of the player that is currently visible in the viewport, between 0 and 100. #### Inherited from `VisibilityInfo.percentVisible` --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## VolumeChangedEvent > Interface Events which can be triggered by API calls, UI interactions, or player internals. The issuer identifies the origin of the action that triggered the event. ## Extends - [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent) ## Properties ### issuer? > `optional` **issuer?**: `string` The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified. - [play](ref:web-sdk-player-api#play) - [pause](ref:web-sdk-player-api#pause) - [seek](ref:web-sdk-player-api#seek) - [timeShift](ref:web-sdk-player-api#timeshift) - [setVolume](ref:web-sdk-player-api#setvolume) - [mute](ref:web-sdk-player-api#mute) - [unmute](ref:web-sdk-player-api#unmute) #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`issuer`](ref:web-sdk-event-types#issuer) --- ### sourceVolume > **sourceVolume**: `number` The volume before the event has been triggered --- ### targetVolume > **targetVolume**: `number` The new selected volume --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`UserInteractionEvent`](ref:web-sdk-event-types#userinteractionevent).[`type`](ref:web-sdk-event-types#type) --- ## VRStereoChangedEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### stereo > **stereo**: `boolean` True if the player is in stereo mode, false otherwise --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## VRViewingDirectionChangedEvent > Interface ## Extends - [`VRViewingDirectionChangeEvent`](ref:web-sdk-event-types#vrviewingdirectionchangeevent) ## Properties ### direction > **direction**: [`ViewingDirection`](ref:web-sdk-vr#viewingdirection) #### Inherited from [`VRViewingDirectionChangeEvent`](ref:web-sdk-event-types#vrviewingdirectionchangeevent).[`direction`](ref:web-sdk-event-types#direction) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`VRViewingDirectionChangeEvent`](ref:web-sdk-event-types#vrviewingdirectionchangeevent).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`VRViewingDirectionChangeEvent`](ref:web-sdk-event-types#vrviewingdirectionchangeevent).[`type`](ref:web-sdk-event-types#type) --- ## VRViewingDirectionChangeEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Extended by - [`VRViewingDirectionChangedEvent`](ref:web-sdk-event-types#vrviewingdirectionchangedevent) ## Properties ### direction > **direction**: [`ViewingDirection`](ref:web-sdk-vr#viewingdirection) --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type) --- ## WarningEvent > Interface ## Extends - [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase) ## Properties ### code > **code**: [`WarningCode`](ref:web-sdk-errors#warningcode) The warning code used to identify the occurred warning --- ### data > **data**: `object` Additional data #### Index Signature \[`key`: `string`\]: `any` --- ### message > **message**: `string` The warning message to explain the reason for the warning --- ### name > **name**: `string` The warning name to explain the reason for the warning --- ### timestamp > **timestamp**: `number` The time at which this event was fired #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`timestamp`](ref:web-sdk-event-types#timestamp) --- ### type > **type**: [`PlayerEvent`](ref:web-sdk-events#playerevent) Event type, e.g. 'play' #### Inherited from [`PlayerEventBase`](ref:web-sdk-event-types#playereventbase).[`type`](ref:web-sdk-event-types#type)