Track chapters and segments
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. Use the media player API with customized segmentation logic to identify chapter events and to populate the chapter variables.
Player events
Player event
Action
Chapter start
Create chapter object; call ChapterStart
Chapter complete
Call ChapterComplete
Chapter skip
Call ChapterSkip
Implementation steps
- Identify when the chapter start event occurs and create the chapter object. See Chapter name, Chapter position, Chapter length, and Chapter offset for field definitions.
- Optionally create context data variables for custom chapter metadata.
- Call Chapter start to begin tracking the chapter.
- When playback reaches the chapter end boundary, call Chapter complete.
- If the user skips the chapter before completion, call Chapter skip.
- For additional chapters, repeat steps 1 through 5.
recommendation-more-help
media-analytics-help