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

PlaybackSessionManager

class PlaybackSessionManager : AnalyticsListener(source)

Manages playback sessions, representing interactions with individual MediaItems.

Constructors

constructor()

Types

Listener

interface Listener

An interface for receiving notifications about session lifecycle events.

Session

class Session(val windowUid: WindowUid, val window: Timeline.Window)

Represents a playback session associated with a MediaItem in a Timeline.

SessionInfo

data class SessionInfo(val session: PlaybackSessionManager.Session, val position: Long)

Represents information about a session at a specific point in time.

Functions

addListener

fun addListener(listener: PlaybackSessionManager.Listener)

Adds a listener to this session manager.

getCurrentSession

fun getCurrentSession(): PlaybackSessionManager.Session?

Returns the current session.

getSessionById

fun getSessionById(sessionId: String): PlaybackSessionManager.Session?

Retrieves a session by its id.

getSessionFromEventTime

fun getSessionFromEventTime(eventTime: AnalyticsListener.EventTime): PlaybackSessionManager.Session?

Retrieves the Session associated with a given EventTime.

getSessionFromWindowUid

fun getSessionFromWindowUid(windowUid: WindowUid): PlaybackSessionManager.Session?

Retrieves the Session associated with a given period UID.

onLoadStarted

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

onPlaybackStateChanged

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

onPlayerError

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

onPlayerReleased

open override fun onPlayerReleased(eventTime: AnalyticsListener.EventTime)

onPositionDiscontinuity

open override fun onPositionDiscontinuity(eventTime: AnalyticsListener.EventTime, oldPosition: Player.PositionInfo, newPosition: Player.PositionInfo, @Player.DiscontinuityReason reason: Int)

onTimelineChanged

open override fun onTimelineChanged(eventTime: AnalyticsListener.EventTime, @Player.TimelineChangeReason reason: Int)

removeListener

fun removeListener(listener: PlaybackSessionManager.Listener)

Removes a listener from this session manager.

Inherited functions

onAudioAttributesChanged

@UnstableApi

open fun onAudioAttributesChanged(eventTime: AnalyticsListener.EventTime, audioAttributes: AudioAttributes)

onAudioCodecError

@UnstableApi

open fun onAudioCodecError(eventTime: AnalyticsListener.EventTime, audioCodecError: Exception)

onAudioDecoderInitialized

@UnstableApi

open fun ~~onAudioDecoderInitialized~~(eventTime: AnalyticsListener.EventTime, decoderName: String, initializationDurationMs: Long)

@UnstableApi

open fun onAudioDecoderInitialized(eventTime: AnalyticsListener.EventTime, decoderName: String, initializedTimestampMs: Long, initializationDurationMs: Long)

onAudioDecoderReleased

@UnstableApi

open fun onAudioDecoderReleased(eventTime: AnalyticsListener.EventTime, decoderName: String)

onAudioDisabled

@UnstableApi

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

onAudioEnabled

@UnstableApi

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

onAudioInputFormatChanged

@UnstableApi

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

onAudioPositionAdvancing

@UnstableApi

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

onAudioSessionIdChanged

@UnstableApi

open fun onAudioSessionIdChanged(eventTime: AnalyticsListener.EventTime, audioSessionId: Int)

onAudioSinkError

@UnstableApi

open fun onAudioSinkError(eventTime: AnalyticsListener.EventTime, audioSinkError: Exception)

onAudioTrackInitialized

@UnstableApi

open fun onAudioTrackInitialized(eventTime: AnalyticsListener.EventTime, audioTrackConfig: AudioSink.AudioTrackConfig)

onAudioTrackReleased

@UnstableApi

open fun onAudioTrackReleased(eventTime: AnalyticsListener.EventTime, audioTrackConfig: AudioSink.AudioTrackConfig)

onAudioUnderrun

@UnstableApi

open fun onAudioUnderrun(eventTime: AnalyticsListener.EventTime, bufferSize: Int, bufferSizeMs: Long, elapsedSinceLastFeedMs: Long)

onAvailableCommandsChanged

@UnstableApi

open fun onAvailableCommandsChanged(eventTime: AnalyticsListener.EventTime, availableCommands: Player.Commands)

onBandwidthEstimate

@UnstableApi

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

onCues

@UnstableApi

open fun onCues(eventTime: AnalyticsListener.EventTime, cueGroup: CueGroup)

@UnstableApi

open fun ~~onCues~~(eventTime: AnalyticsListener.EventTime, cues: List<Cue>)

onDeviceInfoChanged

@UnstableApi

open fun onDeviceInfoChanged(eventTime: AnalyticsListener.EventTime, deviceInfo: DeviceInfo)

onDeviceVolumeChanged

@UnstableApi

open fun onDeviceVolumeChanged(eventTime: AnalyticsListener.EventTime, volume: Int, muted: Boolean)

onDownstreamFormatChanged

@UnstableApi

open fun onDownstreamFormatChanged(eventTime: AnalyticsListener.EventTime, mediaLoadData: MediaLoadData)

onDrmKeysLoaded

@UnstableApi

open fun ~~onDrmKeysLoaded~~(eventTime: AnalyticsListener.EventTime)

@UnstableApi

open fun onDrmKeysLoaded(eventTime: AnalyticsListener.EventTime, keyRequestInfo: KeyRequestInfo)

onDrmKeysRemoved

@UnstableApi

open fun onDrmKeysRemoved(eventTime: AnalyticsListener.EventTime)

onDrmKeysRestored

@UnstableApi

open fun onDrmKeysRestored(eventTime: AnalyticsListener.EventTime)

onDrmSessionAcquired

@UnstableApi

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

@UnstableApi

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

onDrmSessionManagerError

@UnstableApi

open fun onDrmSessionManagerError(eventTime: AnalyticsListener.EventTime, error: Exception)

onDrmSessionReleased

@UnstableApi

open fun onDrmSessionReleased(eventTime: AnalyticsListener.EventTime)

onDroppedSeeksWhileScrubbing

@UnstableApi

open fun onDroppedSeeksWhileScrubbing(eventTime: AnalyticsListener.EventTime, droppedSeeks: Int)

onDroppedVideoFrames

@UnstableApi

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

onEvents

@UnstableApi

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

onIsLoadingChanged

@UnstableApi

open fun onIsLoadingChanged(eventTime: AnalyticsListener.EventTime, isLoading: Boolean)

onIsPlayingChanged

@UnstableApi

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

onLoadCanceled

@UnstableApi

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

onLoadCompleted

@UnstableApi

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

onLoadError

@UnstableApi

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

onLoadingChanged

@UnstableApi

open fun ~~onLoadingChanged~~(eventTime: AnalyticsListener.EventTime, isLoading: Boolean)

onLoadStarted

@UnstableApi

open fun ~~onLoadStarted~~(eventTime: AnalyticsListener.EventTime, loadEventInfo: LoadEventInfo, mediaLoadData: MediaLoadData)

onMaxSeekToPreviousPositionChanged

@UnstableApi

open fun onMaxSeekToPreviousPositionChanged(eventTime: AnalyticsListener.EventTime, maxSeekToPreviousPositionMs: Long)

onMediaItemTransition

@UnstableApi

open fun onMediaItemTransition(eventTime: AnalyticsListener.EventTime, @Nullable mediaItem: MediaItem?, reason: Int)

onMediaMetadataChanged

@UnstableApi

open fun onMediaMetadataChanged(eventTime: AnalyticsListener.EventTime, mediaMetadata: MediaMetadata)

onMetadata

@UnstableApi

open fun onMetadata(eventTime: AnalyticsListener.EventTime, metadata: Metadata)

onPlaybackParametersChanged

@UnstableApi

open fun onPlaybackParametersChanged(eventTime: AnalyticsListener.EventTime, playbackParameters: PlaybackParameters)

onPlaybackSuppressionReasonChanged

@UnstableApi

open fun onPlaybackSuppressionReasonChanged(eventTime: AnalyticsListener.EventTime, playbackSuppressionReason: Int)

onPlayerErrorChanged

@UnstableApi

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

onPlayerStateChanged

@UnstableApi

open fun ~~onPlayerStateChanged~~(eventTime: AnalyticsListener.EventTime, playWhenReady: Boolean, playbackState: Int)

onPlaylistMetadataChanged

@UnstableApi

open fun onPlaylistMetadataChanged(eventTime: AnalyticsListener.EventTime, playlistMetadata: MediaMetadata)

onPlayWhenReadyChanged

@UnstableApi

open fun onPlayWhenReadyChanged(eventTime: AnalyticsListener.EventTime, playWhenReady: Boolean, reason: Int)

onPositionDiscontinuity

@UnstableApi

open fun ~~onPositionDiscontinuity~~(eventTime: AnalyticsListener.EventTime, reason: Int)

onRenderedFirstFrame

@UnstableApi

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

onRendererReadyChanged

@UnstableApi

open fun onRendererReadyChanged(eventTime: AnalyticsListener.EventTime, rendererIndex: Int, rendererTrackType: Int, isRendererReady: Boolean)

onRepeatModeChanged

@UnstableApi

open fun onRepeatModeChanged(eventTime: AnalyticsListener.EventTime, repeatMode: Int)

onSeekBackIncrementChanged

@UnstableApi

open fun onSeekBackIncrementChanged(eventTime: AnalyticsListener.EventTime, seekBackIncrementMs: Long)

onSeekForwardIncrementChanged

@UnstableApi

open fun onSeekForwardIncrementChanged(eventTime: AnalyticsListener.EventTime, seekForwardIncrementMs: Long)

onSeekStarted

@UnstableApi

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

onShuffleModeChanged

@UnstableApi

open fun onShuffleModeChanged(eventTime: AnalyticsListener.EventTime, shuffleModeEnabled: Boolean)

onSkipSilenceEnabledChanged

@UnstableApi

open fun onSkipSilenceEnabledChanged(eventTime: AnalyticsListener.EventTime, skipSilenceEnabled: Boolean)

onSurfaceSizeChanged

@UnstableApi

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

onTracksChanged

@UnstableApi

open fun onTracksChanged(eventTime: AnalyticsListener.EventTime, tracks: Tracks)

onTrackSelectionParametersChanged

@UnstableApi

open fun onTrackSelectionParametersChanged(eventTime: AnalyticsListener.EventTime, trackSelectionParameters: TrackSelectionParameters)

onUpstreamDiscarded

@UnstableApi

open fun onUpstreamDiscarded(eventTime: AnalyticsListener.EventTime, mediaLoadData: MediaLoadData)

onVideoCodecError

@UnstableApi

open fun onVideoCodecError(eventTime: AnalyticsListener.EventTime, videoCodecError: Exception)

onVideoDecoderInitialized

@UnstableApi

open fun ~~onVideoDecoderInitialized~~(eventTime: AnalyticsListener.EventTime, decoderName: String, initializationDurationMs: Long)

@UnstableApi

open fun onVideoDecoderInitialized(eventTime: AnalyticsListener.EventTime, decoderName: String, initializedTimestampMs: Long, initializationDurationMs: Long)

onVideoDecoderReleased

@UnstableApi

open fun onVideoDecoderReleased(eventTime: AnalyticsListener.EventTime, decoderName: String)

onVideoDisabled

@UnstableApi

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

onVideoEnabled

@UnstableApi

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

onVideoFrameProcessingOffset

@UnstableApi

open fun onVideoFrameProcessingOffset(eventTime: AnalyticsListener.EventTime, totalProcessingOffsetUs: Long, frameCount: Int)

onVideoInputFormatChanged

@UnstableApi

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

onVideoSizeChanged

@UnstableApi

open fun onVideoSizeChanged(eventTime: AnalyticsListener.EventTime, videoSize: VideoSize)

@UnstableApi

open fun ~~onVideoSizeChanged~~(eventTime: AnalyticsListener.EventTime, width: Int, height: Int, unappliedRotationDegrees: Int, pixelWidthHeightRatio: Float)

onVolumeChanged

@UnstableApi

open fun onVolumeChanged(eventTime: AnalyticsListener.EventTime, volume: Float)