IPlaybackEvent
Interface representing a customers playback state at a moment in time. Create using PlaybackEventBuilder.
Accessors
channelDescriptor
Get Signature
get channelDescriptor():
undefined|IChannelDescriptor
Gets the channel descriptor of the linear channel the content is playing on. The channel descriptor uniquely identifies the channel across all channels within the application package and should match the one used for Live TV integration.
Returns
undefined | IChannelDescriptor
The uniquely identifying channelDescriptor of the channel the content is playing on. Undefined if not set.
contentId
Get Signature
get contentId():
IContentId
Gets the Amazon catalog ID of the content being played.
Returns
ID resolvable in the Amazon catalog.
creditsPositionMs
Get Signature
get creditsPositionMs():
undefined|number
Gets the position of the credits in the content, with 0 being the start of content.
Returns
undefined | number
Credits position in milliseconds since the start of content. Undefined if not set.
durationMs
Get Signature
get durationMs():
undefined|number
Gets the duration of the content.
Returns
undefined | number
Duration of the content in milliseconds. Undefined if not set.
eventTimestamp
Get Signature
get eventTimestamp():
undefined|Date
Gets the date of when the playback event occurred.
Returns
undefined | Date
Date of event. Undefined if not set.
playbackPositionMs
Get Signature
get playbackPositionMs():
number
Gets the customer's playback position in the content, with 0 being the start of content.
Returns
number
Current position in milliseconds since the start of content.
playbackState
Get Signature
get playbackState():
PlaybackState
Gets the customer's viewing state of the content.
Returns
The viewing state.
profileId
Get Signature
get profileId():
undefined|IProfileId
Gets the associated profileId of the user who is watching the content.
Returns
undefined | IProfileId
The associated profileId of the user. Undefined if not set.
Last updated: Sep 30, 2025
