Overview overview

The following instructions provide guidance for implementation using 2.x SDKs.

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

Chapter and segment tracking is available for custom-defined media chapters or segments. Some common uses for chapter tracking are to define custom segments based on media content (such as baseball innings), or to define content segments between ad breaks. Chapter tracking is not required for core media tracking implementations.

Chapter tracking includes chapter starts, chapter completes, and chapter skips. You can use the media player API with customized segmentation logic to identify chapter events and to populate the required and optional chapter variables.

Player events

On chapter start

  • Create the chapter object instance for the chapter, chapterObject
  • Populate the chapter metadata, chapterCustomMetadata
  • Call trackEvent(MediaHeartbeat.Event.ChapterStart, chapterObject, chapterCustomMetadata);

On chapter complete

  • Call trackEvent(MediaHeartbeat.Event.ChapterComplete);

On chapter skip

  • Call trackEvent(MediaHeartbeat.Event.ChapterSkip);

Implement chapter tracking implement-chapter-tracking

  1. Identify when the chapter start event occurs and create the ChapterObject instance by using the chapter information.

    Here is the ChapterObject chapter tracking reference:

    note note
    These variables are only required if you are planning to track chapters.
    table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 3-align-center 7-align-center 11-align-center 15-align-center 19-align-center
    Variable Name Description Required
    name Chapter name Yes
    position Chapter position Yes
    length Chapter length Yes
    startTime Chapter start time Yes
  2. If you include custom metadata for the chapter, create the context data variables for the metadata.

  3. To begin tracking the chapter playback, call the ChapterStart event in the MediaHeartbeat instance.

  4. When playback reaches the chapter end boundary, as defined by your custom code, call the ChapterComplete event in the MediaHeartbeat instance.

  5. If chapter playback did not complete because the user chose to skip the chapter (for example, if the user seeks out of the chapter boundary), call the ChapterSkip event in the MediaHeartbeat instance.

  6. If there are any additional chapters, repeat steps 1 through 5.

The following sample code uses the JavaScript 2.x SDK for an HTML5 media player. You should use this code with the core media playback code.

/* Call on chapter start */
if (e.type == "chapter start") {
    var chapterObject = MediaHeartbeat.createChapterObject("Inning 5",5,500,2500);
    /* Set custom context data*/
    var chapterCustomMetadata = {
        segmentType:"Baseball Innings",
        segmentName:"Inning 5",
        segmentInfo:"Game Six"

/* Call on chapter complete */
if (e.type == "chapter complete") {

/* Call on chapter skip */
if (e.type == "chapter skip") {