Track core playback using JavaScript 3.x track-core-playback-on-javascript

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.

createMediaObject API

StreamType constants:

MediaType constants:

var mediaObject = ADB.Media.createMediaObject(<MEDIA_NAME>,
                                  <MEDIA_ID,
                                  <MEDIA_LENGTH>,
                                  <STREAM_TYPE>,
                                  <MEDIA_TYPE>);

Attach metadata

Optionally attach standard and/or custom metadata to the tracking session through context data variables.

• Standard metadata

  note note
  NOTE
  Attaching the standard metadata is optional.

  • Media metadata keys API Reference - Standard metadata keys - JavaScript

    See the comprehensive set of available metadata here: Audio and video parameters

• Custom metadata

  Create a variable object for the custom variables and populate with the data for this media. For example:

  code language-js
  /* Set context data */ var contextData = {}; //Standard metadata contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode"; contextData[ADB.Media.VideoMetadataKeys] = "Sample Show"; //Custom metadata contextData["isUserLoggedIn"] = "false"; contextData["tvStation"] = "Sample TV Station";

Track the intention to start playback

To begin tracking a media session, call trackSessionStart on the Media Heartbeat instance:

var mediaObject = ADB.Media.createMediaObject("video-name",
                                              "video-id",
                                              60.0,
                                              ADB.Media.StreamType.VOD,
                                              ADB.Media.MediaType.Video);

var contextData = {};

//Standard metadata
contextData[ADB.Media.VideoMetadataKeys] = "Sample Episode";
contextData[ADB.Media.VideoMetadataKeys] = "Sample Show";

//Custom metadata
contextData["isUserLoggedIn"] = "false";
contextData["tvStation"] = "Sample TV Station";

tracker.trackSessionStart(mediaObject, contextData);

Track the actual start of playback

Identify the event from the media player for the beginning of the playback, where the first frame of the media is rendered on the screen, and call trackPlay:

tracker.trackPlay();

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.

tracker.updatePlayhead(position)

Track the completion of playback

Identify the event from the media player for the completion of the playback, where the user has watched the content until the end, and call trackComplete:

tracker.trackComplete();

Track the end of the session

Identify the event from the media player for the unloading/closing of the playback, where the user closes the media and/or the media is completed and has been unloaded, and call trackSessionEnd:

tracker.trackSessionEnd();

Track all possible pause scenarios

Identify the event from the media player for pause and call trackPause:

tracker.trackPause();

Pause Scenarios

Identify any scenario in which the media 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 media from the point of interruption.

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

tracker.trackPlay();