Track quality of experience on Roku
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 use the
mediaUpdateQoS
API to update the QoS info on the Media SDK.QoSObject variables:
TIP
These variables are only required if you are tracking QoS.VariableDescriptionRequiredbitrate
Current bitrateYesstartupTime
Startup timeYesfps
FPS valueYesdroppedFrames
Number of dropped framesYesFor example:
bitrate = 200000 fps = 0 droppedFrames = 1 startupTime = 2 qosinfo = adb_media_init_qosinfo(bitrate, startupTime, fps, droppedFrames) ADBMobile().mediaUpdateQoS(qosinfo)
-
When playback switches bitrates, call
trackEvent(BitrateChange)
to notify the Media SDK that the Bitrate changed.ADBMobile().mediaTrackEvent(ADBMobile().MEDIA_BITRATE_CHANGE)
NOTE
You need to callupdateQoSObject
with the updated bitrate value. -
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