pillarbox-player/ch.srgssr.pillarbox.player.analytics/PillarboxAnalyticsCollector

PillarboxAnalyticsCollector

class PillarboxAnalyticsCollector(clock: Clock = Clock.DEFAULT) : DefaultAnalyticsCollector, PillarboxPlayer.Listener, StallDetector.Listener

Collects and dispatches analytics events for Pillarbox player.

Parameters

clock

The Clock used to generate timestamps.

Constructors

PillarboxAnalyticsCollector

constructor(clock: Clock = Clock.DEFAULT)

Functions

addListener

@CallSuper

open fun addListener(listener: AnalyticsListener?)

notifySeekStarted

fun notifySeekStarted()

onAudioAttributesChanged

fun onAudioAttributesChanged(audioAttributes: AudioAttributes?)

onAudioCodecError

fun onAudioCodecError(audioCodecError: Exception?)

onAudioDecoderInitialized

fun onAudioDecoderInitialized(decoderName: String?, initializedTimestampMs: Long, initializationDurationMs: Long)

onAudioDecoderReleased

fun onAudioDecoderReleased(decoderName: String?)

onAudioDisabled

fun onAudioDisabled(counters: DecoderCounters?)

onAudioEnabled

fun onAudioEnabled(counters: DecoderCounters?)

onAudioInputFormatChanged

fun onAudioInputFormatChanged(format: Format?, @Nullable decoderReuseEvaluation: DecoderReuseEvaluation?)

onAudioPositionAdvancing

fun onAudioPositionAdvancing(playoutStartSystemTimeMs: Long)

onAudioSessionIdChanged

fun onAudioSessionIdChanged(audioSessionId: Int)

onAudioSinkError

fun onAudioSinkError(audioSinkError: Exception?)

onAudioTrackInitialized

open fun onAudioTrackInitialized(audioTrackConfig: AudioSink.AudioTrackConfig?)

onAudioTrackReleased

open fun onAudioTrackReleased(audioTrackConfig: AudioSink.AudioTrackConfig?)

onAudioUnderrun

fun onAudioUnderrun(bufferSize: Int, bufferSizeMs: Long, elapsedSinceLastFeedMs: Long)

onAvailableCommandsChanged

open fun onAvailableCommandsChanged(availableCommands: Player.Commands?)

onBandwidthSample

fun onBandwidthSample(elapsedMs: Int, bytesTransferred: Long, bitrateEstimate: Long)

onBlockedTimeRangeReached

open override fun onBlockedTimeRangeReached(blockedTimeRange: BlockedTimeRange)

Called when the player reaches a blocked time range.

onChapterChanged

open override fun onChapterChanged(chapter: Chapter?)

Called when the current chapter changes. This can occur due to several reasons:

onCreditChanged

open override fun onCreditChanged(credit: Credit?)

Called when the current credit changes. This can occur due to several reasons:

onCues

open fun onCues(cueGroup: CueGroup?)

open fun onCues(cues: List<Cue?>?)

onDeviceInfoChanged

open fun onDeviceInfoChanged(deviceInfo: DeviceInfo?)

onDeviceVolumeChanged

open fun onDeviceVolumeChanged(volume: Int, muted: Boolean)

onDownstreamFormatChanged

fun onDownstreamFormatChanged(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, mediaLoadData: MediaLoadData?)

onDrmKeysLoaded

open fun ~~onDrmKeysLoaded~~(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?)

open fun onDrmKeysLoaded(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, keyRequestInfo: KeyRequestInfo?)

onDrmKeysRemoved

fun onDrmKeysRemoved(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?)

onDrmKeysRestored

fun onDrmKeysRestored(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?)

onDrmSessionAcquired

fun onDrmSessionAcquired(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, state: Int)

onDrmSessionManagerError

fun onDrmSessionManagerError(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, error: Exception?)

onDrmSessionReleased

fun onDrmSessionReleased(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?)

onDroppedFrames

fun onDroppedFrames(count: Int, elapsedMs: Long)

onDroppedSeeksWhileScrubbing

open fun onDroppedSeeksWhileScrubbing(droppedSeekCount: Int)

onEvents

open fun onEvents(player: Player?, events: Player.Events?)

onIsLoadingChanged

fun onIsLoadingChanged(isLoading: Boolean)

onIsPlayingChanged

open fun onIsPlayingChanged(isPlaying: Boolean)

onLoadCanceled

fun onLoadCanceled(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, loadEventInfo: LoadEventInfo?, mediaLoadData: MediaLoadData?)

onLoadCompleted

fun onLoadCompleted(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, loadEventInfo: LoadEventInfo?, mediaLoadData: MediaLoadData?)

onLoadError

fun onLoadError(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, loadEventInfo: LoadEventInfo?, mediaLoadData: MediaLoadData?, error: IOException?, wasCanceled: Boolean)

onLoadingChanged

open fun onLoadingChanged(isLoading: Boolean)

onLoadStarted

fun onLoadStarted(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, loadEventInfo: LoadEventInfo?, mediaLoadData: MediaLoadData?, retryCount: Int)

onMaxSeekToPreviousPositionChanged

open fun onMaxSeekToPreviousPositionChanged(maxSeekToPreviousPositionMs: Long)

onMediaItemTransition

fun onMediaItemTransition(@Nullable mediaItem: MediaItem?, reason: Int)

onMediaMetadataChanged

open fun onMediaMetadataChanged(mediaMetadata: MediaMetadata?)

onMetadata

fun onMetadata(metadata: Metadata?)

onPillarboxMetadataChanged

open override fun onPillarboxMetadataChanged(pillarboxMetadata: PillarboxMetadata)

Called when the Pillarbox metadata changes.

onPlaybackParametersChanged

fun onPlaybackParametersChanged(playbackParameters: PlaybackParameters?)

onPlaybackStateChanged

fun onPlaybackStateChanged(playbackState: Int)

onPlaybackSuppressionReasonChanged

fun onPlaybackSuppressionReasonChanged(playbackSuppressionReason: Int)

onPlayerError

fun onPlayerError(error: PlaybackException?)

onPlayerErrorChanged

open fun onPlayerErrorChanged(@Nullable error: PlaybackException?)

onPlayerStateChanged

fun onPlayerStateChanged(playWhenReady: Boolean, playbackState: Int)

onPlaylistMetadataChanged

open fun onPlaylistMetadataChanged(playlistMetadata: MediaMetadata?)

onPlayWhenReadyChanged

fun onPlayWhenReadyChanged(playWhenReady: Boolean, reason: Int)

onPositionDiscontinuity

open fun onPositionDiscontinuity(reason: Int)

fun onPositionDiscontinuity(oldPosition: Player.PositionInfo?, newPosition: Player.PositionInfo?, reason: Int)

onRenderedFirstFrame

open fun onRenderedFirstFrame()

fun onRenderedFirstFrame(output: Any?, renderTimeMs: Long)

onRendererReadyChanged

open fun onRendererReadyChanged(rendererIndex: Int, rendererTrackType: Int, isRendererReady: Boolean)

onRepeatModeChanged

fun onRepeatModeChanged(repeatMode: Int)

onSeekBackIncrementChanged

open fun onSeekBackIncrementChanged(seekBackIncrementMs: Long)

onSeekForwardIncrementChanged

open fun onSeekForwardIncrementChanged(seekForwardIncrementMs: Long)

onShuffleModeEnabledChanged

fun onShuffleModeEnabledChanged(shuffleModeEnabled: Boolean)

onSkipSilenceEnabledChanged

fun onSkipSilenceEnabledChanged(skipSilenceEnabled: Boolean)

onStallChanged

open override fun onStallChanged(isStall: Boolean)

Called when the player stall state changed.

onSurfaceSizeChanged

fun onSurfaceSizeChanged(width: Int, height: Int)

onTimelineChanged

fun onTimelineChanged(timeline: Timeline?, reason: Int)

onTrackingEnabledChanged

open override fun onTrackingEnabledChanged(trackingEnabled: Boolean)

Called when the tracking state changes.

onTracksChanged

open fun onTracksChanged(tracks: Tracks?)

onTrackSelectionParametersChanged

open fun onTrackSelectionParametersChanged(parameters: TrackSelectionParameters?)

onUpstreamDiscarded

fun onUpstreamDiscarded(windowIndex: Int, @Nullable mediaPeriodId: MediaSource.MediaPeriodId?, mediaLoadData: MediaLoadData?)

onVideoCodecError

fun onVideoCodecError(videoCodecError: Exception?)

onVideoDecoderInitialized

fun onVideoDecoderInitialized(decoderName: String?, initializedTimestampMs: Long, initializationDurationMs: Long)

onVideoDecoderReleased

fun onVideoDecoderReleased(decoderName: String?)

onVideoDisabled

fun onVideoDisabled(counters: DecoderCounters?)

onVideoEnabled

fun onVideoEnabled(counters: DecoderCounters?)

onVideoFrameProcessingOffset

fun onVideoFrameProcessingOffset(totalProcessingOffsetUs: Long, frameCount: Int)

onVideoInputFormatChanged

fun onVideoInputFormatChanged(format: Format?, @Nullable decoderReuseEvaluation: DecoderReuseEvaluation?)

onVideoSizeChanged

fun onVideoSizeChanged(videoSize: VideoSize?)

onVolumeChanged

fun onVolumeChanged(volume: Float)

release

open override fun release()

removeListener

@CallSuper

open fun removeListener(listener: AnalyticsListener?)

setPlayer

@CallSuper

open fun setPlayer(player: Player?, looper: Looper?)

setThrowsWhenUsingWrongThread

open fun ~~setThrowsWhenUsingWrongThread~~(throwsWhenUsingWrongThread: Boolean)

updateMediaPeriodQueueInfo

fun updateMediaPeriodQueueInfo(queue: List<MediaSource.MediaPeriodId?>?, @Nullable readingPeriod: MediaSource.MediaPeriodId?)