logo
THEOplayer
ChromelessPlayerfeaturesMetricsPlayerPlayerConfigurationPlayerEventMapPlayerListplayersplayerSuiteVersionversiontheoplayer
ABR
Miscellaneous
Ads
Caching
Content protection
Analytics
Casting
Media and Text Tracks
Source
Verizon Media
Events
HESP
SSAI
Network
Presentation
Player
UI
VR

THEOplayer > Metrics

Metrics interface

The metrics API which can be used to gather information related to the quality-of-service and video playback experience.

Signature:

export interface Metrics 

Remarks


- Available since v2.46.0.

Properties

Property

Type

Description

bufferedSegments

BufferedSegments

The total number of audio and video segments in the buffer.

corruptedVideoFrames

number

The total number of video frames that could not be decoded.

currentBandwidthEstimate

number

The bandwidth in bits per second estimated to be currently available as used for ABR decisions.

droppedVideoFrames

number

The total number of dropped video frames.

totalBytesLoaded

number

The total bytes received in response to all media segments since loading the current source.

Property Details

bufferedSegments

The total number of audio and video segments in the buffer.

Signature:

bufferedSegments: BufferedSegments;

Remarks


- This value is currently available only for DASH.

corruptedVideoFrames

The total number of video frames that could not be decoded.

Signature:

corruptedVideoFrames: number;

Remarks


- This value resets on a source change.

currentBandwidthEstimate

The bandwidth in bits per second estimated to be currently available as used for ABR decisions.

Signature:

currentBandwidthEstimate: number;

droppedVideoFrames

The total number of dropped video frames.

Signature:

droppedVideoFrames: number;

Remarks


- This value resets on a source change.

totalBytesLoaded

The total bytes received in response to all media segments since loading the current source.

Signature:

totalBytesLoaded: number;
github
Make sure to follow us on GitHub!
THEO-logo-white
twitter
facebook
linkedin
Copyright © 2020. All Rights Reserved.
Leuven
New York
Singapore
Barcelona