DocumentationAnalyticsStreaming Media Collection Guide

Track quality of experience on Chromecast

Last update: November 11, 2022
  • Topics:
  • Media Analytics

CREATED FOR:

  • User
  • Admin
  • Developer

The following instructions provide guidance for implementation across all 2.x SDKs.

IMPORTANT
If you are implementing a 1.x version of the SDK, you can download the 1.x Developers Guides here: Download SDKs.

Overview

Quality of experience tracking includes quality of service (QoS) and error tracking, both are optional elements and are not required for core media tracking implementations. You can use the media player API to identify the variables related to QoS and error tracking.

Player events

On all bitrate change events

  • Create/update the QoS object instance for the playback, qosObject
  • Call trackEvent(Media.Heartbeat.Event.BitrateChange, qosObject);

On player errors

Call trackError("media error id");

Implement

  1. 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.
    VariableDescriptionRequired
    bitrateCurrent bitrateYes
    startupTimeStartup timeYes
    fpsFPS valueYes
    droppedFramesNumber of dropped framesYes

    QoS object creation: createQoSObject

    qosInfo = ADBMobile.media.createQoSObject(50000, 0, 24, 10);

  2. When playback switches bitrates, call the BitrateChange event in the Media Heartbeat instance: trackEvent

    ADBMobile.media.trackEvent(ADBMobile.media.Event.BitrateChange);
    IMPORTANT
    Update the QoS object and call the bitrate change event on every bitrate change. This provides the most accurate QoS data.

  3. Make sure that getQoSObject() method returns the most updated QoS information.

  4. 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 calling trackSessionEnd() after calling trackError().
recommendation-more-help
c8eee520-cef5-4f8c-a38a-d4952cfae4eb