4.0.0-TEST

pillarbox-player/ch.srgssr.pillarbox.player.analytics.metrics/PlaybackMetrics

PlaybackMetrics

data class PlaybackMetrics(val sessionId: String, val bandwidth: Long, val indicatedBitrate: Long, val playbackDuration: Duration, val bufferingDuration: Duration, val stallCount: Int, val stallDuration: Duration, val loadDuration: PlaybackMetrics.LoadDuration, val totalLoadTime: Duration, val totalBytesLoaded: Long, val url: Uri?, val videoFormat: Format?, val audioFormat: Format?, val surfaceSize: Size, val totalDroppedFrames: Int)

Represents playback metrics, containing information about the current media stream and playback session.

Constructors

PlaybackMetrics

constructor(sessionId: String, bandwidth: Long, indicatedBitrate: Long, playbackDuration: Duration, bufferingDuration: Duration, stallCount: Int, stallDuration: Duration, loadDuration: PlaybackMetrics.LoadDuration, totalLoadTime: Duration, totalBytesLoaded: Long, url: Uri?, videoFormat: Format?, audioFormat: Format?, surfaceSize: Size, totalDroppedFrames: Int)

Types

data class LoadDuration(val source: Duration? = null, val manifest: Duration? = null, val asset: Duration? = null, val drm: Duration? = null, val timeToReady: Duration? = null)

Represents the timings spent in different stages of the loading process, until the current media started to play.

Properties

val audioFormat: Format?

The Format of the currently selected audio track.

val bandwidth: Long

The device-measured network bandwidth, in bits per second.

bufferingDuration

val bufferingDuration: Duration

The total duration spent buffering the media.

indicatedBitrate

val indicatedBitrate: Long

The bitrate of the video and audio format, in bits per second.

val loadDuration: PlaybackMetrics.LoadDuration

The LoadDuration containing detailed timings for different stages of media loading.

playbackDuration

val playbackDuration: Duration

The total duration spent playing the media.

val sessionId: String

A unique identifier for the playback session.

val stallCount: Int

The number of times playback stalled, excluding stalls caused by seeking.

val stallDuration: Duration

The total duration of the stalls.

val surfaceSize: Size

The size of the surface used for rendering the video. If no surface is connected, this will be Size.ZERO.

totalBytesLoaded

val totalBytesLoaded: Long

The total number of bytes loaded for bandwidth calculation.

totalDroppedFrames

val totalDroppedFrames: Int

The total number of video frames dropped.

val totalLoadTime: Duration

The total time taken to load the media for bandwidth calculation.

val url: Uri?

The last URL loaded by the player.

val videoFormat: Format?

The Format of the currently selected video track.

val videoSize: VideoSize

Represents the video size of videoFormat, if applicable. Otherwise VideoSize.UNKNOWN.