PlaybackSession

Represents AnalyticsSession instance to report video playback session specific events and metadata. Note that ApplicationSession factory method ApplicationSession.createPlaybackSession must be used for session instance creation.

Properties

Link copied to clipboard
Link copied to clipboard

The connectivity status to the analytics system.

Link copied to clipboard
open override var logger: Logger

The Logger for call tracing.

Link copied to clipboard
open override var state: AnalyticsSession.State

The current lifecycle State.

Functions

Link copied to clipboard
open override fun addMetadata(metadata: Map<String, String>)

Adds custom metadata to be published by the analytics reporting system.

Link copied to clipboard
open override fun attachPlayer(player: Player)

Resolves Player instance.

Link copied to clipboard
open override fun interruptEnd(value: CustomEvent)

Must be called to mark the end of the session's lifecycle interruption in order to resume normal session workflow.

Link copied to clipboard
open override fun interruptStart(value: CustomEvent)

Must be called to mark the start of the session's lifecycle interruption in order to pause normal session workflow.

Link copied to clipboard
open override fun start(value: PlaybackRequest)

Must be called to initiate analytics session lifecycle.

Link copied to clipboard
open override fun stop(error: Error?)

Must be called to terminate analytics session lifecycle.

Link copied to clipboard
open override fun updateMetadata(metadata: Map<String, String>)

Updates existing metadata records.