player-analytics/com.bitmovin.player.api.analytics/AnalyticsApi

AnalyticsApi

interface AnalyticsApi

Provides the means to control the analytics collected by a Player.

Use the Player.analytics extension to access a Player's AnalyticsApi.

Types

object Companion

Use the Player.analytics extension to access a Player's AnalyticsApi.

Properties

abstract val impressionId: String?

The impression id of the current Source if any is playing.

abstract val ssai: SsaiApi

Use the SsaiApi to track data related to server side ad insertion.

abstract val userId: String

The userId that is sent with each analytics sample.

Functions

abstract fun programChange(sourceMetadata: SourceMetadata)

Signals a program change to the analytics collector without loading a new source on the player. This starts a new impression with the provided sourceMetadata.

sendCustomDataEvent

abstract fun sendCustomDataEvent(customData: CustomData)

Send an analytics sample with customData without changing the player's current SourceAnalyticsApi.customData.