xdm/docs/reference/datatypes/chapterdetails.schema.json at master · RussStringham/xdm · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
{
    "meta:license": [
        "Copyright 2022 Adobe Systems Incorporated. All rights reserved.",
        "This work is licensed under a Creative Commons Attribution 4.0 International (CC BY 4.0) license",
        "you may not use this file except in compliance with the License. You may obtain a copy",
        "of the License at https://creativecommons.org/licenses/by/4.0/"
    ],
    "$id": "https://ns.adobe.com/xdm/datatypes/chapterDetails",
    "$schema": "http://json-schema.org/draft-06/schema#",
    "title": "Chapter details information",
    "type": "object",
    "meta:status": "stable",
    "meta:extensible": true,
    "description": "Chapter details information.",
    "definitions": {
        "chapterDetails": {
            "properties": {
                "xdm:friendlyName": {
                    "title": "Chapter Name",
                    "type": "string",
                    "description": "The name of the chapter and/or segment."
                },
                "xdm:length": {
                    "title": "Chapter Length Or Duration",
                    "type": "integer",
                    "description": "The length of the chapter, in seconds."
                },
                "xdm:offset": {
                    "title": "Chapter Offset",
                    "type": "integer",
                    "description": "The offset of the chapter inside the content (in seconds) from the start."
                },
                "xdm:index": {
                    "title": "Chapter Position",
                    "type": "integer",
                    "description": "The position (index, integer) of the chapter inside the content."
                },
                "xdm:ID": {
                    "title": "Chapter ID",
                    "type": "string",
                    "description": "The auto-generated ID of the chapter."
                },
                "xdm:isStarted": {
                    "title": "Chapter Started",
                    "type": "boolean",
                    "description": "Chapter is started."
                },
                "xdm:isCompleted": {
                    "title": "Chapter Completed",
                    "type": "boolean",
                    "description": "Chapter is completed."
                },
                "xdm:timePlayed": {
                    "title": "Chapter Time Played",
                    "type": "integer",
                    "description": "The time spent on the chapter, in seconds."
                }
            },
            "required": ["xdm:length", "xdm:offset", "xdm:index"]
        }
    },
    "allOf": [
        {
            "$ref": "#/definitions/chapterDetails"
        }
    ],
    "examples": [
        {
            "xdm:length": 100,
            "xdm:offset": 50,
            "xdm:index": 2
        }
    ]
}