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

MetricsCollector

class MetricsCollector(sessionManager: PlaybackSessionManager, clock: Clock) : PillarboxAnalyticsListener

This class is responsible for collecting and computing playback statistics metrics such as:

Stalls (count and duration)
Playtime
Bitrate (estimated and indicated)
Loading times (manifest, asset, source, DRM)
Video and audio format information
Dropped video frames
Surface size

Constructors

MetricsCollector

constructor(sessionManager: PlaybackSessionManager, clock: Clock)

Types

Listener

interface Listener

A listener interface for receiving updates about playback metrics.

Functions

addListener

fun addListener(listener: MetricsCollector.Listener)

Registers a listener to receive events.

getCurrentMetrics

fun getCurrentMetrics(): PlaybackMetrics?

Retrieves the current playback metrics.

getMetricsForSession

fun getMetricsForSession(session: PlaybackSessionManager.Session): PlaybackMetrics?

Retrieves playback metrics for a given playback session.

onAudioDisabled

open override fun onAudioDisabled(eventTime: AnalyticsListener.EventTime, decoderCounters: DecoderCounters)

onAudioInputFormatChanged

open override fun onAudioInputFormatChanged(eventTime: AnalyticsListener.EventTime, format: Format, decoderReuseEvaluation: DecoderReuseEvaluation?)

onAudioPositionAdvancing

open override fun onAudioPositionAdvancing(eventTime: AnalyticsListener.EventTime, playoutStartSystemTimeMs: Long)

onBandwidthEstimate

open override fun onBandwidthEstimate(eventTime: AnalyticsListener.EventTime, totalLoadTimeMs: Int, totalBytesLoaded: Long, bitrateEstimate: Long)

onDrmKeysLoaded

open override fun onDrmKeysLoaded(eventTime: AnalyticsListener.EventTime)

onDrmKeysRemoved

open override fun onDrmKeysRemoved(eventTime: AnalyticsListener.EventTime)

onDrmKeysRestored

open override fun onDrmKeysRestored(eventTime: AnalyticsListener.EventTime)

onDrmSessionAcquired

open override fun onDrmSessionAcquired(eventTime: AnalyticsListener.EventTime, state: Int)

onDrmSessionReleased

open override fun onDrmSessionReleased(eventTime: AnalyticsListener.EventTime)

onDroppedVideoFrames

open override fun onDroppedVideoFrames(eventTime: AnalyticsListener.EventTime, droppedFrames: Int, elapsedMs: Long)

onIsPlayingChanged

open override fun onIsPlayingChanged(eventTime: AnalyticsListener.EventTime, isPlaying: Boolean)

onLoadCompleted

open override fun onLoadCompleted(eventTime: AnalyticsListener.EventTime, loadEventInfo: LoadEventInfo, mediaLoadData: MediaLoadData)

onLoadError

open override fun onLoadError(eventTime: AnalyticsListener.EventTime, loadEventInfo: LoadEventInfo, mediaLoadData: MediaLoadData, error: IOException, wasCanceled: Boolean)

onLoadStarted

open override fun onLoadStarted(eventTime: AnalyticsListener.EventTime, loadEventInfo: LoadEventInfo, mediaLoadData: MediaLoadData, retryCount: Int)

onPlaybackStateChanged

open override fun onPlaybackStateChanged(eventTime: AnalyticsListener.EventTime, state: Int)

onPlayerErrorChanged

open override fun onPlayerErrorChanged(eventTime: AnalyticsListener.EventTime, error: PlaybackException?)

onPlayerReleased

open override fun onPlayerReleased(eventTime: AnalyticsListener.EventTime)

onRenderedFirstFrame

open override fun onRenderedFirstFrame(eventTime: AnalyticsListener.EventTime, output: Any, renderTimeMs: Long)

onStallChanged

open override fun onStallChanged(eventTime: AnalyticsListener.EventTime, isStall: Boolean)

Called when the player's stall state changes.

onSurfaceSizeChanged

open override fun onSurfaceSizeChanged(eventTime: AnalyticsListener.EventTime, width: Int, height: Int)

onVideoDisabled

open override fun onVideoDisabled(eventTime: AnalyticsListener.EventTime, decoderCounters: DecoderCounters)

On video disabled is called when releasing the player

onVideoInputFormatChanged

open override fun onVideoInputFormatChanged(eventTime: AnalyticsListener.EventTime, format: Format, decoderReuseEvaluation: DecoderReuseEvaluation?)

removeListener

fun removeListener(listener: MetricsCollector.Listener)

Removes the specified listener from the list of listeners.

Inherited functions

onAudioAttributesChanged

@UnstableApi

open fun onAudioAttributesChanged(p0: AnalyticsListener.EventTime, p1: AudioAttributes)

onAudioCodecError

@UnstableApi

open fun onAudioCodecError(p0: AnalyticsListener.EventTime, p1: Exception)

onAudioDecoderInitialized

@UnstableApi

open fun ~~onAudioDecoderInitialized~~(p0: AnalyticsListener.EventTime, p1: String, p2: Long)

@UnstableApi

open fun onAudioDecoderInitialized(p0: AnalyticsListener.EventTime, p1: String, p2: Long, p3: Long)

onAudioDecoderReleased

@UnstableApi

open fun onAudioDecoderReleased(p0: AnalyticsListener.EventTime, p1: String)

onAudioEnabled

@UnstableApi

open fun onAudioEnabled(p0: AnalyticsListener.EventTime, p1: DecoderCounters)

onAudioSessionIdChanged

@UnstableApi

open fun onAudioSessionIdChanged(p0: AnalyticsListener.EventTime, p1: Int)

onAudioSinkError

@UnstableApi

open fun onAudioSinkError(p0: AnalyticsListener.EventTime, p1: Exception)

onAudioTrackInitialized

@UnstableApi

open fun onAudioTrackInitialized(p0: AnalyticsListener.EventTime, p1: AudioSink.AudioTrackConfig)

onAudioTrackReleased

@UnstableApi

open fun onAudioTrackReleased(p0: AnalyticsListener.EventTime, p1: AudioSink.AudioTrackConfig)

onAudioUnderrun

@UnstableApi

open fun onAudioUnderrun(p0: AnalyticsListener.EventTime, p1: Int, p2: Long, p3: Long)

onAvailableCommandsChanged

@UnstableApi

open fun onAvailableCommandsChanged(p0: AnalyticsListener.EventTime, p1: Player.Commands)

onBlockedTimeRangeReached

open fun onBlockedTimeRangeReached(eventTime: AnalyticsListener.EventTime, blockedTimeRange: BlockedTimeRange)

Called when the player reaches a blocked time range.

onChapterChanged

open fun onChapterChanged(eventTime: AnalyticsListener.EventTime, chapter: Chapter?)

Called when the current chapter changes. This can occur when either:

onCreditChanged

open fun onCreditChanged(eventTime: AnalyticsListener.EventTime, credit: Credit?)

Called when the current credit changes. This can occur when either:

onCues

@UnstableApi

open fun onCues(p0: AnalyticsListener.EventTime, p1: CueGroup)

@UnstableApi

open fun ~~onCues~~(p0: AnalyticsListener.EventTime, p1: List<Cue>)

onDeviceInfoChanged

@UnstableApi

open fun onDeviceInfoChanged(p0: AnalyticsListener.EventTime, p1: DeviceInfo)

onDeviceVolumeChanged

@UnstableApi

open fun onDeviceVolumeChanged(p0: AnalyticsListener.EventTime, p1: Int, p2: Boolean)

onDownstreamFormatChanged

@UnstableApi

open fun onDownstreamFormatChanged(p0: AnalyticsListener.EventTime, p1: MediaLoadData)

onDrmSessionAcquired

@UnstableApi

open fun ~~onDrmSessionAcquired~~(p0: AnalyticsListener.EventTime)

onDrmSessionManagerError

@UnstableApi

open fun onDrmSessionManagerError(p0: AnalyticsListener.EventTime, p1: Exception)

onEvents

@UnstableApi

open fun onEvents(p0: Player, p1: AnalyticsListener.Events)

onIsLoadingChanged

@UnstableApi

open fun onIsLoadingChanged(p0: AnalyticsListener.EventTime, p1: Boolean)

onLoadCanceled

@UnstableApi

open fun onLoadCanceled(p0: AnalyticsListener.EventTime, p1: LoadEventInfo, p2: MediaLoadData)

onLoadingChanged

@UnstableApi

open fun ~~onLoadingChanged~~(p0: AnalyticsListener.EventTime, p1: Boolean)

onLoadStarted

@UnstableApi

open fun ~~onLoadStarted~~(p0: AnalyticsListener.EventTime, p1: LoadEventInfo, p2: MediaLoadData)

onMaxSeekToPreviousPositionChanged

@UnstableApi

open fun onMaxSeekToPreviousPositionChanged(p0: AnalyticsListener.EventTime, p1: Long)

onMediaItemTransition

@UnstableApi

open fun onMediaItemTransition(p0: AnalyticsListener.EventTime, @Nullable p1: MediaItem?, p2: Int)

onMediaMetadataChanged

@UnstableApi

open fun onMediaMetadataChanged(p0: AnalyticsListener.EventTime, p1: MediaMetadata)

onMetadata

@UnstableApi

open fun onMetadata(p0: AnalyticsListener.EventTime, p1: Metadata)

onPillarboxMetaDataChanged

open fun onPillarboxMetaDataChanged(eventTime: AnalyticsListener.EventTime, pillarboxMetadata: PillarboxMetadata)

Called when Pillarbox's metadata changes.

onPlaybackParametersChanged

@UnstableApi

open fun onPlaybackParametersChanged(p0: AnalyticsListener.EventTime, p1: PlaybackParameters)

onPlaybackSuppressionReasonChanged

@UnstableApi

open fun onPlaybackSuppressionReasonChanged(p0: AnalyticsListener.EventTime, p1: Int)

onPlayerError

@UnstableApi

open fun onPlayerError(p0: AnalyticsListener.EventTime, p1: PlaybackException)

onPlayerStateChanged

@UnstableApi

open fun ~~onPlayerStateChanged~~(p0: AnalyticsListener.EventTime, p1: Boolean, p2: Int)

onPlaylistMetadataChanged

@UnstableApi

open fun onPlaylistMetadataChanged(p0: AnalyticsListener.EventTime, p1: MediaMetadata)

onPlayWhenReadyChanged

@UnstableApi

open fun onPlayWhenReadyChanged(p0: AnalyticsListener.EventTime, p1: Boolean, p2: Int)

onPositionDiscontinuity

@UnstableApi

open fun ~~onPositionDiscontinuity~~(p0: AnalyticsListener.EventTime, p1: Int)

@UnstableApi

open fun onPositionDiscontinuity(p0: AnalyticsListener.EventTime, p1: Player.PositionInfo, p2: Player.PositionInfo, p3: Int)

onRendererReadyChanged

@UnstableApi

open fun onRendererReadyChanged(p0: AnalyticsListener.EventTime, p1: Int, p2: Int, p3: Boolean)

onRepeatModeChanged

@UnstableApi

open fun onRepeatModeChanged(p0: AnalyticsListener.EventTime, p1: Int)

onSeekBackIncrementChanged

@UnstableApi

open fun onSeekBackIncrementChanged(p0: AnalyticsListener.EventTime, p1: Long)

onSeekForwardIncrementChanged

@UnstableApi

open fun onSeekForwardIncrementChanged(p0: AnalyticsListener.EventTime, p1: Long)

onSeekStarted

@UnstableApi

open fun ~~onSeekStarted~~(p0: AnalyticsListener.EventTime)

onShuffleModeChanged

@UnstableApi

open fun onShuffleModeChanged(p0: AnalyticsListener.EventTime, p1: Boolean)

onSkipSilenceEnabledChanged

@UnstableApi

open fun onSkipSilenceEnabledChanged(p0: AnalyticsListener.EventTime, p1: Boolean)

onSmoothSeekingEnabledChanged

open fun onSmoothSeekingEnabledChanged(eventTime: AnalyticsListener.EventTime, smoothSeekingEnabled: Boolean)

Called when the smooth seeking enabled state changes.

onTimelineChanged

@UnstableApi

open fun onTimelineChanged(p0: AnalyticsListener.EventTime, p1: Int)

onTrackingEnabledChanged

open fun onTrackingEnabledChanged(eventTime: AnalyticsListener.EventTime, trackingEnabled: Boolean)

Called when the tracking enabled state changes.

onTracksChanged

@UnstableApi

open fun onTracksChanged(p0: AnalyticsListener.EventTime, p1: Tracks)

onTrackSelectionParametersChanged

@UnstableApi

open fun onTrackSelectionParametersChanged(p0: AnalyticsListener.EventTime, p1: TrackSelectionParameters)

onUpstreamDiscarded

@UnstableApi

open fun onUpstreamDiscarded(p0: AnalyticsListener.EventTime, p1: MediaLoadData)

onVideoCodecError

@UnstableApi

open fun onVideoCodecError(p0: AnalyticsListener.EventTime, p1: Exception)

onVideoDecoderInitialized

@UnstableApi

open fun ~~onVideoDecoderInitialized~~(p0: AnalyticsListener.EventTime, p1: String, p2: Long)

@UnstableApi

open fun onVideoDecoderInitialized(p0: AnalyticsListener.EventTime, p1: String, p2: Long, p3: Long)

onVideoDecoderReleased

@UnstableApi

open fun onVideoDecoderReleased(p0: AnalyticsListener.EventTime, p1: String)

onVideoEnabled

@UnstableApi

open fun onVideoEnabled(p0: AnalyticsListener.EventTime, p1: DecoderCounters)

onVideoFrameProcessingOffset

@UnstableApi

open fun onVideoFrameProcessingOffset(p0: AnalyticsListener.EventTime, p1: Long, p2: Int)

onVideoSizeChanged

@UnstableApi

open fun onVideoSizeChanged(p0: AnalyticsListener.EventTime, p1: VideoSize)

@UnstableApi

open fun ~~onVideoSizeChanged~~(p0: AnalyticsListener.EventTime, p1: Int, p2: Int, p3: Int, p4: Float)

onVolumeChanged

@UnstableApi

open fun onVolumeChanged(p0: AnalyticsListener.EventTime, p1: Float)