Event object interfaces for all player events
AdaptationEvent
Interface
Extends
Extended by
Properties
representationID
representationID:
string
The id of the suggested representation
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AdBreakEvent
Interface
Extends
Extended by
Properties
adBreak
adBreak:
AdBreak
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AdClickedEvent
Interface
Extends
Properties
clickThroughUrl
clickThroughUrl:
string
The click through url of the ad
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AdEvent
Interface
Extends
Properties
ad
ad:
Ad
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AdInteractionEvent
Interface
Extends
Properties
id?
optionalid?:string
Interaction id
interactionType
interactionType:
Vpaid
Interaction type
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AdLinearityChangedEvent
Interface
Extends
Properties
isLinear
isLinear:
boolean
True if the ad is linear
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AdManifestLoadedEvent
Interface
Extends
Properties
adBreak
adBreak:
AdBreak
Inherited from
adConfig
adConfig:
AdConfig
downloadTiming
downloadTiming:
DownloadTiming
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AdQuartileEvent
Interface
Extends
Properties
quartile
quartile:
AdQuartile
Quartile that has already been watched by the user.
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AirplayChangedEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Properties
airplayEnabled
airplayEnabled:
boolean
Airplay status
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
time
time:
number
Current playback time (in seconds)
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AspectRatioChangedEvent
Interface
Extends
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
to
to:
number
The newly set aspect ratio of the player.
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AudioAdaptationEvent
Interface
Extends
Properties
representationID
representationID:
string
The id of the suggested representation
Inherited from
AdaptationEvent.representationID
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AudioChangedEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
sourceAudio
sourceAudio:
AudioTrack
Previous audio track or null if no audio track was enabled before
targetAudio
targetAudio:
AudioTrack
New audio track
time
time:
number
Current playback time (in seconds)
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AudioDownloadQualityChangedEvent
Interface
Extends
Properties
sourceQuality?
optionalsourceQuality?:AudioQuality
Previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQuality
sourceQualityId
sourceQualityId:
string
ID of the previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQualityId
targetQuality?
optionaltargetQuality?:AudioQuality
New quality
Inherited from
MediaQualityChangeEvent.targetQuality
targetQualityId
targetQualityId:
string
ID of the new quality.
Inherited from
MediaQualityChangeEvent.targetQualityId
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AudioDownloadQualityChangeEvent
Interface
Extends
Properties
sourceQuality?
optionalsourceQuality?:AudioQuality
Previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQuality
sourceQualityId
sourceQualityId:
string
ID of the previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQualityId
targetQuality?
optionaltargetQuality?:AudioQuality
New quality
Inherited from
MediaQualityChangeEvent.targetQuality
targetQualityId
targetQualityId:
string
ID of the new quality.
Inherited from
MediaQualityChangeEvent.targetQualityId
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AudioPlaybackQualityChangedEvent
Interface
Extends
Properties
sourceQuality
sourceQuality:
AudioQuality
Previous quality
Inherited from
MediaPlaybackQualityChangeEvent.sourceQuality
targetQuality
targetQuality:
AudioQuality
New quality
Inherited from
MediaPlaybackQualityChangeEvent.targetQuality
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaPlaybackQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MediaPlaybackQualityChangeEvent.type
AudioQualityChangedEvent
Interface
Extends
Properties
sourceQuality?
optionalsourceQuality?:AudioQuality
Previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQuality
sourceQualityId
sourceQualityId:
string
ID of the previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQualityId
targetQuality?
optionaltargetQuality?:AudioQuality
New quality
Inherited from
MediaQualityChangeEvent.targetQuality
targetQualityId
targetQualityId:
string
ID of the new quality.
Inherited from
MediaQualityChangeEvent.targetQualityId
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AudioQualityEvent
Interface
Extends
Properties
quality
quality:
AudioQuality
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
AudioTrackEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
time
time:
number
Current playback time (in seconds)
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
track
track:
AudioTrack
The affected audio track
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
CastAvailableEvent
Interface
Extends
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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
CastStartedEvent
Interface
Extends
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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
CastWaitingForDeviceEvent
Interface
Extends
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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
ContentLocationChangedEvent
Interface
Extends
Properties
reason
reason:
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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
DownloadFinishedEvent
Interface
Extends
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
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
timeToFirstByte
timeToFirstByte:
number
The time-to-first-byte for this request in seconds.
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
url
url:
string
The URL of the request.
DrmKidErrorEvent
Interface
Extends
Properties
affectedKid
affectedKid:
string
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
DrmLicenseAddedEvent
Interface
Extends
Properties
license
license:
DrmLicense
Information about the license which just became active.
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
DurationChangedEvent
Interface
Extends
Properties
from
from:
number
The duration before the change happened.
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
to
to:
number
The duration after the change happened.
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
ErrorEvent
Interface
Extends
Properties
code
code:
ErrorCode
The error code used to identify the occurred error
data?
optionaldata?:object
Additional data
Index Signature
[key: string]: any
message?
optionalmessage?: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
troubleShootLink
troubleShootLink:
string
A link to a detailed troubleshooting guide for the current error event.
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
LatencyModeChangedEvent
Interface
Extends
Properties
from
from:
LatencyMode
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
to
to:
LatencyMode
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
LicenseValidatedEvent
Interface
Extends
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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MediaPlaybackQualityChangeEvent
Interface
Extends
Extended by
Type Parameters
Q
Q extends 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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MediaQualityChangeEvent
Interface
Extends
Extended by
VideoDownloadQualityChangeEventAudioDownloadQualityChangeEventVideoDownloadQualityChangedEventAudioDownloadQualityChangedEventVideoQualityChangedEventAudioQualityChangedEvent
Type Parameters
Q
Q extends Quality
Properties
sourceQuality?
optionalsourceQuality?: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?
optionaltargetQuality?:Q
New quality
targetQualityId
targetQualityId:
string
ID of the new quality.
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MediaQualityEvent
Interface
Extends
Extended by
Type Parameters
Q
Q extends Quality
Properties
quality
quality:
Q
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MetadataChangedEvent
Interface
Extends
Properties
end?
optionalend?:number
The end time of the event.
Inherited from
metadata
metadata:
Object
The metadata object as encountered in the stream.
Inherited from
metadataType
metadataType:
MetadataType
The type of the published metadata. See MetadataType for details of the different MetadataType values.
Inherited from
start?
optionalstart?:number
The start time of the event.
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MetadataEvent
Interface
Extends
Extended by
Properties
end?
optionalend?:number
The end time of the event.
metadata
metadata:
Object
The metadata object as encountered in the stream.
metadataType
metadataType:
MetadataType
The type of the published metadata. See MetadataType for details of the different MetadataType values.
start?
optionalstart?:number
The start time of the event.
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MetadataParsedEvent
Interface
Extends
Properties
data
data:
Object
Deprecated: It is recommended to use metadata.
end?
optionalend?:number
The end time of the event.
Inherited from
metadata
metadata:
Object
The metadata object as encountered in the stream.
Inherited from
metadataType
metadataType:
MetadataType
The type of the published metadata. See MetadataType for details of the different MetadataType values.
Inherited from
start?
optionalstart?:number
The start time of the event.
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
ModuleReadyEvent
Interface
Extends
Properties
name
name:
ModuleName
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
PeriodSwitchedEvent
Interface
Extends
Properties
sourcePeriod
sourcePeriod:
PeriodSwitchObject
targetPeriod
targetPeriod:
PeriodSwitchObject
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
PlaybackEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Extended by
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
time
time:
number
Current playback time (in seconds)
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
PlaybackSpeedChangedEvent
Interface
Extends
Properties
from
from:
number
The playback speed before the change happened.
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
to
to:
number
The playback speed after the change happened.
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
PlayerEventBase
Interface
Extended by
UserInteractionEventPlaybackEventPlayerResizedEventErrorEventWarningEventMediaQualityChangeEventDrmKidErrorEventMediaPlaybackQualityChangeEventSegmentPlaybackEventDurationChangedEventPlaybackSpeedChangedEventPeriodSwitchedEventMetadataEventAdaptationEventDownloadFinishedEventSegmentRequestFinishedEventAdBreakEventAdEventAdQuartileEventAdClickedEventAdInteractionEventAdLinearityChangedEventCastAvailableEventCastWaitingForDeviceEventCastStartedEventSubtitleEventMediaQualityEventRestoringContentEventVRStereoChangedEventVRViewingDirectionChangeEventSubtitleCueEventViewModeChangedEventModuleReadyEventTargetLatencyChangedEventLatencyModeChangedEventLicenseValidatedEventDrmLicenseAddedEventAspectRatioChangedEventVisibilityChangedEventContentLocationChangedEvent
Properties
timestamp
timestamp:
number
The time at which this event was fired
type
type:
PlayerEvent
Event type, e.g. 'play'
PlayerEventCallback
Interface
Type Parameters
T
T extends PlayerEvent
PlayerEventCallback(
event):void
Parameters
event
Returns
void
PlayerEventMap
Interface
The mapping of all player events to their corresponding event types.
Properties
adbreakfinished
adbreakfinished:
AdBreakEvent
adbreakstarted
adbreakstarted:
AdBreakEvent
adclicked
adclicked:
AdClickedEvent
aderror
aderror:
ErrorEvent
adfinished
adfinished:
AdEvent
adinteraction
adinteraction:
AdInteractionEvent
adlinearitychanged
adlinearitychanged:
AdLinearityChangedEvent
admanifestloaded
admanifestloaded:
AdManifestLoadedEvent
adquartile
adquartile:
AdQuartileEvent
adskipped
adskipped:
AdEvent
adstarted
adstarted:
AdEvent
airplayavailable
airplayavailable:
PlayerEventBase
airplaychanged
airplaychanged:
AirplayChangedEvent
aspectratiochanged
aspectratiochanged:
AspectRatioChangedEvent
audioadaptation
audioadaptation:
AudioAdaptationEvent
audioadded
audioadded:
AudioTrackEvent
audiochanged
audiochanged:
AudioChangedEvent
audiodownloadqualitychange
audiodownloadqualitychange:
AudioDownloadQualityChangeEvent
audiodownloadqualitychanged
audiodownloadqualitychanged:
AudioDownloadQualityChangedEvent
audioplaybackqualitychanged
audioplaybackqualitychanged:
AudioPlaybackQualityChangedEvent
audioqualityadded
audioqualityadded:
AudioQualityEvent
audioqualitychanged
audioqualitychanged:
AudioQualityChangedEvent
audioqualityremoved
audioqualityremoved:
AudioQualityEvent
audioremoved
audioremoved:
AudioTrackEvent
castavailable
castavailable:
CastAvailableEvent
caststart
caststart:
PlayerEventBase
caststarted
caststarted:
CastStartedEvent
caststopped
caststopped:
PlayerEventBase
castwaitingfordevice
castwaitingfordevice:
CastWaitingForDeviceEvent
contentlocationchanged
contentlocationchanged:
ContentLocationChangedEvent
cueenter
cueenter:
SubtitleCueEvent
cueexit
cueexit:
SubtitleCueEvent
cueparsed
cueparsed:
SubtitleCueParsedEvent
cueupdate
cueupdate:
SubtitleCueEvent
destroy
destroy:
PlayerEventBase
downloadfinished
downloadfinished:
DownloadFinishedEvent
drmlicenseadded
drmlicenseadded:
DrmLicenseAddedEvent
durationchanged
durationchanged:
DurationChangedEvent
dvrwindowexceeded
dvrwindowexceeded:
PlayerEventBase
error
error:
ErrorEvent
latencymodechanged
latencymodechanged:
LatencyModeChangedEvent
licensevalidated
licensevalidated:
LicenseValidatedEvent
metadata
metadata:
MetadataEvent
metadatachanged
metadatachanged:
MetadataChangedEvent
metadataparsed
metadataparsed:
MetadataParsedEvent
moduleready
moduleready:
ModuleReadyEvent
muted
muted:
UserInteractionEvent
overlayadstarted
overlayadstarted:
AdEvent
paused
paused:
PlaybackEvent
periodswitch
periodswitch:
PlayerEventBase
periodswitched
periodswitched:
PeriodSwitchedEvent
play
play:
PlaybackEvent
playbackfinished
playbackfinished:
PlaybackEvent
playbackspeedchanged
playbackspeedchanged:
PlaybackSpeedChangedEvent
playerresized
playerresized:
PlayerResizedEvent
playing
playing:
PlaybackEvent
ready
ready:
PlayerEventBase
restoringcontent
restoringcontent:
RestoringContentEvent
seek
seek:
SeekEvent
seeked
seeked:
PlayerEventBase
segmentplayback
segmentplayback:
SegmentPlaybackEvent
segmentrequestfinished
segmentrequestfinished:
SegmentRequestFinishedEvent
showairplaytargetpicker
showairplaytargetpicker:
PlayerEventBase
sourceloaded
sourceloaded:
PlayerEventBase
sourceunloaded
sourceunloaded:
PlayerEventBase
stallended
stallended:
PlayerEventBase
stallstarted
stallstarted:
PlayerEventBase
subtitleadded
subtitleadded:
SubtitleEvent
subtitledisable
subtitledisable:
SubtitleEvent
subtitledisabled
subtitledisabled:
SubtitleEvent
subtitleenable
subtitleenable:
SubtitleEvent
subtitleenabled
subtitleenabled:
SubtitleEvent
subtitleremoved
subtitleremoved:
SubtitleEvent
targetlatencychanged
targetlatencychanged:
TargetLatencyChangedEvent
timechanged
timechanged:
PlaybackEvent
timeshift
timeshift:
TimeShiftEvent
timeshifted
timeshifted:
TimeShiftEvent
unmuted
unmuted:
UserInteractionEvent
videoadaptation
videoadaptation:
VideoAdaptationEvent
videodownloadqualitychange
videodownloadqualitychange:
VideoDownloadQualityChangeEvent
videodownloadqualitychanged
videodownloadqualitychanged:
VideoDownloadQualityChangedEvent
videoplaybackqualitychanged
videoplaybackqualitychanged:
VideoPlaybackQualityChangedEvent
videoqualityadded
videoqualityadded:
VideoQualityEvent
videoqualitychanged
videoqualitychanged:
VideoQualityChangedEvent
videoqualityremoved
videoqualityremoved:
VideoQualityEvent
viewmodechanged
viewmodechanged:
ViewModeChangedEvent
visibilitychanged
visibilitychanged:
VisibilityChangedEvent
volumechanged
volumechanged:
VolumeChangedEvent
vrstereochanged
vrstereochanged:
VRStereoChangedEvent
vrviewingdirectionchange
vrviewingdirectionchange:
VRViewingDirectionChangeEvent
vrviewingdirectionchanged
vrviewingdirectionchanged:
VRViewingDirectionChangedEvent
warning
warning:
WarningEvent
PlayerResizedEvent
Interface
Extends
Properties
height
height:
string
new height (ex : "1080px")
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
width
width:
string
new width (ex : "1920px")
RestoringContentEvent
Interface
Extends
Properties
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
SeekEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
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.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
SegmentPlaybackEvent
Interface
Extends
Properties
dateTime?
optionaldateTime?:string
optional time string, based on the #EXT-X-PROGRAM-DATE-TIME HLS tag.
discontinuitySequenceNumber?
optionaldiscontinuitySequenceNumber?:number
optional number based on #EXT-X-DISCONTINUITY-SEQUENCE and #EXT-X-DISCONTINUITY HLS tags
duration
duration:
number
segment duration
EXPERIMENTAL?
optionalEXPERIMENTAL?:object
optional experimental data
hlsAttributes?
optionalhlsAttributes?: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?
optionalbitrate?:number
frameRate?
optionalframeRate?:number
height?
optionalheight?:number
sampleRate?
optionalsampleRate?:number
width?
optionalwidth?:number
mimeType
mimeType:
string
media mime type
periodId?
optionalperiodId?: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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
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
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
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
Event type, e.g. 'play'
Inherited from
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
Extends
Extended by
Properties
end
end:
number
The playback time when the subtitle should be hidden getCurrentTime
html?
optionalhtml?:string
The textual content prepared to be put into a html element
image?
optionalimage?:string
Data-URL containing the image data.
position?
optionalposition?: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?
optionalregion?:string
The region in which the subtitle should be displayed.
Will be filled with information of the region attribute in TTML subtitle cues
regionStyle?
optionalregionStyle?: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
subtitleId
subtitleId:
string
The id of the associated subtitle track defined in id
text
text:
string
The textual content of this subtitle
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
vtt?
optionalvtt?:VTTProperties
Options for WebVTT subtitle styling and positioning, including region settings.
SubtitleCueParsedEvent
Interface
Event payload for CueParsed events.
Extends
Properties
end
end:
number
The playback time when the subtitle should be hidden getCurrentTime
Inherited from
html?
optionalhtml?:string
The textual content prepared to be put into a html element
Inherited from
image?
optionalimage?:string
Data-URL containing the image data.
Inherited from
position?
optionalposition?: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
region?
optionalregion?: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
regionStyle?
optionalregionStyle?: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
start
start:
number
The playback time when the subtitle should be rendered getCurrentTime
Inherited from
subtitleId
subtitleId:
string
The id of the associated subtitle track defined in id
Inherited from
text
text:
string
The textual content of this subtitle
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
updates?
optionalupdates?:object[]
Changes to the cue, that will result in 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?
optionalvtt?:VTTProperties
Options for WebVTT subtitle styling and positioning, including region settings.
Inherited from
SubtitleEvent
Interface
Extends
Properties
subtitle
subtitle:
SubtitleTrack
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
TargetLatencyChangedEvent
Interface
Extends
Properties
from
from:
number
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
to
to:
number
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
TimeChangedEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
time
time:
number
Current playback time (in seconds)
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
TimeShiftEvent
Interface
Event to signal a timeshift event
Extends
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
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.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
UserInteractionEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Extended by
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VideoAdaptationEvent
Interface
Extends
Properties
representationID
representationID:
string
The id of the suggested representation
Inherited from
AdaptationEvent.representationID
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VideoDownloadQualityChangedEvent
Interface
Extends
Properties
sourceQuality?
optionalsourceQuality?:VideoQuality
Previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQuality
sourceQualityId
sourceQualityId:
string
ID of the previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQualityId
targetQuality?
optionaltargetQuality?:VideoQuality
New quality
Inherited from
MediaQualityChangeEvent.targetQuality
targetQualityId
targetQualityId:
string
ID of the new quality.
Inherited from
MediaQualityChangeEvent.targetQualityId
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VideoDownloadQualityChangeEvent
Interface
Extends
Properties
sourceQuality?
optionalsourceQuality?:VideoQuality
Previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQuality
sourceQualityId
sourceQualityId:
string
ID of the previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQualityId
targetQuality?
optionaltargetQuality?:VideoQuality
New quality
Inherited from
MediaQualityChangeEvent.targetQuality
targetQualityId
targetQualityId:
string
ID of the new quality.
Inherited from
MediaQualityChangeEvent.targetQualityId
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VideoPlaybackQualityChangedEvent
Interface
Extends
Properties
sourceQuality
sourceQuality:
VideoQuality
Previous quality
Inherited from
MediaPlaybackQualityChangeEvent.sourceQuality
targetQuality
targetQuality:
VideoQuality
New quality
Inherited from
MediaPlaybackQualityChangeEvent.targetQuality
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaPlaybackQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
MediaPlaybackQualityChangeEvent.type
VideoQualityChangedEvent
Interface
Extends
Properties
sourceQuality?
optionalsourceQuality?:VideoQuality
Previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQuality
sourceQualityId
sourceQualityId:
string
ID of the previous quality or null if no quality was set before.
Inherited from
MediaQualityChangeEvent.sourceQualityId
targetQuality?
optionaltargetQuality?:VideoQuality
New quality
Inherited from
MediaQualityChangeEvent.targetQuality
targetQualityId
targetQualityId:
string
ID of the new quality.
Inherited from
MediaQualityChangeEvent.targetQualityId
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
MediaQualityChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VideoQualityEvent
Interface
Extends
Properties
quality
quality:
VideoQuality
Inherited from
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
ViewModeChangedEvent
Interface
Extends
Properties
from
from:
ViewMode
legacy
legacy:
boolean
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
to
to:
ViewMode
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VisibilityChangedEvent
Interface
Extends
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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VolumeChangedEvent
Interface
Events which can be triggered by user interaction as well as internally.
The issuer is to determine whether this was triggered internally ('api') or by the UI ('ui')
Extends
Properties
issuer?
optionalissuer?:string
The issuer of this event, as passed into the according API method. 'api' by default if no issuer was specified.
Inherited from
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.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VRStereoChangedEvent
Interface
Extends
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
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VRViewingDirectionChangedEvent
Interface
Extends
Properties
direction
direction:
ViewingDirection
Inherited from
VRViewingDirectionChangeEvent.direction
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
VRViewingDirectionChangeEvent.timestamp
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
VRViewingDirectionChangeEvent.type
VRViewingDirectionChangeEvent
Interface
Extends
Extended by
Properties
direction
direction:
ViewingDirection
timestamp
timestamp:
number
The time at which this event was fired
Inherited from
type
type:
PlayerEvent
Event type, e.g. 'play'
Inherited from
WarningEvent
Interface
Extends
Properties
code
code:
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
type
type:
PlayerEvent
Event type, e.g. 'play'