Skip to main content

Chapter

The Chapter feature enables to convey navigation to specific sections within a VOD by segmenting the player timeline into discrete portions.

To enable and define chapter for a VOD, make a PUT request to the following API with specific VOD id provided:

PUT /bv/cms/v1/vods/:id

Configure the chapter_setting request body with the following options:

Query ParametersDescription
enabledtrue
chaptersDefine chapter markers:
  • title: The title of the defined section shown on player
  • timestamp: The start time of the defined section
  • Here is an example of a request body that defines three chapter sections in a VOD:

    • Chapter-1: 0s - 10s
    • Chapter-2: 10s - 30s
    • Chapter-3: 30s - End
    {
    "chapter_setting":{
    "enable":true,
    "chapters":{
    [
    "title":"Chapter-1",
    "timestamp":"0"
    ],
    [
    "title":"Chapter-2",
    "timestamp":"10"
    ],
    [
    "title":"Chapter-3",
    "timestamp":"30"
    ]
    }
    }
    }