Stay organized with collections Save and categorize content based on your preferences.

PlaybackStats

@UnstableApi
class PlaybackStats


Statistics about playbacks.

Summary

Nested types

class PlaybackStats.EventTimeAndException

Stores an exception with the event time at which it occurred.

class PlaybackStats.EventTimeAndFormat

Stores a format with the event time at which it started being used, or null to indicate that no format was used.

class PlaybackStats.EventTimeAndPlaybackState

Stores a playback state with the event time at which it became active.

Constants

const PlaybackStats!

Empty playback stats.

const Int

Playback is abandoned before reaching the end of the media.

const Int

Playback is buffering to resume active playback.

const Int

Playback has reached the end of the media.

const Int

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

const Int

Playback is interrupted by an ad.

const Int

Playback is buffering in the background for initial playback start.

const Int

Playback is buffering in the foreground for initial playback start.

const Int

Playback has not started (initial state).

const Int

Playback is paused but ready to play.

const Int

Playback is buffering while paused.

const Int

Playback is actively playing.

const Int

Playback is handling a seek.

const Int

Playback is stopped and can be restarted.

const Int

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

const Int

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

Public constructors

Public functions

Float

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.

Float

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

Float

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.

Float

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

Float

Returns the rate of fatal errors, in errors per play time second, or 0.0 if no time was spend playing.

Float

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

Float

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.

Int

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

Int

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

Long

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

Int

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

Int

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

Int

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

Long

Returns the mean time spent joining the playback, in milliseconds, or TIME_UNSET if no valid join time is available.

Float

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

Float

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.

Float

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

Long

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

Long

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.

Long

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

Float

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

Long

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

Float

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

Long

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.

Long

Returns the mean time spent during a single rebuffer, in milliseconds, or TIME_UNSET if no rebuffer was recorded.

Long

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.

Float

Returns the mean play time between fatal errors, in seconds.

Float

Returns the mean play time between non-fatal errors, in seconds.

Float

Returns the mean play time between rebuffer events, in seconds.

Int

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

Int

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

Long

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

Long

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

Float

Returns the rate of non-fatal errors, in errors per play time second, or 0.0 if no time was spend playing.

Int

Returns the PlaybackState at the given time.

Long

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

Float

Returns the rate of rebuffer events, in rebuffers per play time second, or 0.0 if no time was spend playing.

Float

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.

Float

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.

Long

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

Long

Returns the total time spent joining the playback in foreground, in milliseconds.

Long

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

Long

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

Long

Returns the total time spent actively playing, in milliseconds.

Long

Returns the total time spent rebuffering, in milliseconds.

Long

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

Long

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

Float

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.

java-static PlaybackStats!
merge(playbackStats: Array<PlaybackStats!>!)

Returns the combined PlaybackStats for all input PlaybackStats.

Public properties

Int

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

Int

The number of ad playbacks.

(Mutable)List<PlaybackStats.EventTimeAndFormat!>!

The audio format history as EventTimeAndFormats ordered by EventTime.realTimeMs.

Int

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

Int

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

Int

The total number of fatal errors.

(Mutable)List<PlaybackStats.EventTimeAndException!>!

The history of fatal errors as EventTimeAndExceptions ordered by EventTime.realTimeMs.

Int

The total number of playback with at least one fatal error.

Long

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

Int

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

Int

The number of playbacks with initial audio format bitrate data.

Int

The number of playbacks with initial video format bitrate data.

Int

The number of playbacks with initial video format height data.

Long

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

(Mutable)List<LongArray<Long>!>!

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.

Int

The total number of non-fatal errors.

(Mutable)List<PlaybackStats.EventTimeAndException!>!

The history of non-fatal errors as EventTimeAndExceptions ordered by EventTime.realTimeMs.

Int

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

(Mutable)List<PlaybackStats.EventTimeAndPlaybackState!>!

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

Long

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

Long

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

Long

The total number of audio underruns.

Long

The total bytes transferred during totalBandwidthTimeMs.

Long

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

Long

The total number of dropped video frames.

Long

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

Long

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

Int

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

Int

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

Int

The total number of times a playback has been paused.

Int

The total number of times a rebuffer occurred.

Int

The total number of times a seek occurred.

Long

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

Long

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

Long

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

Long

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

Long

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

Int

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

(Mutable)List<PlaybackStats.EventTimeAndFormat!>!

The video format history as EventTimeAndFormats ordered by EventTime.realTimeMs.

Constants

EMPTY

const val EMPTYPlaybackStats!

Empty playback stats.

PLAYBACK_STATE_ABANDONED

const val PLAYBACK_STATE_ABANDONED = 15: Int

Playback is abandoned before reaching the end of the media.

PLAYBACK_STATE_BUFFERING

const val PLAYBACK_STATE_BUFFERING = 6: Int

Playback is buffering to resume active playback.

PLAYBACK_STATE_ENDED

const val PLAYBACK_STATE_ENDED = 11: Int

Playback has reached the end of the media.

PLAYBACK_STATE_FAILED

const val PLAYBACK_STATE_FAILED = 13: Int

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

PLAYBACK_STATE_INTERRUPTED_BY_AD

const val PLAYBACK_STATE_INTERRUPTED_BY_AD = 14: Int

Playback is interrupted by an ad.

PLAYBACK_STATE_JOINING_BACKGROUND

const val PLAYBACK_STATE_JOINING_BACKGROUND = 1: Int

Playback is buffering in the background for initial playback start.

PLAYBACK_STATE_JOINING_FOREGROUND

const val PLAYBACK_STATE_JOINING_FOREGROUND = 2: Int

Playback is buffering in the foreground for initial playback start.

PLAYBACK_STATE_NOT_STARTED

const val PLAYBACK_STATE_NOT_STARTED = 0: Int

Playback has not started (initial state).

PLAYBACK_STATE_PAUSED

const val PLAYBACK_STATE_PAUSED = 4: Int

Playback is paused but ready to play.

PLAYBACK_STATE_PAUSED_BUFFERING

const val PLAYBACK_STATE_PAUSED_BUFFERING = 7: Int

Playback is buffering while paused.

PLAYBACK_STATE_PLAYING

const val PLAYBACK_STATE_PLAYING = 3: Int

Playback is actively playing.

PLAYBACK_STATE_SEEKING

const val PLAYBACK_STATE_SEEKING = 5: Int

Playback is handling a seek.

PLAYBACK_STATE_STOPPED

const val PLAYBACK_STATE_STOPPED = 12: Int

Playback is stopped and can be restarted.

PLAYBACK_STATE_SUPPRESSED

const val PLAYBACK_STATE_SUPPRESSED = 9: Int

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

PLAYBACK_STATE_SUPPRESSED_BUFFERING

const val PLAYBACK_STATE_SUPPRESSED_BUFFERING = 10: Int

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

Public constructors

PlaybackStats

PlaybackStats()

Public functions

getAbandonedBeforeReadyRatio

fun getAbandonedBeforeReadyRatio(): Float

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.

getAudioUnderrunRate

fun getAudioUnderrunRate(): Float

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

getDroppedFramesRate

fun getDroppedFramesRate(): Float

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.

getEndedRatio

fun getEndedRatio(): Float

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

getFatalErrorRate

fun getFatalErrorRate(): Float

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.

getFatalErrorRatio

fun getFatalErrorRatio(): Float

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

getJoinTimeRatio

fun getJoinTimeRatio(): Float

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.

getMeanAudioFormatBitrate

fun getMeanAudioFormatBitrate(): Int

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.

getMeanBandwidth

fun getMeanBandwidth(): Int

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

getMeanElapsedTimeMs

fun getMeanElapsedTimeMs(): Long

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

getMeanInitialAudioFormatBitrate

fun getMeanInitialAudioFormatBitrate(): Int

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

getMeanInitialVideoFormatBitrate

fun getMeanInitialVideoFormatBitrate(): Int

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

getMeanInitialVideoFormatHeight

fun getMeanInitialVideoFormatHeight(): Int

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

getMeanJoinTimeMs

fun getMeanJoinTimeMs(): Long

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.

getMeanNonFatalErrorCount

fun getMeanNonFatalErrorCount(): Float

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

getMeanPauseBufferCount

fun getMeanPauseBufferCount(): Float

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.

getMeanPauseCount

fun getMeanPauseCount(): Float

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

getMeanPausedTimeMs

fun getMeanPausedTimeMs(): Long

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

getMeanPlayAndWaitTimeMs

fun getMeanPlayAndWaitTimeMs(): Long

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.

getMeanPlayTimeMs

fun getMeanPlayTimeMs(): Long

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

getMeanRebufferCount

fun getMeanRebufferCount(): Float

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.

getMeanRebufferTimeMs

fun getMeanRebufferTimeMs(): Long

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.

getMeanSeekCount

fun getMeanSeekCount(): Float

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.

getMeanSeekTimeMs

fun getMeanSeekTimeMs(): Long

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.

getMeanSingleRebufferTimeMs

fun getMeanSingleRebufferTimeMs(): Long

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.

getMeanSingleSeekTimeMs

fun getMeanSingleSeekTimeMs(): Long

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.

getMeanTimeBetweenFatalErrors

fun getMeanTimeBetweenFatalErrors(): Float

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

getMeanTimeBetweenNonFatalErrors

fun getMeanTimeBetweenNonFatalErrors(): Float

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.

getMeanTimeBetweenRebuffers

fun getMeanTimeBetweenRebuffers(): Float

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

getMeanVideoFormatBitrate

fun getMeanVideoFormatBitrate(): Int

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.

getMeanVideoFormatHeight

fun getMeanVideoFormatHeight(): Int

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.

getMeanWaitTimeMs

fun getMeanWaitTimeMs(): Long

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.

getMediaTimeMsAtRealtimeMs

fun getMediaTimeMsAtRealtimeMs(realtimeMs: Long): Long

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

Parameters
realtimeMs: Long

The realtime as returned by elapsedRealtime.

Returns
Long

The estimated media time in milliseconds at this realtime, TIME_UNSET if no estimate can be given.

getNonFatalErrorRate

fun getNonFatalErrorRate(): Float

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.

getPlaybackStateAtTime

@PlaybackStats.PlaybackState
fun getPlaybackStateAtTime(realtimeMs: Long): Int

Returns the PlaybackState at the given time.

Parameters
realtimeMs: Long

The time as returned by elapsedRealtime.

Returns
Int

The PlaybackState at that time, or PLAYBACK_STATE_NOT_STARTED if the given time is before the first known playback state in the history.

getPlaybackStateDurationMs

fun getPlaybackStateDurationMs(
    @PlaybackStats.PlaybackState playbackState: Int
): Long

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

Parameters
@PlaybackStats.PlaybackState playbackState: Int

A PlaybackState.

Returns
Long

Total spent in the given playback state, in milliseconds

getRebufferRate

fun getRebufferRate(): Float

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.

getRebufferTimeRatio

fun getRebufferTimeRatio(): Float

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.

getSeekTimeRatio

fun getSeekTimeRatio(): Float

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.

getTotalElapsedTimeMs

fun getTotalElapsedTimeMs(): Long

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

getTotalJoinTimeMs

fun getTotalJoinTimeMs(): Long

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.

getTotalPausedTimeMs

fun getTotalPausedTimeMs(): Long

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

getTotalPlayAndWaitTimeMs

fun getTotalPlayAndWaitTimeMs(): Long

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

getTotalPlayTimeMs

fun getTotalPlayTimeMs(): Long

Returns the total time spent actively playing, in milliseconds.

getTotalRebufferTimeMs

fun getTotalRebufferTimeMs(): Long

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

getTotalSeekTimeMs

fun getTotalSeekTimeMs(): Long

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

getTotalWaitTimeMs

fun getTotalWaitTimeMs(): Long

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.

getWaitTimeRatio

fun getWaitTimeRatio(): Float

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.

merge

java-static fun merge(playbackStats: Array<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.

Parameters
playbackStats: Array<PlaybackStats!>!

Array of PlaybackStats to combine.

Returns
PlaybackStats!

The combined PlaybackStats.

Public properties

abandonedBeforeReadyCount

val abandonedBeforeReadyCountInt

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

adPlaybackCount

val adPlaybackCountInt

The number of ad playbacks.

audioFormatHistory

val audioFormatHistory: (Mutable)List<PlaybackStats.EventTimeAndFormat!>!

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

backgroundJoiningCount

val backgroundJoiningCountInt

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

endedCount

val endedCountInt

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

fatalErrorCount

val fatalErrorCountInt

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