IPlaybackEvent

​

Interface IPlaybackEvent

interface IPlaybackEvent

Extends com.amazon.apmf.IStandard Interface representing a customers playback state at a moment in time. Created using IPlaybackEventBuilder.

​

Methods

​

getContentId()

IContentId* getContentId()

Gets the ID of the content being played.

​

Returns

IContentId* ID resolvable in selected catalog or empty identifier/namespace if not set.

---

​

getCreditsPositionMs()

i64 getCreditsPositionMs()

Gets the position of the credits in the content, with 0 being the start of content.

​

Returns

i64 Credits position in milliseconds since the start of content. -1 if not set.

---

​

getDurationMs()

i64 getDurationMs()

Gets the duration of the content.

​

Returns

i64 Duration of the content in milliseconds. -1 if not set.

---

​

getEventTimestamp()

com.amazon.apmf.RealTimeInstant? getEventTimestamp()

Gets the date of when the playback event occurred.

​

Returns

com.amazon.apmf.RealTimeInstant? The return value is optional and might be absent. Event date in time since epoch. Null if not set.

---

​

getChannelDescriptor()

com.amazon.kepler.tv.epg_provider_models.IChannelDescriptor? getChannelDescriptor()

Gets the channel descriptor of the linear channel the content is playing on. The channel descriptor uniquely identifies the channel that has been integrated using the Kepler EPG Provider API, across all channels within the application package and should match the one used for Live TV integration.

​

Returns

com.amazon.kepler.tv.epg_provider_models.IChannelDescriptor? The return value is optional and might be absent. The uniquely identifying channelDescriptor of the channel the content is playing on. Null if not set

---

​

getPlaybackPositionMs()

i64 getPlaybackPositionMs()

Gets the customer’s playback position in the content, with 0 being the start of content.

​

Returns

i64 Current position in milliseconds since the start of content.

---

​

getProfileId()

IProfileId? getProfileId()

Gets the associated profileId of the user who is watching the content.

​

Returns

IProfileId? The return value is optional and might be absent. The associated profileId of the user. Null if not set.

---

​

getPlaybackState()

PlaybackStateEnum getPlaybackState()

Gets the customer’s viewing state of the content.

​

Returns

PlaybackStateEnum viewing state.

---