PlaybackSessionManager.Listener


interface PlaybackSessionManager.Listener


A listener for session updates.

Summary

Public functions

Unit
onAdPlaybackStarted(
    eventTime: AnalyticsListener.EventTime!,
    contentSessionId: String!,
    adSessionId: String!
)

Called when a session is interrupted by ad playback.

Unit
onSessionActive(
    eventTime: AnalyticsListener.EventTime!,
    sessionId: String!
)

Called when a session becomes active, i.e. playing in the foreground.

Unit
onSessionCreated(
    eventTime: AnalyticsListener.EventTime!,
    sessionId: String!
)

Called when a new session is created as a result of updateSessions.

Unit
onSessionFinished(
    eventTime: AnalyticsListener.EventTime!,
    sessionId: String!,
    automaticTransitionToNextPlayback: Boolean
)

Called when a session is permanently finished.

Public functions

onAdPlaybackStarted

fun onAdPlaybackStarted(
    eventTime: AnalyticsListener.EventTime!,
    contentSessionId: String!,
    adSessionId: String!
): Unit

Called when a session is interrupted by ad playback.

Parameters
eventTime: AnalyticsListener.EventTime!

The EventTime at which the ad playback starts.

contentSessionId: String!

The session identifier of the content session.

adSessionId: String!

The identifier of the ad session.

onSessionActive

fun onSessionActive(
    eventTime: AnalyticsListener.EventTime!,
    sessionId: String!
): Unit

Called when a session becomes active, i.e. playing in the foreground.

Parameters
eventTime: AnalyticsListener.EventTime!

The EventTime at which the session becomes active.

sessionId: String!

The identifier of the session.

onSessionCreated

fun onSessionCreated(
    eventTime: AnalyticsListener.EventTime!,
    sessionId: String!
): Unit

Called when a new session is created as a result of updateSessions.

Parameters
eventTime: AnalyticsListener.EventTime!

The EventTime at which the session is created.

sessionId: String!

The identifier of the new session.

onSessionFinished

fun onSessionFinished(
    eventTime: AnalyticsListener.EventTime!,
    sessionId: String!,
    automaticTransitionToNextPlayback: Boolean
): Unit

Called when a session is permanently finished.

Parameters
eventTime: AnalyticsListener.EventTime!

The EventTime at which the session finished.

sessionId: String!

The identifier of the finished session.

automaticTransitionToNextPlayback: Boolean

Whether the session finished because of an automatic transition to the next playback item.