com.google.android.exoplayer2.analytics

Interface AnalyticsListener

All Known Implementing Classes:

DefaultAnalyticsListener, EventLogger

public interface AnalyticsListener

A listener for analytics events.

All events are recorded with an AnalyticsListener.EventTime specifying the elapsed real time and media time at the time of the event.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	AnalyticsListener.EventTime Time information of an event.

Method Summary

Modifier and Type	Method and Description
void	onAudioSessionId(AnalyticsListener.EventTime eventTime, int audioSessionId) Called when the audio session id is set.
void	onAudioUnderrun(AnalyticsListener.EventTime eventTime, int bufferSize, long bufferSizeMs, long elapsedSinceLastFeedMs) Called when an audio underrun occurred.
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	onDecoderDisabled(AnalyticsListener.EventTime eventTime, int trackType, DecoderCounters decoderCounters) Called when an audio or video decoder has been disabled.
void	onDecoderEnabled(AnalyticsListener.EventTime eventTime, int trackType, DecoderCounters decoderCounters) Called when an audio or video decoder has been enabled.
void	onDecoderInitialized(AnalyticsListener.EventTime eventTime, int trackType, java.lang.String decoderName, long initializationDurationMs) Called when an audio or video decoder has been initialized.
void	onDecoderInputFormatChanged(AnalyticsListener.EventTime eventTime, int trackType, Format format) Called when an audio or video decoder input format changed.
void	onDownstreamFormatChanged(AnalyticsListener.EventTime eventTime, MediaSourceEventListener.MediaLoadData mediaLoadData) Called when the downstream format sent to the renderers changed.
void	onDrmKeysLoaded(AnalyticsListener.EventTime eventTime) Called each time drm keys are loaded.
void	onDrmKeysRemoved(AnalyticsListener.EventTime eventTime) Called each time offline drm keys are removed.
void	onDrmKeysRestored(AnalyticsListener.EventTime eventTime) Called each time offline drm keys are restored.
void	onDrmSessionManagerError(AnalyticsListener.EventTime eventTime, java.lang.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	onLoadCanceled(AnalyticsListener.EventTime eventTime, MediaSourceEventListener.LoadEventInfo loadEventInfo, MediaSourceEventListener.MediaLoadData mediaLoadData) Called when a media source canceled loading data.
void	onLoadCompleted(AnalyticsListener.EventTime eventTime, MediaSourceEventListener.LoadEventInfo loadEventInfo, MediaSourceEventListener.MediaLoadData mediaLoadData) Called when a media source completed loading data.
void	onLoadError(AnalyticsListener.EventTime eventTime, MediaSourceEventListener.LoadEventInfo loadEventInfo, MediaSourceEventListener.MediaLoadData mediaLoadData, java.io.IOException error, boolean wasCanceled) Called when a media source loading error occurred.
void	onLoadingChanged(AnalyticsListener.EventTime eventTime, boolean isLoading) Called when the player starts or stops loading data from a source.
void	onLoadStarted(AnalyticsListener.EventTime eventTime, MediaSourceEventListener.LoadEventInfo loadEventInfo, MediaSourceEventListener.MediaLoadData mediaLoadData) Called when a media source started loading data.
void	onMediaPeriodCreated(AnalyticsListener.EventTime eventTime) Called when a media source created a media period.
void	onMediaPeriodReleased(AnalyticsListener.EventTime eventTime) Called when a media source released a media period.
void	onMetadata(AnalyticsListener.EventTime eventTime, Metadata metadata) Called when there is Metadata associated with the current playback time.
void	onNetworkTypeChanged(AnalyticsListener.EventTime eventTime, android.net.NetworkInfo networkInfo) Called when the type of the network connection changed.
void	onPlaybackParametersChanged(AnalyticsListener.EventTime eventTime, PlaybackParameters playbackParameters) Called when the playback parameters changed.
void	onPlayerError(AnalyticsListener.EventTime eventTime, ExoPlaybackException error) Called when a fatal player error occurred.
void	onPlayerStateChanged(AnalyticsListener.EventTime eventTime, boolean playWhenReady, int playbackState) Called when the player state changed.
void	onPositionDiscontinuity(AnalyticsListener.EventTime eventTime, int reason) Called when a position discontinuity occurred.
void	onReadingStarted(AnalyticsListener.EventTime eventTime) Called when the player started reading a media period.
void	onRenderedFirstFrame(AnalyticsListener.EventTime eventTime, android.view.Surface surface) Called when a frame is rendered for the first time since setting the surface, and when a frame is rendered for the first time since the renderer was reset.
void	onRepeatModeChanged(AnalyticsListener.EventTime eventTime, int repeatMode) Called when the repeat mode changed.
void	onSeekProcessed(AnalyticsListener.EventTime eventTime) Called when a seek operation was processed.
void	onSeekStarted(AnalyticsListener.EventTime eventTime) Called when a seek operation started.
void	onShuffleModeChanged(AnalyticsListener.EventTime eventTime, boolean shuffleModeEnabled) Called when the shuffle mode changed.
void	onTimelineChanged(AnalyticsListener.EventTime eventTime, int reason) Called when the timeline changed.
void	onTracksChanged(AnalyticsListener.EventTime eventTime, TrackGroupArray trackGroups, TrackSelectionArray trackSelections) Called when the available or selected tracks for the renderers changed.
void	onUpstreamDiscarded(AnalyticsListener.EventTime eventTime, MediaSourceEventListener.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	onVideoSizeChanged(AnalyticsListener.EventTime eventTime, int width, int height, int unappliedRotationDegrees, float pixelWidthHeightRatio) 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.
void	onViewportSizeChange(AnalyticsListener.EventTime eventTime, int width, int height) Called when the viewport size of the output surface changed.

Method Detail

onPlayerStateChanged

void onPlayerStateChanged(AnalyticsListener.EventTime eventTime,
                          boolean playWhenReady,
                          int playbackState)

Called when the player state changed.

Parameters:

eventTime - The event time.

playWhenReady - Whether the playback will proceed when ready.

playbackState - One of the Player.STATE constants.

onTimelineChanged

void onTimelineChanged(AnalyticsListener.EventTime eventTime,
                       int reason)

Called when the timeline changed.

Parameters:

eventTime - The event time.

reason - The reason for the timeline change.

onPositionDiscontinuity

void onPositionDiscontinuity(AnalyticsListener.EventTime eventTime,
                             int reason)

Called when a position discontinuity occurred.

Parameters:

eventTime - The event time.

reason - The reason for the position discontinuity.

onSeekStarted

void onSeekStarted(AnalyticsListener.EventTime eventTime)

Called when a seek operation started.

Parameters:

eventTime - The event time.

onSeekProcessed

void onSeekProcessed(AnalyticsListener.EventTime eventTime)

Called when a seek operation was processed.

Parameters:

eventTime - The event time.

onPlaybackParametersChanged

void onPlaybackParametersChanged(AnalyticsListener.EventTime eventTime,
                                 PlaybackParameters playbackParameters)

Called when the playback parameters changed.

Parameters:

eventTime - The event time.

playbackParameters - The new playback parameters.

onRepeatModeChanged

void onRepeatModeChanged(AnalyticsListener.EventTime eventTime,
                         int repeatMode)

Called when the repeat mode changed.

Parameters:

eventTime - The event time.

repeatMode - The new repeat mode.

onShuffleModeChanged

void onShuffleModeChanged(AnalyticsListener.EventTime eventTime,
                          boolean shuffleModeEnabled)

Called when the shuffle mode changed.

Parameters:

eventTime - The event time.

shuffleModeEnabled - Whether the shuffle mode is enabled.

onLoadingChanged

void onLoadingChanged(AnalyticsListener.EventTime eventTime,
                      boolean isLoading)

Called when the player starts or stops loading data from a source.

Parameters:

eventTime - The event time.

isLoading - Whether the player is loading.

onPlayerError

void onPlayerError(AnalyticsListener.EventTime eventTime,
                   ExoPlaybackException error)

Called when a fatal player error occurred.

Parameters:

eventTime - The event time.

error - The error.

onTracksChanged

void onTracksChanged(AnalyticsListener.EventTime eventTime,
                     TrackGroupArray trackGroups,
                     TrackSelectionArray trackSelections)

Called when the available or selected tracks for the renderers changed.

Parameters:

eventTime - The event time.

trackGroups - The available tracks. May be empty.

trackSelections - The track selections for each renderer. May contain null elements.

onLoadStarted

void onLoadStarted(AnalyticsListener.EventTime eventTime,
                   MediaSourceEventListener.LoadEventInfo loadEventInfo,
                   MediaSourceEventListener.MediaLoadData mediaLoadData)

Called when a media source started loading data.

Parameters:

eventTime - The event time.

loadEventInfo - The MediaSourceEventListener.LoadEventInfo defining the load event.

mediaLoadData - The MediaSourceEventListener.MediaLoadData defining the data being loaded.

onLoadCompleted

void onLoadCompleted(AnalyticsListener.EventTime eventTime,
                     MediaSourceEventListener.LoadEventInfo loadEventInfo,
                     MediaSourceEventListener.MediaLoadData mediaLoadData)

Called when a media source completed loading data.

Parameters:

eventTime - The event time.

loadEventInfo - The MediaSourceEventListener.LoadEventInfo defining the load event.

mediaLoadData - The MediaSourceEventListener.MediaLoadData defining the data being loaded.

onLoadCanceled

void onLoadCanceled(AnalyticsListener.EventTime eventTime,
                    MediaSourceEventListener.LoadEventInfo loadEventInfo,
                    MediaSourceEventListener.MediaLoadData mediaLoadData)

Called when a media source canceled loading data.

Parameters:

eventTime - The event time.

loadEventInfo - The MediaSourceEventListener.LoadEventInfo defining the load event.

mediaLoadData - The MediaSourceEventListener.MediaLoadData defining the data being loaded.

onLoadError

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

Called when a media source loading error occurred. These errors are just for informational purposes and the player may recover.

Parameters:

eventTime - The event time.

loadEventInfo - The MediaSourceEventListener.LoadEventInfo defining the load event.

mediaLoadData - The MediaSourceEventListener.MediaLoadData defining the data being loaded.

error - The load error.

wasCanceled - Whether the load was canceled as a result of the error.

onDownstreamFormatChanged

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

Called when the downstream format sent to the renderers changed.

Parameters:

eventTime - The event time.

mediaLoadData - The MediaSourceEventListener.MediaLoadData defining the newly selected media data.

onUpstreamDiscarded

void onUpstreamDiscarded(AnalyticsListener.EventTime eventTime,
                         MediaSourceEventListener.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.

Parameters:

eventTime - The event time.

mediaLoadData - The MediaSourceEventListener.MediaLoadData defining the media being discarded.

onMediaPeriodCreated

void onMediaPeriodCreated(AnalyticsListener.EventTime eventTime)

Called when a media source created a media period.

Parameters:

eventTime - The event time.

onMediaPeriodReleased

void onMediaPeriodReleased(AnalyticsListener.EventTime eventTime)

Called when a media source released a media period.

Parameters:

eventTime - The event time.

onReadingStarted

void onReadingStarted(AnalyticsListener.EventTime eventTime)

Called when the player started reading a media period.

Parameters:

eventTime - The event time.

onBandwidthEstimate

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:

eventTime - The event time.

totalLoadTimeMs - The total time spend loading this update is based on, in milliseconds.

totalBytesLoaded - The total bytes loaded this update is based on.

bitrateEstimate - The bandwidth estimate, in bits per second.

onViewportSizeChange

void onViewportSizeChange(AnalyticsListener.EventTime eventTime,
                          int width,
                          int height)

Called when the viewport size of the output surface changed.

Parameters:

eventTime - The event time.

width - The width of the viewport in device-independent pixels (dp).

height - The height of the viewport in device-independent pixels (dp).

onNetworkTypeChanged

void onNetworkTypeChanged(AnalyticsListener.EventTime eventTime,
                          @Nullable
                          android.net.NetworkInfo networkInfo)

Called when the type of the network connection changed.

Parameters:

eventTime - The event time.

networkInfo - The network info for the current connection, or null if disconnected.

onMetadata

void onMetadata(AnalyticsListener.EventTime eventTime,
                Metadata metadata)

Called when there is Metadata associated with the current playback time.

Parameters:

eventTime - The event time.

metadata - The metadata.

onDecoderEnabled

void onDecoderEnabled(AnalyticsListener.EventTime eventTime,
                      int trackType,
                      DecoderCounters decoderCounters)

Called when an audio or video decoder has been enabled.

Parameters:

eventTime - The event time.

trackType - The track type of the enabled decoder. Either C.TRACK_TYPE_AUDIO or C.TRACK_TYPE_VIDEO.

decoderCounters - The accumulated event counters associated with this decoder.

onDecoderInitialized

void onDecoderInitialized(AnalyticsListener.EventTime eventTime,
                          int trackType,
                          java.lang.String decoderName,
                          long initializationDurationMs)

Called when an audio or video decoder has been initialized.

Parameters:

eventTime - The event time.

trackType - The track type of the initialized decoder. Either C.TRACK_TYPE_AUDIO or C.TRACK_TYPE_VIDEO.

decoderName - The decoder that was created.

initializationDurationMs - Time taken to initialize the decoder, in milliseconds.

onDecoderInputFormatChanged

void onDecoderInputFormatChanged(AnalyticsListener.EventTime eventTime,
                                 int trackType,
                                 Format format)

Called when an audio or video decoder input format changed.

Parameters:

eventTime - The event time.

trackType - The track type of the decoder whose format changed. Either C.TRACK_TYPE_AUDIO or C.TRACK_TYPE_VIDEO.

format - The new input format for the decoder.

onDecoderDisabled

void onDecoderDisabled(AnalyticsListener.EventTime eventTime,
                       int trackType,
                       DecoderCounters decoderCounters)

Called when an audio or video decoder has been disabled.

Parameters:

eventTime - The event time.

trackType - The track type of the disabled decoder. Either C.TRACK_TYPE_AUDIO or C.TRACK_TYPE_VIDEO.

decoderCounters - The accumulated event counters associated with this decoder.

onAudioSessionId

void onAudioSessionId(AnalyticsListener.EventTime eventTime,
                      int audioSessionId)

Called when the audio session id is set.

Parameters:

eventTime - The event time.

audioSessionId - The audio session id.

onAudioUnderrun

void onAudioUnderrun(AnalyticsListener.EventTime eventTime,
                     int bufferSize,
                     long bufferSizeMs,
                     long elapsedSinceLastFeedMs)

Called when an audio underrun occurred.

Parameters:

eventTime - The event time.

bufferSize - The size of the AudioSink's buffer, in bytes.

bufferSizeMs - The size of the AudioSink's buffer, in milliseconds, if it is configured for PCM output. C.TIME_UNSET if it is configured for passthrough output, as the buffered media can have a variable bitrate so the duration may be unknown.

elapsedSinceLastFeedMs - The time since the AudioSink was last fed data.

onDroppedVideoFrames

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

Called after video frames have been dropped.

Parameters:

eventTime - The event time.

droppedFrames - The number of dropped frames since the last call to this method.

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.

onVideoSizeChanged

void onVideoSizeChanged(AnalyticsListener.EventTime eventTime,
                        int width,
                        int height,
                        int unappliedRotationDegrees,
                        float pixelWidthHeightRatio)

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:

eventTime - The event time.

width - The width of the video.

height - The height of the video.

unappliedRotationDegrees - For videos that require a rotation, this is the clockwise rotation in degrees that the application should apply for the video for it to be rendered in the correct orientation. This value will always be zero on API levels 21 and above, since the renderer will apply all necessary rotations internally.

pixelWidthHeightRatio - The width to height ratio of each pixel.

onRenderedFirstFrame

void onRenderedFirstFrame(AnalyticsListener.EventTime eventTime,
                          android.view.Surface surface)

Called when a frame is rendered for the first time since setting the surface, and when a frame is rendered for the first time since the renderer was reset.

Parameters:

eventTime - The event time.

surface - The Surface to which a first frame has been rendered, or null if the renderer renders to something that isn't a Surface.

onDrmKeysLoaded

void onDrmKeysLoaded(AnalyticsListener.EventTime eventTime)

Called each time drm keys are loaded.

Parameters:

eventTime - The event time.

onDrmSessionManagerError

void onDrmSessionManagerError(AnalyticsListener.EventTime eventTime,
                              java.lang.Exception error)

Called when a drm error occurs. These errors are just for informational purposes and the player may recover.

Parameters:

eventTime - The event time.

error - The error.

onDrmKeysRestored

void onDrmKeysRestored(AnalyticsListener.EventTime eventTime)

Called each time offline drm keys are restored.

Parameters:

eventTime - The event time.

onDrmKeysRemoved

void onDrmKeysRemoved(AnalyticsListener.EventTime eventTime)

Called each time offline drm keys are removed.

Parameters:

eventTime - The event time.