Interface: Stats

Properties

absolutePlayTime

(number or undefined)

The total time spent in a playing state only, in seconds. Unlike 'playTime', absolute play time does NOT include time spent in a paused state. This is currently only supported while using Shaka.

bufferingTime

(number or undefined)

The total time spent in a buffering state, in seconds. This is aggregated over all media items in the current receiver session.

completionPercent

(number or undefined)

The greatest completion percent that the user has experienced in playback. Also known as the "high water mark". Is NaN when there is no known duration, such as for livestreams. This is currently only supported while using Shaka.

corruptedFrames

(number or undefined)

The total number of corrupted frames. This is aggregated over all media items in the current receiver session. This is currently only supported while using Shaka.

decodedFrames

(number or undefined)

The total number of frames decoded. This is aggregated over all media items in the current receiver session.

drmTimeSeconds

(number or undefined)

The amount of time it took to download the first drm key, and load that key into the drm system. This is currently only supported while using Shaka.

droppedFrames

(number or undefined)

The total number of frames dropped. This is aggregated over all media items in the current receiver session.

estimatedBandwidth

(number or undefined)

The estimated bandwidth. This is currently only supported while using Shaka.

gapsJumped

(number or undefined)

The total number of playback gaps jumped by the player. This is currently only supported while using Shaka v4.1.0+.

height

(number or undefined)

The height of the current video track. Undefined if no video is playing.

licenseTime

(number or undefined)

The time spent on license requests during this session in seconds, or NaN. This is currently only supported while using Shaka.

liveLatency

(number or undefined)

The time between the capturing of a frame and the end user having it displayed on their screen. This is currently only supported while using Shaka.

loadLatency

(number or undefined)

The number of seconds it took for the video element to have enough data to begin playback. This is measured from the time the player's load() function is called to the time the 'loadeddata' event is fired by the media element. This is currently only supported while using Shaka.

manifestTimeSeconds

(number or undefined)

The amount of time it took to download and parse the manifest. This is currently only supported while using Shaka.

maxSegmentDuration

(number or undefined)

The presentation's max segment duration in seconds, or NaN. This is currently only supported while using Shaka.

pauseTime

(number or undefined)

The total time spent in a paused state in seconds. This is currently only supported while using Shaka.

playTime

(number or undefined)

The total time spent in a non-buffering state, in seconds. This is aggregated over all media items in the current receiver session.

stallsDetected

(number or undefined)

The total number of playback stalls detected. This is currently only supported while using Shaka v4.1.0+.

stateHistory

(non-null Array of non-null cast.framework.stats.StateChange or undefined)

A history of the state changes the player has entered. This can be 'buffering', 'playing', 'paused', or 'ended'.

streamBandwidth

(number or undefined)

The bandwidth required for the current streams (total, in bit/sec). Undefined if no streams are currently active.

switchHistory

(non-null Array of non-null cast.framework.stats.TrackChoice or undefined)

A history of the stream changes. This includes both changes from ABR and manual track selections.

width

(number or undefined)

The width of the current video track. Undefined if no video is playing.