PlaybackStats

public static final PlaybackStats EMPTY

Empty playback stats.

public static final int PLAYBACK_STATE_ABANDONED = 15

Playback is abandoned before reaching the end of the media.

public static final int PLAYBACK_STATE_BUFFERING = 6

Playback is buffering to resume active playback.

public static final int PLAYBACK_STATE_ENDED = 11

Playback has reached the end of the media.

public static final int PLAYBACK_STATE_FAILED = 13

Playback is stopped due a fatal error and can be retried.

public static final int PLAYBACK_STATE_INTERRUPTED_BY_AD = 14

Playback is interrupted by an ad.

public static final int PLAYBACK_STATE_JOINING_BACKGROUND = 1

Playback is buffering in the background for initial playback start.

public static final int PLAYBACK_STATE_JOINING_FOREGROUND = 2

Playback is buffering in the foreground for initial playback start.

public static final int PLAYBACK_STATE_NOT_STARTED = 0

Playback has not started (initial state).

public static final int PLAYBACK_STATE_PAUSED = 4

Playback is paused but ready to play.

public static final int PLAYBACK_STATE_PAUSED_BUFFERING = 7

Playback is buffering while paused.

public static final int PLAYBACK_STATE_PLAYING = 3

Playback is actively playing.

public static final int PLAYBACK_STATE_SEEKING = 5

Playback is handling a seek.

public static final int PLAYBACK_STATE_STOPPED = 12

Playback is stopped and can be restarted.

public static final int PLAYBACK_STATE_SUPPRESSED = 9

Playback is suppressed (e.g. due to audio focus loss).

public static final int PLAYBACK_STATE_SUPPRESSED_BUFFERING = 10

Playback is suppressed (e.g. due to audio focus loss) while buffering to resume a playback.

public final int abandonedBeforeReadyCount

The number of playbacks which were abandoned before they were ready to play.

public final int adPlaybackCount

The number of ad playbacks.

public final List<PlaybackStats.EventTimeAndFormat> audioFormatHistory

The audio format history as EventTimeAndFormats ordered by EventTime.realTimeMs. The Format may be null if no audio format was used.

public final int backgroundJoiningCount

The number of playbacks which were pre-buffered in the background.

public final int endedCount

The number of playbacks which reached the ended state at least once.

public final int fatalErrorCount

The total number of fatal errors. Errors are fatal if playback stopped due to this error.

public final List<PlaybackStats.EventTimeAndException> fatalErrorHistory

The history of fatal errors as EventTimeAndExceptions ordered by EventTime.realTimeMs. Errors are fatal if playback stopped due to this error.

public final int fatalErrorPlaybackCount

The total number of playback with at least one fatal error. Errors are fatal if playback stopped due to this error.

public final long firstReportedTimeMs

The elapsed real-time as returned by SystemClock.elapsedRealtime() of the first reported playback event, or TIME_UNSET if no event has been reported.

public final int foregroundPlaybackCount

The number of playbacks which were the active foreground playback at some point.

public final int initialAudioFormatBitrateCount

The number of playbacks with initial audio format bitrate data.

public final int initialVideoFormatBitrateCount

The number of playbacks with initial video format bitrate data.

public final int initialVideoFormatHeightCount

The number of playbacks with initial video format height data.

public final long maxRebufferTimeMs

The maximum time spent during a single rebuffer, in milliseconds, or TIME_UNSET if no rebuffer occurred.

public final List<long[]> mediaTimeHistory

The media time history as an ordered list of long[2] arrays with [0] being the realtime as returned by SystemClock.elapsedRealtime() and [1] being the media time at this realtime, in milliseconds.

public final int nonFatalErrorCount

The total number of non-fatal errors. Error are non-fatal if playback can recover from the error without stopping.

public final List<PlaybackStats.EventTimeAndException> nonFatalErrorHistory

The history of non-fatal errors as EventTimeAndExceptions ordered by EventTime.realTimeMs. Errors are non-fatal if playback can recover from the error without stopping.

public final int playbackCount

The number of individual playbacks for which these stats were collected.

public final List<PlaybackStats.EventTimeAndPlaybackState> playbackStateHistory

The playback state history as EventTimeAndPlaybackStates ordered by EventTime.realTimeMs.

public final long totalAudioFormatBitrateTimeProduct

The accumulated sum of all audio format bitrates, in bits per second, times the time the format was used for playback, in milliseconds.

public final long totalAudioFormatTimeMs

The total media time for which audio format data is available, in milliseconds.

public final long totalAudioUnderruns

The total number of audio underruns.

public final long totalBandwidthBytes

The total bytes transferred during totalBandwidthTimeMs.

public final long totalBandwidthTimeMs

The total time for which bandwidth measurement data is available, in milliseconds.

public final long totalDroppedFrames

The total number of dropped video frames.

public final long totalInitialAudioFormatBitrate

The total initial audio format bitrate for all playbacks, in bits per second, or LENGTH_UNSET if no initial audio format data is available.

public final long totalInitialVideoFormatBitrate

The total initial video format bitrate for all playbacks, in bits per second, or LENGTH_UNSET if no initial video format data is available.

public final int totalInitialVideoFormatHeight

The total initial video format height for all playbacks, in pixels, or LENGTH_UNSET if no initial video format data is available.

public final int totalPauseBufferCount

The total number of times a playback has been paused while rebuffering.

public final int totalPauseCount

The total number of times a playback has been paused.

public final int totalRebufferCount

The total number of times a rebuffer occurred. This excludes initial joining and buffering after seek.

public final int totalSeekCount

The total number of times a seek occurred. This includes seeks happening before playback resumed after another seek.

public final long totalValidJoinTimeMs

The total time spent joining the playback, in milliseconds, or TIME_UNSET if no valid join time could be determined.

Note that this does not include background joining time. A join time may be invalid if the playback never reached PLAYBACK_STATE_PLAYING or PLAYBACK_STATE_PAUSED, or joining was interrupted by a seek, stop, or error state.

public final long totalVideoFormatBitrateTimeMs

The total media time for which video format bitrate data is available, in milliseconds.

public final long totalVideoFormatBitrateTimeProduct

The accumulated sum of all video format bitrates, in bits per second, times the time the format was used for playback, in milliseconds.

public final long totalVideoFormatHeightTimeMs

The total media time for which video format height data is available, in milliseconds.

public final long totalVideoFormatHeightTimeProduct

The accumulated sum of all video format heights, in pixels, times the time the format was used for playback, in milliseconds.

public final int validJoinTimeCount

The number of playbacks with a valid join time as documented in totalValidJoinTimeMs.

public final List<PlaybackStats.EventTimeAndFormat> videoFormatHistory

The video format history as EventTimeAndFormats ordered by EventTime.realTimeMs. The Format may be null if no video format was used.

public float getAbandonedBeforeReadyRatio()

Returns the ratio of foreground playbacks which were abandoned before they were ready to play, or 0.0 if no playback has been in foreground.

public float getAudioUnderrunRate()

Returns the mean rate at which audio underruns occurred, in underruns per play time second, or 0.0 if no time was spent playing.

public float getDroppedFramesRate()

Returns the mean rate at which video frames are dropped, in dropped frames per play time second, or 0.0 if no time was spent playing.

public float getEndedRatio()

Returns the ratio of foreground playbacks which reached the ended state at least once, or 0.0 if no playback has been in foreground.

public float getFatalErrorRate()

Returns the rate of fatal errors, in errors per play time second, or 0.0 if no time was spend playing. This is equivalent to 1.0 / getMeanTimeBetweenFatalErrors.

public float getFatalErrorRatio()

Returns the ratio of foreground playbacks which experienced fatal errors, or 0.0 if no playback has been in foreground.

public float getJoinTimeRatio()

Returns the ratio of foreground join time to the total time spent playing and waiting, or 0.0 if no time was spend playing or waiting. This is equivalent to getTotalJoinTimeMs / getTotalPlayAndWaitTimeMs.

public int getMeanAudioFormatBitrate()

Returns the mean audio format bitrate, in bits per second, or LENGTH_UNSET if no audio format data is available. This is a weighted average taking the time the format was used for playback into account.

public int getMeanBandwidth()

Returns the mean network bandwidth based on transfer measurements, in bits per second, or LENGTH_UNSET if no transfer data is available.

public long getMeanElapsedTimeMs()

Returns the mean time covered by any playback state per playback, in milliseconds, or TIME_UNSET if no playback was recorded.

public int getMeanInitialAudioFormatBitrate()

Returns the mean initial audio format bitrate, in bits per second, or LENGTH_UNSET if no audio format data is available.

public int getMeanInitialVideoFormatBitrate()

Returns the mean initial video format bitrate, in bits per second, or LENGTH_UNSET if no video format data is available.

public int getMeanInitialVideoFormatHeight()

Returns the mean initial video format height, in pixels, or LENGTH_UNSET if no video format data is available.

public long getMeanJoinTimeMs()

Returns the mean time spent joining the playback, in milliseconds, or TIME_UNSET if no valid join time is available. Only includes playbacks with valid join times as documented in totalValidJoinTimeMs.

public float getMeanNonFatalErrorCount()

Returns the mean number of non-fatal errors per foreground playback, or 0.0 if no playback has been in foreground.

public float getMeanPauseBufferCount()

Returns the mean number of times a playback has been paused while rebuffering per foreground playback, or 0.0 if no playback has been in foreground.

public float getMeanPauseCount()

Returns the mean number of times a playback has been paused per foreground playback, or 0.0 if no playback has been in foreground.

public long getMeanPausedTimeMs()

Returns the mean time spent in a paused state per foreground playback, in milliseconds, or TIME_UNSET if no playback has been in foreground.

public long getMeanPlayAndWaitTimeMs()

Returns the mean time spent playing or actively waiting for playback per foreground playback, in milliseconds, or TIME_UNSET if no playback has been in foreground.

public long getMeanPlayTimeMs()

Returns the mean time spent actively playing per foreground playback, in milliseconds, or TIME_UNSET if no playback has been in foreground.

public float getMeanRebufferCount()

Returns the mean number of times a rebuffer occurred per foreground playback, or 0.0 if no playback has been in foreground. This excludes initial joining and buffering after seek.

public long getMeanRebufferTimeMs()

Returns the mean time spent rebuffering per foreground playback, in milliseconds, or TIME_UNSET if no playback has been in foreground. This excludes initial join times, buffer times after a seek and buffering while paused.

public float getMeanSeekCount()

Returns the mean number of times a seek occurred per foreground playback, or 0.0 if no playback has been in foreground. This includes seeks happening before playback resumed after another seek.

public long getMeanSeekTimeMs()

Returns the mean time spent per foreground playback from the start of a seek until playback is ready again, in milliseconds, or TIME_UNSET if no playback has been in foreground.

public long getMeanSingleRebufferTimeMs()

Returns the mean time spent during a single rebuffer, in milliseconds, or TIME_UNSET if no rebuffer was recorded. This excludes initial join times and buffer times after a seek.

public long getMeanSingleSeekTimeMs()

Returns the mean time spent from the start of a single seek until playback is ready again, in milliseconds, or TIME_UNSET if no seek occurred.

public float getMeanTimeBetweenFatalErrors()

Returns the mean play time between fatal errors, in seconds. This is equivalent to 1.0 / getFatalErrorRate. Note that this may return POSITIVE_INFINITY.

public float getMeanTimeBetweenNonFatalErrors()

Returns the mean play time between non-fatal errors, in seconds. This is equivalent to 1.0 / getNonFatalErrorRate. Note that this may return POSITIVE_INFINITY.

public float getMeanTimeBetweenRebuffers()

Returns the mean play time between rebuffer events, in seconds. This is equivalent to 1.0 / getRebufferRate. Note that this may return POSITIVE_INFINITY.

public int getMeanVideoFormatBitrate()

Returns the mean video format bitrate, in bits per second, or LENGTH_UNSET if no video format data is available. This is a weighted average taking the time the format was used for playback into account.

public int getMeanVideoFormatHeight()

Returns the mean video format height, in pixels, or LENGTH_UNSET if no video format data is available. This is a weighted average taking the time the format was used for playback into account.

public long getMeanWaitTimeMs()

Returns the mean time spent actively waiting for playback per foreground playback, in milliseconds, or TIME_UNSET if no playback has been in foreground. This includes all join times, rebuffer times and seek times, but excludes times without user intention to play, e.g. all paused states.

public long getMediaTimeMsAtRealtimeMs(long realtimeMs)

Returns the estimated media time at the given realtime, in milliseconds, or TIME_UNSET if the media time history is unknown.

public float getNonFatalErrorRate()

Returns the rate of non-fatal errors, in errors per play time second, or 0.0 if no time was spend playing. This is equivalent to 1.0 / getMeanTimeBetweenNonFatalErrors.

public int getPlaybackStateAtTime(long realtimeMs)

Returns the PlaybackState at the given time.

public long getPlaybackStateDurationMs(int playbackState)

Returns the total time spent in a given PlaybackState, in milliseconds.

public float getRebufferRate()

Returns the rate of rebuffer events, in rebuffers per play time second, or 0.0 if no time was spend playing. This is equivalent to 1.0 / getMeanTimeBetweenRebuffers.

public float getRebufferTimeRatio()

Returns the ratio of rebuffer time to the total time spent playing and waiting, or 0.0 if no time was spend playing or waiting. This is equivalent to getTotalRebufferTimeMs / getTotalPlayAndWaitTimeMs.

public float getSeekTimeRatio()

Returns the ratio of seek time to the total time spent playing and waiting, or 0.0 if no time was spend playing or waiting. This is equivalent to getTotalSeekTimeMs / getTotalPlayAndWaitTimeMs.

public long getTotalElapsedTimeMs()

Returns the total time covered by any playback state, in milliseconds.

public long getTotalJoinTimeMs()

Returns the total time spent joining the playback in foreground, in milliseconds. This does include invalid join times where the playback never reached PLAYBACK_STATE_PLAYING or PLAYBACK_STATE_PAUSED, or joining was interrupted by a seek, stop, or error state.

public long getTotalPausedTimeMs()

Returns the total time spent in a paused state, in milliseconds.

public long getTotalPlayAndWaitTimeMs()

Returns the total time spent playing or actively waiting for playback, in milliseconds.

public long getTotalPlayTimeMs()

Returns the total time spent actively playing, in milliseconds.

public long getTotalRebufferTimeMs()

Returns the total time spent rebuffering, in milliseconds. This excludes initial join times, buffer times after a seek and buffering while paused.

public long getTotalSeekTimeMs()

Returns the total time spent from the start of a seek until playback is ready again, in milliseconds.

public long getTotalWaitTimeMs()

Returns the total time spent actively waiting for playback, in milliseconds. This includes all join times, rebuffer times and seek times, but excludes times without user intention to play, e.g. all paused states.

public float getWaitTimeRatio()

Returns the ratio of wait times to the total time spent playing and waiting, or 0.0 if no time was spend playing or waiting. This is equivalent to getTotalWaitTimeMs / getTotalPlayAndWaitTimeMs and also to getJoinTimeRatio + getRebufferTimeRatio + getSeekTimeRatio.

public static PlaybackStats merge(PlaybackStats[] playbackStats)

Returns the combined PlaybackStats for all input PlaybackStats.

Note that the full history of events is not kept as the history only makes sense in the context of a single playback.