DocumentationExperience PlatformExperience Data Model (XDM) Guide

Chapter Details Information data type

Last update: Thu Dec 14 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • User
  • Admin
  • Leader

Chapter Details Information is a standard Experience Data Model (XDM) data type that describes various attributes related to chapters or segments within media content. Use the Chapter Details Information data type to capture details such as chapter name, duration, position, ID, playback status (started/completed), and the time spent on each chapter.

A diagram of the Chapter Details Information data type.

Display name
Property
Data type
Description
Chapter Name
friendlyName
string
The name of the chapter and/or segment.
Chapter Length Or Duration
length
integer
Required The length of the chapter, in seconds.
Chapter Offset
offset
integer
Required The offset of the chapter inside the content (in seconds) from the start.
Chapter Position
index
integer
Required The position (index, integer) of the chapter inside the content.
Chapter ID
ID
string
The auto-generated ID of the chapter.
Chapter Started
isStarted
boolean
Whether the chapter has started.
Chapter Completed
isCompleted
boolean
Whether the chapter has completed.
Chapter Time Played
timePlayed
integer
The time spent on the chapter, in seconds.

For more details on the field group, refer to the public XDM repository

recommendation-more-help
62e9ffd9-1c74-4cef-8f47-0d00af32fc07