This documentation covers tracking in version 2.x of the SDK.
If you are implementing a 1.x version of the SDK, you can download 1.x Developers Guides here: Download SDKs
Initial tracking setup
Identify when the user triggers the intention of playback (the user clicks play and/or autoplay is on) and create a MediaObject
instance.
MediaObject
reference:
Variable Name | Description | Required |
---|---|---|
name |
Video name | Yes |
mediaid |
Video unique identifier | Yes |
length |
Video length | Yes |
streamType |
Stream type (see StreamType constants below) | Yes |
mediaType |
Media type (see MediaType constants below) | Yes |
StreamType
constants:
Constant Name | Description |
---|---|
MEDIA_STREAM_TYPE_VOD |
Stream type for Video on Demand. |
MEDIA_STREAM_TYPE_LIVE |
Stream type for LIVE content. |
MEDIA_STREAM_TYPE_LINEAR |
Stream type for LINEAR content. |
MEDIA_STREAM_TYPE_AOD |
Stream type for Audio On Demand |
MEDIA_STREAM_TYPE_AUDIOBOOK |
Stream type for Audio Book |
MEDIA_STREAM_TYPE_PODCAST |
Stream type for Podcast |
MediaType
constants:
Constant Name | Description |
---|---|
MEDIA_STREAM_TYPE_AUDIO |
Media type for Audio streams. |
MEDIA_STREAM_TYPE_VIDEO |
Media type for Video streams. |
Create a media info object for video with VOD content:
mediaInfo = adb_media_init_mediainfo(
"<MEDIA_NAME>",
"<MEDIA_ID>",
600,
ADBMobile().MEDIA_STREAM_TYPE_VOD,
ADBMobile().MEDIA_TYPE_VIDEO
)
or
mediaInfo = adb_media_init_mediainfo()
mediaInfo.name = "<MEDIA_NAME>"
mediaInfo.id = "<MEDIA_ID>"
mediaInfo.length = 600
mediaInfo.streamType = ADBMobile().MEDIA_STREAM_TYPE_VOD
mediaInfo.mediaType = ADBMobile().MEDIA_TYPE_VIDEO
Create a media info object for video with AOD content:
mediaInfo = adb_media_init_mediainfo(
"<MEDIA_NAME>",
"<MEDIA_ID>",
600,
ADBMobile().MEDIA_STREAM_TYPE_AOD,
ADBMobile().MEDIA_TYPE_AUDIO
)
or
mediaInfo = adb_media_init_mediainfo()
mediaInfo.name = "<MEDIA_NAME>"
mediaInfo.id = "<MEDIA_ID>"
mediaInfo.length = 600
mediaInfo.streamType = ADBMobile().MEDIA_STREAM_TYPE_AOD
mediaInfo.mediaType = ADBMobile().MEDIA_TYPE_AUDIO
Attach metadata
Optionally attach standard and/or custom metadata objects to the tracking session through context data variables.
Standard metadata
Implement standard metadata on Roku
Attaching the standard video metadata object to the media object is optional.
Custom metadata
Create a variable object for the custom variables and populate with the data for this video. For example:
mediaContextData = {}
mediaContextData["cmk1"] = "cmv1"
mediaContextData["cmk2"] = "cmv2"
Track the intention to start playback
To begin tracking a media session, call trackSessionStart
on the Media Heartbeat instance:
ADBMobile().mediaTrackSessionStart(mediaInfo,mediaContextData)
The second value is the custom video metadata object name that you created in step 2.
trackSessionStart
tracks the user intention of playback, not the beginning of the playback. This API is used to load the video data/metadata and to estimate the time-to-start QoS metric (the time duration between trackSessionStart
and trackPlay
).
If you are not using custom video metadata, simply send an empty object for the data
argument in trackSessionStart
, as shown in the commented out line in the iOS example above.
Track the actual start of playback
Identify the event from the video player for the beginning of the video playback, where the first frame of the video is rendered on the screen, and call trackPlay
:
ADBMobile().mediaTrackPlay()
Update playhead value
When media playhead changes, notify the SDK by calling the mediaUpdatePlayhead
API.
For video-on-demand (VOD), the value is specified in seconds from the beginning of the media item.
For live streaming, if the player does not provide information about the content duration, the value can be specified as the number of seconds since midnight UTC of that day.
ADBMobile().mediaUpdatePlayhead(position)
Consider the following when calling the mediaUpdatePlayhead
API:
mediaUpdatePlayhead
API at least once per second.Track the completion of playback
Identify the event from the video player for the completion of the video playback, where the user has watched the content until the end, and call trackComplete
:
ADBMobile().mediaTrackComplete()
Track the end of the session
Identify the event from the video player for the unloading/closing of the video playback, where the user closes the video and/or the video is completed and has been unloaded, and call trackSessionEnd
:
ADBMobile().mediaTrackSessionEnd()
trackSessionEnd
marks the end of a video tracking session. If the session was successfully watched to completion, where the user watched the content until the end, ensure that trackComplete
is called before trackSessionEnd
. Any other track*
API call is ignored after trackSessionEnd
, except for trackSessionStart
for a new video tracking session.
Track all possible pause scenarios
Identify the event from the video player for video pause and call trackPause
:
ADBMobile().mediaTrackPause()
Pause Scenarios
Identify any scenario in which the Video Player will pause and make sure that trackPause
is properly called. The following scenarios all require that your app call trackPause()
:
Identify the event from the player for video play and/or video resume from pause and call trackPlay
:
ADBMobile().mediaTrackPlay()
This may be the same event source that was used in Step 4. Ensure that each trackPause()
API call is paired with a following trackPlay()
API call when the video playback resumes.