DocumentationAnalyticsStreaming media services guide

Chapter name

Last update: June 8, 2026

CREATED FOR:

  • Developer

This page covers data collection for the Chapter name variable. See Chapter name for the corresponding reporting dimension.

style
shade-box

The chapter name variable is the human-readable title of a chapter (for example, "Pilot Episode - Opening"). Set it on every media.chapterStart event whose content is divided into chapters.

Property
Value
Context data variable
a.media.chapter.friendlyName
XDM collection field
xdm.mediaCollection.chapterDetails.friendlyName
Audience Manager trait
c_contextdata.a.media.chapter.friendlyName
Required
No
Sent with
Chapter start, chapter close
Web SDK

Set friendlyName inside xdm.mediaCollection.chapterDetails when calling sendEvent:

code language-javascript 
alloy("sendEvent", {
  xdm: {
    eventType: "media.chapterStart",
    mediaCollection: {
      chapterDetails: {
        friendlyName: "Pilot Episode - Opening",
        index: 1,
        offset: 0,
        length: 240
      },
      sessionID: "{sid}",
      playhead: 0
    }
  }
});
iOS

Pass the chapter name as the first (name) argument to createChapterObject.

code language-swift 
let chapterObject = Media.createChapterObjectWith(name: "Pilot Episode - Opening",
                                              position: 1,
                                                length: 240,
                                             startTime: 0)

tracker.trackEvent(event: MediaEvent.ChapterStart, info: chapterObject, metadata: nil)
Android

Pass the chapter name as the first (name) argument to createChapterObject.

code language-kotlin 
val chapterObject = Media.createChapterObject("Pilot Episode - Opening",
                                              1L,
                                              240.0,
                                              0.0)

tracker.trackEvent(Media.Event.ChapterStart, chapterObject, null)
Roku Edge

Set friendlyName inside xdm.mediaCollection.chapterDetails when calling sendMediaEvent for media.chapterStart:

code language-brightscript 
m.aepSdk.sendMediaEvent({
    "xdm": {
        "eventType": "media.chapterStart",
        "mediaCollection": {
            "chapterDetails": {
                "friendlyName": "Pilot Episode - Opening",
                "index": 1,
                "offset": 0,
                "length": 240
            },
            "playhead": 0
        }
    }
})
Media Edge API

Call the chapterStart endpoint with friendlyName inside xdm.mediaCollection.chapterDetails:

code language-json 
{
  "events": [{
    "xdm": {
      "eventType": "media.chapterStart",
      "mediaCollection": {
        "chapterDetails": {
          "friendlyName": "Pilot Episode - Opening",
          "index": 1,
          "offset": 0,
          "length": 240
        },
        "sessionID": "{sid}",
        "playhead": 0
      }
    }
  }]
}

Legacy implementation types (Analytics-only)

Media SDK JS 3.x

Pass the chapter name as the first argument to ADB.Media.createChapterObject:

code language-javascript 
var chapterInfo = ADB.Media.createChapterObject(
  "Pilot Episode - Opening",  // name
  1,                          // position
  240,                        // length (seconds)
  0                           // start time (seconds)
);

tracker.trackEvent(ADB.Media.Event.ChapterStart, chapterInfo, contextData);
Chromecast

Pass the chapter name as the first argument (name) to ADBMobile.media.createChapterObject:

code language-javascript 
var chapterInfo = ADBMobile.media.createChapterObject(
  "Pilot Episode - Opening",  // name
  1,                          // position
  240,                        // length
  0                           // startTime
);
ADBMobile.media.trackEvent(ADBMobile.media.Event.ChapterStart, chapterInfo, null);
Roku 2.x

Pass the chapter name as the first argument (name) to adb_media_init_chapterinfo:

code language-brightscript 
adb = ADBMobile()
chapterInfo = adb_media_init_chapterinfo("Pilot Episode - Opening", 1, 240.0, 0.0)  ' name, position, length, startTime

adb.mediaTrackEvent(adb.MEDIA_CHAPTER_START, chapterInfo)
Media Collection API

Include media.chapter.friendlyName in the params object of your chapterStart POST request:

code language-json 
{
  "playerTime": { "playhead": 0, "ts": 1699523820000 },
  "eventType": "chapterStart",
  "params": {
    "media.chapter.friendlyName": "Pilot Episode - Opening"
  }
}

See the Media Collection API events reference for the full request structure.

recommendation-more-help
media-analytics-help