Track core playback on Roku

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:

StreamType constants:

MediaType constants:

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

  NOTE

  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)

TIP

The second value is the custom video metadata object name that you created in step 2.

IMPORTANT

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).

NOTE

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)

NOTE

Consider the following when calling the mediaUpdatePlayhead API:

• When using progress markers, the content duration is required and the playhead needs to be updated as number of seconds from the beginning of the media item, starting with 0.
• When using media SDKs, you must call the 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()

IMPORTANT

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():

• The user explicitly hits pause in the app.
• The player puts itself into the Pause state.
• (Mobile Apps) - The user puts the application into the background, but you want the app to keep the session open.
• (Mobile Apps) - Any type of system interrupt occurs that causes an application to be backgrounded. For example, the user receives a call, or a pop up from another application occurs, but you want the application to keep the session alive to give the user the opportunity to resume the video from the point of interruption.

Identify the event from the player for video play and/or video resume from pause and call trackPlay:

ADBMobile().mediaTrackPlay()

TIP

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.