Skip to main content

PlaybackStats

The structure contains current playback session metrics. The values are reset each time a new stream is loaded.

Properties​

droppedFrames​

droppedFrames: number

The total number of frames dropped by the player.

streamBandwidth?​

optional streamBandwidth: number

The total bandwidth required for the current streams, in bits per second.

estimatedBandwidth?​

optional estimatedBandwidth: number

The current estimated network bandwidth, in bits per second.

transferDurationSec?​

optional transferDurationSec: number

The accumulated duration, in seconds, of active network transfer of bytes.

Remarks​

Available on iOS/tvOS.

numberOfBytesTransferred?​

optional numberOfBytesTransferred: number

The accumulated number of bytes transferred over the network.

Remarks​

Available on iOS/tvOS.

numberOfMediaRequests?​

optional numberOfMediaRequests: number

The number of media read requests from the server to this client.

Remarks​

Available on iOS/tvOS.

playbackStartTimestamp?​

optional playbackStartTimestamp: number

The Unix Epoch time, in milliseconds, at which playback began.

Remarks​

Available on iOS/tvOS.

startupTimeSec?​

optional startupTimeSec: number

The accumulated duration, in seconds, until the player item is ready to play.

Remarks​

Available on iOS/tvOS.

durationWatchedSec?​

optional durationWatchedSec: number

The accumulated duration, in seconds, of the media played.

Remarks​

Available on iOS/tvOS.

numberOfStalls?​

optional numberOfStalls: number

The total number of playback stalls encountered.

Remarks​

Available on iOS/tvOS.

segmentsDownloadedDurationSec?​

optional segmentsDownloadedDurationSec: number

The accumulated duration, in seconds, of the media segments downloaded.

Remarks​

Available on iOS/tvOS.

observedBitrateStandardDeviation?​

optional observedBitrateStandardDeviation: number

The standard deviation of the observed segment download bit rates.

Remarks​

Available on iOS/tvOS.

observedBitrate?​

optional observedBitrate: number

The empirical throughput, in bits per second, across all media downloaded.

Remarks​

Available on iOS/tvOS.

averageAudioBitrate?​

optional averageAudioBitrate: number

The audio track’s average bit rate, in bits per second.

Remarks​

Available on iOS/tvOS.

averageVideoBitrate?​

optional averageVideoBitrate: number

The video track’s average bit rate, in bits per second.

Remarks​

Available on iOS/tvOS.

indicatedAverageBitrate?​

optional indicatedAverageBitrate: number

The average throughput, in bits per second, required to play the stream, as advertised by the server.

Remarks​

Available on iOS/tvOS.

indicatedBitrate?​

optional indicatedBitrate: number

The throughput, in bits per second, required to play the stream, as advertised by the server.

Remarks​

Available on iOS/tvOS.

bufferedTimeMsec?​

optional bufferedTimeMsec: number

The amount of media data currently buffered ahead of the playhead, in milliseconds.