Skip to content

chapterdetails.schema.md

Latest commit

 

History

History
196 lines (103 loc) · 3.39 KB

chapterdetails.schema.md

File metadata and controls

196 lines (103 loc) · 3.39 KB

Chapter details information Schema

https://ns.adobe.com/xdm/datatypes/chapterDetails

Chapter details information.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted datatypes/chapterdetails.schema.json

Chapter details information Example

{
  "xdm:length": 100,
  "xdm:offset": 50,
  "xdm:index": 2,
  "xdm:isStarted": false,
  "xdm:isCompleted": false,
  "xdm:timePlayed": 70
}

Chapter details information Properties

Property Type Required Defined by
xdm:ID string Optional Chapter details information (this schema)
xdm:friendlyName string Optional Chapter details information (this schema)
xdm:index integer Required Chapter details information (this schema)
xdm:isCompleted boolean Optional Chapter details information (this schema)
xdm:isStarted boolean Optional Chapter details information (this schema)
xdm:length integer Required Chapter details information (this schema)
xdm:offset integer Required Chapter details information (this schema)
xdm:timePlayed integer Optional Chapter details information (this schema)
* any Additional this schema allows additional properties

xdm:ID

Chapter ID

The auto-generated ID of the chapter.

xdm:ID

  • is optional
  • type: string
  • defined in this schema

xdm:ID Type

string

xdm:friendlyName

Chapter Name

The name of the chapter and/or segment.

xdm:friendlyName

  • is optional
  • type: string
  • defined in this schema

xdm:friendlyName Type

string

xdm:index

Chapter Position

The position (index, integer) of the chapter inside the content.

xdm:index

  • is required
  • type: integer
  • defined in this schema

xdm:index Type

integer

xdm:isCompleted

Chapter Completed

Chapter is completed.

xdm:isCompleted

  • is optional
  • type: boolean
  • defined in this schema

xdm:isCompleted Type

boolean

xdm:isStarted

Chapter Started

Chapter is started.

xdm:isStarted

  • is optional
  • type: boolean
  • defined in this schema

xdm:isStarted Type

boolean

xdm:length

Chapter Length Or Duration

The length of the chapter, in seconds.

xdm:length

  • is required
  • type: integer
  • defined in this schema

xdm:length Type

integer

xdm:offset

Chapter Offset

The offset of the chapter inside the content (in seconds) from the start.

xdm:offset

  • is required
  • type: integer
  • defined in this schema

xdm:offset Type

integer

xdm:timePlayed

Chapter Time Played

The time spent on the chapter, in seconds.

xdm:timePlayed

  • is optional
  • type: integer
  • defined in this schema

xdm:timePlayed Type

integer