Track chapters and segments on Chromecast

Last update: 2022-11-11
  • Created for:
  • User

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.

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

    ChapterObject chapter tracking reference:


    These variables are only required if you are planning to track chapters.

    Variable Name Description Required
    name Chapter name Yes
    position Chapter position Yes
    length Chapter length Yes
    startTime Chapter start time Yes

    Chapter object: createChapterObject

    chapterInfo ="First Chapter", 1, CHAPTER1_LENGTH, CHAPTER1_START_POS);
  2. If you include custom metadata for the chapter, create the context data variables for the metadata:

    var chapterContextData = {
        segmentType: "Sample segment type"
  3. To begin tracking the chapter playback, track the ChapterStart event: trackEvent, ChapterInfo, chapterContextData);
  4. When playback reaches the chapter end boundary, as defined by your custom code, call the ChapterComplete event in the MediaHeartbeat instance: trackEvent;
  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), track the ChapterSkip event: trackEvent;
  6. If there are any additional chapters, repeat steps 1 through 5.

On this page