PlaybackStatsListener

Artifact: androidx.media3:media3-exoplayer

Kotlin |Java

@UnstableApi
public final class PlaybackStatsListener implements AnalyticsListener, PlaybackSessionManager.Listener

AnalyticsListener to gather PlaybackStats from the player.

For accurate measurements, the listener should be added to the player before loading media, i.e., getPlaybackState should be STATE_IDLE.

Playback stats are gathered separately for each playback session, i.e. each window in the Timeline and each single ad.

Summary

Nested types
`public interface PlaybackStatsListener.Callback` A listener for `PlaybackStats` updates.

Public constructors
`PlaybackStatsListener( boolean keepHistory, @Nullable PlaybackStatsListener.Callback callback )` Creates listener for playback stats.

Public methods
`PlaybackStats`	`getCombinedPlaybackStats()` Returns the combined `PlaybackStats` for all playback sessions this listener was and is listening to.
`@Nullable PlaybackStats`	`getPlaybackStats()` Returns the `PlaybackStats` for the currently playback session, or null if no session is active.
`void`	`onAdPlaybackStarted( AnalyticsListener.EventTime eventTime, String contentSessionId, String adSessionId )` Called when a session is interrupted by ad playback.
`void`	`onBandwidthEstimate( AnalyticsListener.EventTime eventTime, int totalLoadTimeMs, long totalBytesLoaded, long bitrateEstimate )` Called when the bandwidth estimate for the current data source has been updated.
`void`	`onDownstreamFormatChanged( AnalyticsListener.EventTime eventTime, MediaLoadData mediaLoadData )` Called when the downstream format sent to the renderers changed.
`void`	`onDrmSessionManagerError( AnalyticsListener.EventTime eventTime, Exception error )` Called when a drm error occurs.
`void`	`onDroppedVideoFrames( AnalyticsListener.EventTime eventTime, int droppedFrames, long elapsedMs )` Called after video frames have been dropped.
`void`	`onEvents(Player player, AnalyticsListener.Events events)` Called after one or more events occurred.
`void`	`onLoadError( AnalyticsListener.EventTime eventTime, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData, IOException error, boolean wasCanceled )` Called when a media source loading error occurred.
`void`	`onPositionDiscontinuity( AnalyticsListener.EventTime eventTime, Player.PositionInfo oldPosition, Player.PositionInfo newPosition, @Player.DiscontinuityReason int reason )` Called when a position discontinuity occurred.
`void`	`onSessionActive( AnalyticsListener.EventTime eventTime, String sessionId )` Called when a session becomes active, i.e. playing in the foreground.
`void`	`onSessionCreated( AnalyticsListener.EventTime eventTime, String sessionId )` Called when a new session is created as a result of `updateSessions`.
`void`	`onSessionFinished( AnalyticsListener.EventTime eventTime, String sessionId, boolean automaticTransitionToNextPlayback )` Called when a session is permanently finished.
`void`	`onVideoSizeChanged( AnalyticsListener.EventTime eventTime, VideoSize videoSize )` Called before a frame is rendered for the first time since setting the surface, and each time there's a change in the size or pixel aspect ratio of the video being rendered.

Inherited Constants

From androidx.media3.exoplayer.analytics.AnalyticsListener

`static final int`	`@UnstableApi EVENT_AUDIO_ATTRIBUTES_CHANGED = 20` Audio attributes changed.
`static final int`	`@UnstableApi EVENT_AUDIO_CODEC_ERROR = 1029` The audio codec encountered an error.
`static final int`	`@UnstableApi EVENT_AUDIO_DECODER_INITIALIZED = 1008` An audio renderer created a decoder.
`static final int`	`@UnstableApi EVENT_AUDIO_DECODER_RELEASED = 1012` An audio renderer released a decoder.
`static final int`	`@UnstableApi EVENT_AUDIO_DISABLED = 1013` An audio renderer was disabled.
`static final int`	`@UnstableApi EVENT_AUDIO_ENABLED = 1007` An audio renderer was enabled.
`static final int`	`@UnstableApi EVENT_AUDIO_INPUT_FORMAT_CHANGED = 1009` The format consumed by an audio renderer changed.
`static final int`	`@UnstableApi EVENT_AUDIO_POSITION_ADVANCING = 1010` The audio position has increased for the first time since the last pause or position reset.
`static final int`	`@UnstableApi EVENT_AUDIO_SESSION_ID = 21` An audio session id was set.
`static final int`	`@UnstableApi EVENT_AUDIO_SINK_ERROR = 1014` The audio sink encountered a non-fatal error.
`static final int`	`@UnstableApi EVENT_AUDIO_TRACK_INITIALIZED = 1031` An audio track has been initialized.
`static final int`	`@UnstableApi EVENT_AUDIO_TRACK_RELEASED = 1032` An audio track has been released.
`static final int`	`@UnstableApi EVENT_AUDIO_UNDERRUN = 1011` An audio underrun occurred.
`static final int`	`@UnstableApi EVENT_AVAILABLE_COMMANDS_CHANGED = 13` `getAvailableCommands` changed.
`static final int`	`@UnstableApi EVENT_BANDWIDTH_ESTIMATE = 1006` The bandwidth estimate has been updated.
`static final int`	`@UnstableApi EVENT_CUES = 27` `getCurrentCues` changed.
`static final int`	`@UnstableApi EVENT_DEVICE_INFO_CHANGED = 29` `getDeviceInfo` changed.
`static final int`	`@UnstableApi EVENT_DEVICE_VOLUME_CHANGED = 30` `getDeviceVolume` changed.
`static final int`	`@UnstableApi EVENT_DOWNSTREAM_FORMAT_CHANGED = 1004` The downstream format sent to renderers changed.
`static final int`	`@UnstableApi EVENT_DRM_KEYS_LOADED = 1023` DRM keys were loaded.
`static final int`	`@UnstableApi EVENT_DRM_KEYS_REMOVED = 1026` DRM keys were removed.
`static final int`	`@UnstableApi EVENT_DRM_KEYS_RESTORED = 1025` DRM keys were restored.
`static final int`	`@UnstableApi EVENT_DRM_SESSION_ACQUIRED = 1022` A DRM session has been acquired.
`static final int`	`@UnstableApi EVENT_DRM_SESSION_MANAGER_ERROR = 1024` A non-fatal DRM session manager error occurred.
`static final int`	`@UnstableApi EVENT_DRM_SESSION_RELEASED = 1027` A DRM session has been released.
`static final int`	`@UnstableApi EVENT_DROPPED_VIDEO_FRAMES = 1018` Video frames have been dropped.
`static final int`	`@UnstableApi EVENT_IS_LOADING_CHANGED = 3` `isLoading` ()} changed.
`static final int`	`@UnstableApi EVENT_IS_PLAYING_CHANGED = 7` `isPlaying` changed.
`static final int`	`@UnstableApi EVENT_LOAD_CANCELED = 1002` A source canceled loading data.
`static final int`	`@UnstableApi EVENT_LOAD_COMPLETED = 1001` A source started completed loading data.
`static final int`	`@UnstableApi EVENT_LOAD_ERROR = 1003` A source had a non-fatal error loading data.
`static final int`	`@UnstableApi EVENT_LOAD_STARTED = 1000` A source started loading data.
`static final int`	`@UnstableApi EVENT_MAX_SEEK_TO_PREVIOUS_POSITION_CHANGED = 18` `getMaxSeekToPreviousPosition` changed.
`static final int`	`@UnstableApi EVENT_MEDIA_ITEM_TRANSITION = 1` `getCurrentMediaItem` changed or the player started repeating the current item.
`static final int`	`@UnstableApi EVENT_MEDIA_METADATA_CHANGED = 14` `getMediaMetadata` changed.
`static final int`	`@UnstableApi EVENT_METADATA = 28` Metadata associated with the current playback time was reported.
`static final int`	`@UnstableApi EVENT_PLAYBACK_PARAMETERS_CHANGED = 12` `getPlaybackParameters` changed.
`static final int`	`@UnstableApi EVENT_PLAYBACK_STATE_CHANGED = 4` `getPlaybackState` changed.
`static final int`	`@UnstableApi EVENT_PLAYBACK_SUPPRESSION_REASON_CHANGED = 6` `getPlaybackSuppressionReason` changed.
`static final int`	`@UnstableApi EVENT_PLAYER_ERROR = 10` `getPlayerError` changed.
`static final int`	`@UnstableApi EVENT_PLAYER_RELEASED = 1028` The player was released.
`static final int`	`@UnstableApi EVENT_PLAYLIST_METADATA_CHANGED = 15` `getPlaylistMetadata` changed.
`static final int`	`@UnstableApi EVENT_PLAY_WHEN_READY_CHANGED = 5` `getPlayWhenReady` changed.
`static final int`	`@UnstableApi EVENT_POSITION_DISCONTINUITY = 11` A position discontinuity occurred.
`static final int`	`@UnstableApi EVENT_RENDERED_FIRST_FRAME = 26` The first frame has been rendered since setting the surface, since the renderer was reset or since the stream changed.
`static final int`	`@UnstableApi EVENT_REPEAT_MODE_CHANGED = 8` `getRepeatMode` changed.
`static final int`	`@UnstableApi EVENT_SEEK_BACK_INCREMENT_CHANGED = 16` `getSeekBackIncrement` changed.
`static final int`	`@UnstableApi EVENT_SEEK_FORWARD_INCREMENT_CHANGED = 17` `getSeekForwardIncrement` changed.
`static final int`	`@UnstableApi EVENT_SHUFFLE_MODE_ENABLED_CHANGED = 9` `getShuffleModeEnabled` changed.
`static final int`	`@UnstableApi EVENT_SKIP_SILENCE_ENABLED_CHANGED = 23` Skipping silences was enabled or disabled in the audio stream.
`static final int`	`@UnstableApi EVENT_SURFACE_SIZE_CHANGED = 24` The surface size changed.
`static final int`	`@UnstableApi EVENT_TIMELINE_CHANGED = 0` `getCurrentTimeline` changed.
`static final int`	`@UnstableApi EVENT_TRACKS_CHANGED = 2` `getCurrentTracks` changed.
`static final int`	`@UnstableApi EVENT_TRACK_SELECTION_PARAMETERS_CHANGED = 19` `getTrackSelectionParameters` changed.
`static final int`	`@UnstableApi EVENT_UPSTREAM_DISCARDED = 1005` Data was removed from the end of the media buffer.
`static final int`	`@UnstableApi EVENT_VIDEO_CODEC_ERROR = 1030` The video codec encountered an error.
`static final int`	`@UnstableApi EVENT_VIDEO_DECODER_INITIALIZED = 1016` A video renderer created a decoder.
`static final int`	`@UnstableApi EVENT_VIDEO_DECODER_RELEASED = 1019` A video renderer released a decoder.
`static final int`	`@UnstableApi EVENT_VIDEO_DISABLED = 1020` A video renderer was disabled.
`static final int`	`@UnstableApi EVENT_VIDEO_ENABLED = 1015` A video renderer was enabled.
`static final int`	`@UnstableApi EVENT_VIDEO_FRAME_PROCESSING_OFFSET = 1021` Video frame processing offset data has been reported.
`static final int`	`@UnstableApi EVENT_VIDEO_INPUT_FORMAT_CHANGED = 1017` The format consumed by a video renderer changed.
`static final int`	`@UnstableApi EVENT_VIDEO_SIZE_CHANGED = 25` The video size changed.
`static final int`	`@UnstableApi EVENT_VOLUME_CHANGED = 22` The volume changed.

Inherited methods

From androidx.media3.exoplayer.analytics.AnalyticsListener

`void`	`@UnstableApi onAudioAttributesChanged( AnalyticsListener.EventTime eventTime, AudioAttributes audioAttributes )` Called when the audio attributes change.
`void`	`@UnstableApi onAudioCodecError( AnalyticsListener.EventTime eventTime, Exception audioCodecError )` Called when an audio decoder encounters an error.
`void`	`@UnstableApi onAudioDecoderInitialized( AnalyticsListener.EventTime eventTime, String decoderName, long initializationDurationMs )` This method is deprecated. Use `onAudioDecoderInitialized`.
`void`	`@UnstableApi onAudioDecoderInitialized( AnalyticsListener.EventTime eventTime, String decoderName, long initializedTimestampMs, long initializationDurationMs )` Called when an audio renderer creates a decoder.
`void`	`@UnstableApi onAudioDecoderReleased( AnalyticsListener.EventTime eventTime, String decoderName )` Called when an audio renderer releases a decoder.
`void`	`@UnstableApi onAudioDisabled( AnalyticsListener.EventTime eventTime, DecoderCounters decoderCounters )` Called when an audio renderer is disabled.
`void`	`@UnstableApi onAudioEnabled( AnalyticsListener.EventTime eventTime, DecoderCounters decoderCounters )` Called when an audio renderer is enabled.
`void`	`@UnstableApi onAudioInputFormatChanged( AnalyticsListener.EventTime eventTime, Format format )` This method is deprecated. Use `onAudioInputFormatChanged`.
`void`	`@UnstableApi onAudioInputFormatChanged( AnalyticsListener.EventTime eventTime, Format format, @Nullable DecoderReuseEvaluation decoderReuseEvaluation )` Called when the format of the media being consumed by an audio renderer changes.
`void`	`@UnstableApi onAudioPositionAdvancing( AnalyticsListener.EventTime eventTime, long playoutStartSystemTimeMs )` Called when the audio position has increased for the first time since the last pause or position reset.
`void`	`@UnstableApi onAudioSessionIdChanged( AnalyticsListener.EventTime eventTime, int audioSessionId )` Called when the audio session ID changes.
`void`	`@UnstableApi onAudioSinkError( AnalyticsListener.EventTime eventTime, Exception audioSinkError )` Called when `AudioSink` has encountered an error.
`void`	`@UnstableApi onAudioTrackInitialized( AnalyticsListener.EventTime eventTime, AudioSink.AudioTrackConfig audioTrackConfig )` Called when an `AudioTrack` has been initialized.
`void`	`@UnstableApi onAudioTrackReleased( AnalyticsListener.EventTime eventTime, AudioSink.AudioTrackConfig audioTrackConfig )` Called when an `AudioTrack` has been released.
`void`	`@UnstableApi onAudioUnderrun( AnalyticsListener.EventTime eventTime, int bufferSize, long bufferSizeMs, long elapsedSinceLastFeedMs )` Called when an audio underrun occurs.
`void`	`@UnstableApi onAvailableCommandsChanged( AnalyticsListener.EventTime eventTime, Player.Commands availableCommands )` Called when the player's available commands changed.
`void`	`@UnstableApi onCues(AnalyticsListener.EventTime eventTime, CueGroup cueGroup)` Called when there is a change in the `CueGroup`.
`void`	`@UnstableApi onCues(AnalyticsListener.EventTime eventTime, List<Cue> cues)` This method is deprecated. Use `onCues` instead.
`void`	`@UnstableApi onDeviceInfoChanged( AnalyticsListener.EventTime eventTime, DeviceInfo deviceInfo )` Called when the device information changes
`void`	`@UnstableApi onDeviceVolumeChanged( AnalyticsListener.EventTime eventTime, int volume, boolean muted )` Called when the device volume or mute state changes.
`void`	`@UnstableApi onDrmKeysLoaded(AnalyticsListener.EventTime eventTime)` Called each time drm keys are loaded.
`void`	`@UnstableApi onDrmKeysRemoved(AnalyticsListener.EventTime eventTime)` Called each time offline drm keys are removed.
`void`	`@UnstableApi onDrmKeysRestored(AnalyticsListener.EventTime eventTime)` Called each time offline drm keys are restored.
`void`	`@UnstableApi onDrmSessionAcquired(AnalyticsListener.EventTime eventTime)` This method is deprecated. Implement `onDrmSessionAcquired` instead.
`void`	`@UnstableApi onDrmSessionAcquired( AnalyticsListener.EventTime eventTime, @DrmSession.State int state )` Called each time a drm session is acquired.
`void`	`@UnstableApi onDrmSessionReleased(AnalyticsListener.EventTime eventTime)` Called each time a drm session is released.
`void`	`@UnstableApi onIsLoadingChanged( AnalyticsListener.EventTime eventTime, boolean isLoading )` Called when the player starts or stops loading data from a source.
`void`	`@UnstableApi onIsPlayingChanged( AnalyticsListener.EventTime eventTime, boolean isPlaying )` Called when the player starts or stops playing.
`void`	`@UnstableApi onLoadCanceled( AnalyticsListener.EventTime eventTime, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData )` Called when a media source canceled loading data.
`void`	`@UnstableApi onLoadCompleted( AnalyticsListener.EventTime eventTime, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData )` Called when a media source completed loading data.
`void`	`@UnstableApi onLoadStarted( AnalyticsListener.EventTime eventTime, LoadEventInfo loadEventInfo, MediaLoadData mediaLoadData )` Called when a media source started loading data.
`void`	`@UnstableApi onLoadingChanged( AnalyticsListener.EventTime eventTime, boolean isLoading )` This method is deprecated. Use `onIsLoadingChanged` instead.
`void`	`@UnstableApi onMaxSeekToPreviousPositionChanged( AnalyticsListener.EventTime eventTime, long maxSeekToPreviousPositionMs )` Called when the maximum position for which `seekToPrevious` seeks to the previous window changes.
`void`	`@UnstableApi onMediaItemTransition( AnalyticsListener.EventTime eventTime, @Nullable MediaItem mediaItem, @Player.MediaItemTransitionReason int reason )` Called when playback transitions to a different media item.
`void`	`@UnstableApi onMediaMetadataChanged( AnalyticsListener.EventTime eventTime, MediaMetadata mediaMetadata )` Called when the combined `MediaMetadata` changes.
`void`	`@UnstableApi onMetadata(AnalyticsListener.EventTime eventTime, Metadata metadata)` Called when there is `Metadata` associated with the current playback time.
`void`	`@UnstableApi onPlayWhenReadyChanged( AnalyticsListener.EventTime eventTime, boolean playWhenReady, @Player.PlayWhenReadyChangeReason int reason )` Called when the value changed that indicates whether playback will proceed when ready.
`void`	`@UnstableApi onPlaybackParametersChanged( AnalyticsListener.EventTime eventTime, PlaybackParameters playbackParameters )` Called when the playback parameters changed.
`void`	`@UnstableApi onPlaybackStateChanged( AnalyticsListener.EventTime eventTime, @Player.State int state )` Called when the playback state changed.
`void`	`@UnstableApi onPlaybackSuppressionReasonChanged( AnalyticsListener.EventTime eventTime, @Player.PlaybackSuppressionReason int playbackSuppressionReason )` Called when playback suppression reason changed.
`void`	`@UnstableApi onPlayerError( AnalyticsListener.EventTime eventTime, PlaybackException error )` Called when a fatal player error occurred.
`void`	`@UnstableApi onPlayerErrorChanged( AnalyticsListener.EventTime eventTime, @Nullable PlaybackException error )` Called when the `PlaybackException` returned by `getPlayerError` changes.
`void`	`@UnstableApi onPlayerReleased(AnalyticsListener.EventTime eventTime)` Called when the `Player` is released.
`void`	`@UnstableApi onPlayerStateChanged( AnalyticsListener.EventTime eventTime, boolean playWhenReady, @Player.State int playbackState )` This method is deprecated. Use `onPlaybackStateChanged` and `onPlayWhenReadyChanged` instead.
`void`	`@UnstableApi onPlaylistMetadataChanged( AnalyticsListener.EventTime eventTime, MediaMetadata playlistMetadata )` Called when the playlist `MediaMetadata` changes.
`void`	`@UnstableApi onPositionDiscontinuity( AnalyticsListener.EventTime eventTime, @Player.DiscontinuityReason int reason )` This method is deprecated. Use `onPositionDiscontinuity` instead.
`void`	`@UnstableApi onRenderedFirstFrame( AnalyticsListener.EventTime eventTime, Object output, long renderTimeMs )` Called when a frame is rendered for the first time since setting the surface, or since the renderer was reset, or since the stream being rendered was changed.
`void`	`@UnstableApi onRepeatModeChanged( AnalyticsListener.EventTime eventTime, @Player.RepeatMode int repeatMode )` Called when the repeat mode changed.
`void`	`@UnstableApi onSeekBackIncrementChanged( AnalyticsListener.EventTime eventTime, long seekBackIncrementMs )` Called when the seek back increment changed.
`void`	`@UnstableApi onSeekForwardIncrementChanged( AnalyticsListener.EventTime eventTime, long seekForwardIncrementMs )` Called when the seek forward increment changed.
`void`	`@UnstableApi onSeekStarted(AnalyticsListener.EventTime eventTime)` This method is deprecated. Use `onPositionDiscontinuity` instead, listening to changes with `DISCONTINUITY_REASON_SEEK`.
`void`	`@UnstableApi onShuffleModeChanged( AnalyticsListener.EventTime eventTime, boolean shuffleModeEnabled )` Called when the shuffle mode changed.
`void`	`@UnstableApi onSkipSilenceEnabledChanged( AnalyticsListener.EventTime eventTime, boolean skipSilenceEnabled )` Called when skipping silences is enabled or disabled in the audio stream.
`void`	`@UnstableApi onSurfaceSizeChanged( AnalyticsListener.EventTime eventTime, int width, int height )` Called when the output surface size changed.
`void`	`@UnstableApi onTimelineChanged( AnalyticsListener.EventTime eventTime, @Player.TimelineChangeReason int reason )` Called when the timeline changed.
`void`	`@UnstableApi onTrackSelectionParametersChanged( AnalyticsListener.EventTime eventTime, TrackSelectionParameters trackSelectionParameters )` Called when track selection parameters change.
`void`	`@UnstableApi onTracksChanged(AnalyticsListener.EventTime eventTime, Tracks tracks)` Called when the tracks change.
`void`	`@UnstableApi onUpstreamDiscarded( AnalyticsListener.EventTime eventTime, MediaLoadData mediaLoadData )` Called when data is removed from the back of a media buffer, typically so that it can be re-buffered in a different format.
`void`	`@UnstableApi onVideoCodecError( AnalyticsListener.EventTime eventTime, Exception videoCodecError )` Called when a video decoder encounters an error.
`void`	`@UnstableApi onVideoDecoderInitialized( AnalyticsListener.EventTime eventTime, String decoderName, long initializationDurationMs )` This method is deprecated. Use `onVideoDecoderInitialized`.
`void`	`@UnstableApi onVideoDecoderInitialized( AnalyticsListener.EventTime eventTime, String decoderName, long initializedTimestampMs, long initializationDurationMs )` Called when a video renderer creates a decoder.
`void`	`@UnstableApi onVideoDecoderReleased( AnalyticsListener.EventTime eventTime, String decoderName )` Called when a video renderer releases a decoder.
`void`	`@UnstableApi onVideoDisabled( AnalyticsListener.EventTime eventTime, DecoderCounters decoderCounters )` Called when a video renderer is disabled.
`void`	`@UnstableApi onVideoEnabled( AnalyticsListener.EventTime eventTime, DecoderCounters decoderCounters )` Called when a video renderer is enabled.
`void`	`@UnstableApi onVideoFrameProcessingOffset( AnalyticsListener.EventTime eventTime, long totalProcessingOffsetUs, int frameCount )` Called when there is an update to the video frame processing offset reported by a video renderer.
`void`	`@UnstableApi onVideoInputFormatChanged( AnalyticsListener.EventTime eventTime, Format format )` This method is deprecated. Use `onVideoInputFormatChanged`.
`void`	`@UnstableApi onVideoInputFormatChanged( AnalyticsListener.EventTime eventTime, Format format, @Nullable DecoderReuseEvaluation decoderReuseEvaluation )` Called when the format of the media being consumed by a video renderer changes.
`void`	`@UnstableApi onVideoSizeChanged( AnalyticsListener.EventTime eventTime, int width, int height, int unappliedRotationDegrees, float pixelWidthHeightRatio )` This method is deprecated. Implement `onVideoSizeChanged` instead.
`void`	`@UnstableApi onVolumeChanged(AnalyticsListener.EventTime eventTime, float volume)` Called when the volume changes.

Public constructors

PlaybackStatsListener

public PlaybackStatsListener(
    boolean keepHistory,
    @Nullable PlaybackStatsListener.Callback callback
)

Creates listener for playback stats.

Parameters
`boolean keepHistory`	Whether the reported `PlaybackStats` should keep the full history of events.
`@Nullable PlaybackStatsListener.Callback callback`	An optional callback for finished `PlaybackStats`.

Public methods

getCombinedPlaybackStats

public PlaybackStats getCombinedPlaybackStats()

Returns the combined PlaybackStats for all playback sessions this listener was and is listening to.

Note that these PlaybackStats will not contain the full history of events.

Returns
`PlaybackStats`	The combined `PlaybackStats` for all playback sessions.

getPlaybackStats

public @Nullable PlaybackStats getPlaybackStats()

Returns the PlaybackStats for the currently playback session, or null if no session is active.

Returns
`@Nullable PlaybackStats`	`PlaybackStats` for the current playback session.

onAdPlaybackStarted

public void onAdPlaybackStarted(
    AnalyticsListener.EventTime eventTime,
    String contentSessionId,
    String adSessionId
)

Called when a session is interrupted by ad playback.

Parameters
`AnalyticsListener.EventTime eventTime`	The `EventTime` at which the ad playback starts.
`String contentSessionId`	The session identifier of the content session.
`String adSessionId`	The identifier of the ad session.

onBandwidthEstimate

public void onBandwidthEstimate(
    AnalyticsListener.EventTime eventTime,
    int totalLoadTimeMs,
    long totalBytesLoaded,
    long bitrateEstimate
)

Called when the bandwidth estimate for the current data source has been updated.

Parameters
`AnalyticsListener.EventTime eventTime`	The event time.
`int totalLoadTimeMs`	The total time spend loading this update is based on, in milliseconds.
`long totalBytesLoaded`	The total bytes loaded this update is based on.
`long bitrateEstimate`	The bandwidth estimate, in bits per second.

onDownstreamFormatChanged

public void onDownstreamFormatChanged(
    AnalyticsListener.EventTime eventTime,
    MediaLoadData mediaLoadData
)

Called when the downstream format sent to the renderers changed.

Parameters
`AnalyticsListener.EventTime eventTime`	The event time.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the newly selected media data.

onDrmSessionManagerError

public void onDrmSessionManagerError(
    AnalyticsListener.EventTime eventTime,
    Exception error
)

Called when a drm error occurs.

This method being called does not indicate that playback has failed, or that it will fail. The player may be able to recover from the error. Hence applications should not implement this method to display a user visible error or initiate an application level retry. onPlayerError is the appropriate place to implement such behavior. This method is called to provide the application with an opportunity to log the error if it wishes to do so.

Parameters
`AnalyticsListener.EventTime eventTime`	The event time.
`Exception error`	The error.

onDroppedVideoFrames

public void onDroppedVideoFrames(
    AnalyticsListener.EventTime eventTime,
    int droppedFrames,
    long elapsedMs
)

Called after video frames have been dropped.

Parameters
`AnalyticsListener.EventTime eventTime`	The event time.
`int droppedFrames`	The number of dropped frames since the last call to this method.
`long elapsedMs`	The duration in milliseconds over which the frames were dropped. This duration is timed from when the renderer was started or from when dropped frames were last reported (whichever was more recent), and not from when the first of the reported drops occurred.

onEvents

public void onEvents(Player player, AnalyticsListener.Events events)

Called after one or more events occurred.

State changes and events that happen within one Looper message queue iteration are reported together and only after all individual callbacks were triggered.

Listeners should prefer this method over individual callbacks in the following cases:

They intend to trigger the same logic for multiple events (e.g. when updating a UI for both onPlaybackStateChanged and onPlayWhenReadyChanged).
They need access to the Player object to trigger further events (e.g. to call seekTo after a onMediaItemTransition).
They intend to use multiple state values together or in combination with Player getter methods. For example using getCurrentMediaItemIndex with the timeline provided in onTimelineChanged is only safe from within this method.
They are interested in events that logically happened together (e.g onPlaybackStateChanged to STATE_BUFFERING because of onMediaItemTransition).

Parameters
`Player player`	The `Player`.
`AnalyticsListener.Events events`	The `Events` that occurred in this iteration.

onLoadError

public void onLoadError(
    AnalyticsListener.EventTime eventTime,
    LoadEventInfo loadEventInfo,
    MediaLoadData mediaLoadData,
    IOException error,
    boolean wasCanceled
)

Called when a media source loading error occurred.

Parameters
`AnalyticsListener.EventTime eventTime`	The event time.
`LoadEventInfo loadEventInfo`	The `LoadEventInfo` defining the load event.
`MediaLoadData mediaLoadData`	The `MediaLoadData` defining the data being loaded.
`IOException error`	The load error.
`boolean wasCanceled`	Whether the load was canceled as a result of the error.

onPositionDiscontinuity

public void onPositionDiscontinuity(
    AnalyticsListener.EventTime eventTime,
    Player.PositionInfo oldPosition,
    Player.PositionInfo newPosition,
    @Player.DiscontinuityReason int reason
)

Called when a position discontinuity occurred.

Parameters
`AnalyticsListener.EventTime eventTime`	The event time.
`Player.PositionInfo oldPosition`	The position before the discontinuity.
`Player.PositionInfo newPosition`	The position after the discontinuity.
`@Player.DiscontinuityReason int reason`	The reason for the position discontinuity.

onSessionActive

public void onSessionActive(
    AnalyticsListener.EventTime eventTime,
    String sessionId
)

Called when a session becomes active, i.e. playing in the foreground.

Parameters
`AnalyticsListener.EventTime eventTime`	The `EventTime` at which the session becomes active.
`String sessionId`	The identifier of the session.

onSessionCreated

public void onSessionCreated(
    AnalyticsListener.EventTime eventTime,
    String sessionId
)

Called when a new session is created as a result of updateSessions.

Parameters
`AnalyticsListener.EventTime eventTime`	The `EventTime` at which the session is created.
`String sessionId`	The identifier of the new session.

onSessionFinished

public void onSessionFinished(
    AnalyticsListener.EventTime eventTime,
    String sessionId,
    boolean automaticTransitionToNextPlayback
)

Called when a session is permanently finished.

Parameters
`AnalyticsListener.EventTime eventTime`	The `EventTime` at which the session finished.
`String sessionId`	The identifier of the finished session.
`boolean automaticTransitionToNextPlayback`	Whether the session finished because of an automatic transition to the next playback item.

onVideoSizeChanged

public void onVideoSizeChanged(
    AnalyticsListener.EventTime eventTime,
    VideoSize videoSize
)

Called before a frame is rendered for the first time since setting the surface, and each time there's a change in the size or pixel aspect ratio of the video being rendered.

Parameters
`AnalyticsListener.EventTime eventTime`	The event time.
`VideoSize videoSize`	The new size of the video.

PlaybackStatsListener

Summary

Nested types

Public constructors

Public methods

Inherited Constants

Inherited methods

Public constructors

PlaybackStatsListener

Public methods

getCombinedPlaybackStats

getPlaybackStats

onAdPlaybackStarted

onBandwidthEstimate

onDownstreamFormatChanged

onDrmSessionManagerError

onDroppedVideoFrames

onEvents

onLoadError

onPositionDiscontinuity

onSessionActive

onSessionCreated

onSessionFinished

onVideoSizeChanged