Track quality of experience using JavaScript 2.x
Last update: June 25, 2024
- Topics:
- Media Analytics
CREATED FOR:
- User
- Admin
- Developer
The following instructions provide guidance for implementation across all 2.x SDKs.
If you are implementing a 1.x version of the SDK, you can download the 1.x Developers Guides here: Download SDKs.
Implement QOS
-
Identify when the bitrate changes during media playback and create the
MediaObject
instance using the QoS information.QoSObject variables:
TIP
These variables are only required if you are planning to track QoS.VariableDescriptionRequiredbitrate
Current bitrateYesstartupTime
Startup timeYesfps
FPS valueYesdroppedFrames
Number of dropped framesYesQoS object creation:
// Replace <bitrate>, <startuptime>, <fps> and // <droppeFrames> with the current playback QoS values. var qosObject = MediaHeartbeat.createQoSObject(<bitrate>, <startuptime>, <fps>, <droppedFrames>);
-
When playback switches bitrates, call the
BitrateChange
event in the Media Heartbeat instance:_onBitrateChange = function() { this._mediaHeartbeat.trackEvent(MediaHeartbeat.Event.BitrateChange, qosObject); };
IMPORTANT
Update the QoS object and call the bitrate change event on every bitrate change. This provides the most accurate QoS data. -
Make sure that
getQoSObject()
method returns the most updated QoS information. -
When the media player encounters an error, and the error event is available to the player API, use
trackError()
to capture the error information. (See Overview.)TIP
Tracking media player errors will not stop the media tracking session. If the media player error prevents the playback from continuing, make sure that the media tracking session is closed by callingtrackSessionEnd()
after callingtrackError()
.
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb