Showing:

Annotations
Diagram
Properties
Constraints
Compositions
Used By
Source
Main Schema
Properties
Definitions
Main Schema apple.json
#/items
Document version http://json-schema.org/draft-04/schema#
Annotations
 
Title  HLS Chapter Data

Description  HLS chapter data format
Diagram
Type array
Constraints
 
Unique Items : false
Array Items
Items
#/items
Additional Items true
Source
 

{
  "type": "array",
  "title": "HLS Chapter Data",
  "description": "HLS chapter data format",
  "$schema": "http://json-schema.org/draft-04/schema#",
  "items": {
    "type": "object",
    "description": "chapter entry",
    "required": ["start-time"],
    "properties": {
      "chapter": {
        "type": "number",
        "minimum": 1,
        "description": "Chapter number (optional)"
      },
      "start-time": {
        "type": "number",
        "minimum": 0,
        "description": "Chapter start time"
      },
      "duration": {
        "type": "number",
        "minimum": 0,
        "exclusiveMinimum": true,
        "description": "Chapter duration (optional)"
      },
      "titles": {
        "type": "array",
        "description": "List of titles by language for chapter (optional)",
        "items": {
          "type": "object",
          "description": "Title object",
          "required": [
            "language",
            "title"
          ],
          "properties": {
            "language": {
              "type": "string",
              "description": "BCP 47 language code; und for undefined"
            },
            "title": {
              "type": "string",
              "description": "Chapter title string"
            }
          }
        }
      },
      "images": {
        "type": "array",
        "description": "List of images for chapter (optional)",
        "items": {
          "type": "object",
          "description": "Image object",
          "required": [
            "image-category",
            "pixel-width",
            "pixel-height",
            "url"
          ],
          "properties": {
            "image-category": {
              "type": "string",
              "description": "Image category"
            },
            "pixel-width": {
              "type": "integer",
              "minimum": 0,
              "exclusiveMinimum": true,
              "description": "Pixel width"
            },
            "pixel-height": {
              "type": "integer",
              "minimum": 0,
              "exclusiveMinimum": true,
              "description": "Pixel height"
            },
            "url": {
              "type": "string",
              "description": "URL to image (relative or absolute)"
            }
          }
        }
      },
      "metadata": {
        "type": "array",
        "description": "List of metadata entries for chapter (optional)",
        "items": {
          "type": "object",
          "description": "Metadata object",
          "required": [
            "key",
            "value"
          ],
          "properties": {
            "key": {
              "type": "string",
              "description": "Key value name"
            },
            "value": {
              "description": "Metadata value",
              "anyOf": [
                {"type": "string"},
                {"type": "number"},
                {"type": "boolean"},
                {"type": "array"},
                {"type": "object"}
              ]
            },
            "language": {
              "type": "string",
              "description": "BCP 47 language code (optional)"
            }
          }
        }
      }
    }
  }
}

Main Schema #/items
#/items/properties/chapter #/items/properties/start-time #/items/properties/duration #/items/properties/titles #/items/properties/images #/items/properties/metadata
Annotations
 
Description  chapter entry
Diagram
Type object
Properties
Name Occurrence
chapter
start-time
duration
titles
images
metadata
 optional
required
optional
optional
optional
optional
Additional Properties true
Used by
Schema
#/schema
Source
 

 "items": {
  "type": "object",
  "description": "chapter entry",
  "required": ["start-time"],
  "properties": {
    "chapter": {
      "type": "number",
      "minimum": 1,
      "description": "Chapter number (optional)"
    },
    "start-time": {
      "type": "number",
      "minimum": 0,
      "description": "Chapter start time"
    },
    "duration": {
      "type": "number",
      "minimum": 0,
      "exclusiveMinimum": true,
      "description": "Chapter duration (optional)"
    },
    "titles": {
      "type": "array",
      "description": "List of titles by language for chapter (optional)",
      "items": {}
    },
    "images": {
      "type": "array",
      "description": "List of images for chapter (optional)",
      "items": {}
    },
    "metadata": {
      "type": "array",
      "description": "List of metadata entries for chapter (optional)",
      "items": {}
    }
  }
}

Main Schema chapter
Annotations
 
Description  Chapter number (optional)
Diagram
Type number
Constraints
 
Minimum : 1
Used by
Schema
#/items
Source
 

 "chapter": {
  "type": "number",
  "minimum": 1,
  "description": "Chapter number (optional)"
}

Main Schema start-time
Annotations
 
Description  Chapter start time
Diagram
Type number
Constraints
 
Minimum : 0
Used by
Schema
#/items
Source
 

 "start-time": {
  "type": "number",
  "minimum": 0,
  "description": "Chapter start time"
}

Main Schema duration
Annotations
 
Description  Chapter duration (optional)
Diagram
Type number
Constraints
 
Minimum : 0
Used by
Schema
#/items
Source
 

 "duration": {
  "type": "number",
  "minimum": 0,
  "exclusiveMinimum": true,
  "description": "Chapter duration (optional)"
}

Main Schema titles
#/items/properties/titles/items
Annotations
 
Description  List of titles by language for chapter (optional)
Diagram
Type array
Constraints
 
Unique Items : false
Array Items
Additional Items true
Used by
Schema
#/items
Source
 

 "titles": {
  "type": "array",
  "description": "List of titles by language for chapter (optional)",
  "items": {
    "type": "object",
    "description": "Title object",
    "required": [
      "language",
      "title"
    ],
    "properties": {
      "language": {
        "type": "string",
        "description": "BCP 47 language code; und for undefined"
      },
      "title": {
        "type": "string",
        "description": "Chapter title string"
      }
    }
  }
}

Main Schema titles/items
#/items/properties/titles/items/properties/language #/items/properties/titles/items/properties/title
Annotations
 
Description  Title object
Diagram
Type object
Properties
Name Occurrence
language
title
 required
required
Additional Properties true
Used by
Source
 

 "items": {
  "type": "object",
  "description": "Title object",
  "required": [
    "language",
    "title"
  ],
  "properties": {
    "language": {
      "type": "string",
      "description": "BCP 47 language code; und for undefined"
    },
    "title": {
      "type": "string",
      "description": "Chapter title string"
    }
  }
}

Main Schema language
Annotations
 
Description  BCP 47 language code; und for undefined
Diagram
Type string
Used by
Source
 

 "language": {
  "type": "string",
  "description": "BCP 47 language code; und for undefined"
}

Main Schema title
Annotations
 
Description  Chapter title string
Diagram
Type string
Used by
Source
 

 "title": {
  "type": "string",
  "description": "Chapter title string"
}

Main Schema images
#/items/properties/images/items
Annotations
 
Description  List of images for chapter (optional)
Diagram
Type array
Constraints
 
Unique Items : false
Array Items
Additional Items true
Used by
Schema
#/items
Source
 

 "images": {
  "type": "array",
  "description": "List of images for chapter (optional)",
  "items": {
    "type": "object",
    "description": "Image object",
    "required": [
      "image-category",
      "pixel-width",
      "pixel-height",
      "url"
    ],
    "properties": {
      "image-category": {
        "type": "string",
        "description": "Image category"
      },
      "pixel-width": {
        "type": "integer",
        "minimum": 0,
        "exclusiveMinimum": true,
        "description": "Pixel width"
      },
      "pixel-height": {
        "type": "integer",
        "minimum": 0,
        "exclusiveMinimum": true,
        "description": "Pixel height"
      },
      "url": {
        "type": "string",
        "description": "URL to image (relative or absolute)"
      }
    }
  }
}

Main Schema images/items
#/items/properties/images/items/properties/image-category #/items/properties/images/items/properties/pixel-width #/items/properties/images/items/properties/pixel-height #/items/properties/images/items/properties/url
Annotations
 
Description  Image object
Diagram
Type object
Properties
Name Occurrence
image-category
pixel-width
pixel-height
url
 required
required
required
required
Additional Properties true
Used by
Source
 

 "items": {
  "type": "object",
  "description": "Image object",
  "required": [
    "image-category",
    "pixel-width",
    "pixel-height",
    "url"
  ],
  "properties": {
    "image-category": {
      "type": "string",
      "description": "Image category"
    },
    "pixel-width": {
      "type": "integer",
      "minimum": 0,
      "exclusiveMinimum": true,
      "description": "Pixel width"
    },
    "pixel-height": {
      "type": "integer",
      "minimum": 0,
      "exclusiveMinimum": true,
      "description": "Pixel height"
    },
    "url": {
      "type": "string",
      "description": "URL to image (relative or absolute)"
    }
  }
}

Main Schema image-category
Annotations
 
Description  Image category
Diagram
Type string
Used by
Source
 

 "image-category": {
  "type": "string",
  "description": "Image category"
}

Main Schema pixel-width
Annotations
 
Description  Pixel width
Diagram
Type number
Constraints
 
Minimum : 0
Used by
Source
 

 "pixel-width": {
  "type": "integer",
  "minimum": 0,
  "exclusiveMinimum": true,
  "description": "Pixel width"
}

Main Schema pixel-height
Annotations
 
Description  Pixel height
Diagram
Type number
Constraints
 
Minimum : 0
Used by
Source
 

 "pixel-height": {
  "type": "integer",
  "minimum": 0,
  "exclusiveMinimum": true,
  "description": "Pixel height"
}

Main Schema url
Annotations
 
Description  URL to image (relative or absolute)
Diagram
Type string
Used by
Source
 

 "url": {
  "type": "string",
  "description": "URL to image (relative or absolute)"
}

Main Schema metadata
#/items/properties/metadata/items
Annotations
 
Description  List of metadata entries for chapter (optional)
Diagram
Type array
Constraints
 
Unique Items : false
Array Items
Additional Items true
Used by
Schema
#/items
Source
 

 "metadata": {
  "type": "array",
  "description": "List of metadata entries for chapter (optional)",
  "items": {
    "type": "object",
    "description": "Metadata object",
    "required": [
      "key",
      "value"
    ],
    "properties": {
      "key": {
        "type": "string",
        "description": "Key value name"
      },
      "value": {
        "description": "Metadata value",
        "anyOf": [
          {"type": "string"},
          {"type": "number"},
          {"type": "boolean"},
          {"type": "array"},
          {"type": "object"}
        ]
      },
      "language": {
        "type": "string",
        "description": "BCP 47 language code (optional)"
      }
    }
  }
}

Main Schema metadata/items
#/items/properties/metadata/items/properties/key #/items/properties/metadata/items/properties/value #/items/properties/metadata/items/properties/language
Annotations
 
Description  Metadata object
Diagram
Type object
Properties
Name Occurrence
key
value
language
 required
required
optional
Additional Properties true
Used by
Source
 

 "items": {
  "type": "object",
  "description": "Metadata object",
  "required": [
    "key",
    "value"
  ],
  "properties": {
    "key": {
      "type": "string",
      "description": "Key value name"
    },
    "value": {
      "description": "Metadata value",
      "anyOf": [
        {"type": "string"},
        {"type": "number"},
        {"type": "boolean"},
        {"type": "array"},
        {"type": "object"}
      ]
    },
    "language": {
      "type": "string",
      "description": "BCP 47 language code (optional)"
    }
  }
}

Main Schema key
Annotations
 
Description  Key value name
Diagram
Type string
Used by
Source
 

 "key": {
  "type": "string",
  "description": "Key value name"
}

Main Schema value
Annotations
 
Description  Metadata value
Diagram
Type object
Any of
Additional Properties false
Used by
Source
 

 "value": {
  "description": "Metadata value",
  "anyOf": [
    {"type": "string"},
    {"type": "number"},
    {"type": "boolean"},
    {"type": "array"},
    {"type": "object"}
  ]
}

Main Schema 0
Diagram
Type string
Used by
Source
 

 "#/items/properties/metadata/items/properties/value/0": {"type": "string"}

Main Schema value/1
Diagram
Type number
Used by
Source
 

 "#/items/properties/metadata/items/properties/value/1": {"type": "number"}

Main Schema value/2
Diagram
Type boolean
Used by
Source
 

 "#/items/properties/metadata/items/properties/value/2": {"type": "boolean"}

Main Schema value/3
Diagram
Type array
Constraints
 
Unique Items : false
Additional Items true
Used by
Source
 

 "#/items/properties/metadata/items/properties/value/3": {"type": "array"}

Main Schema value/4
Diagram
Type object
Additional Properties true
Used by
Source
 

 "#/items/properties/metadata/items/properties/value/4": {"type": "object"}

Main Schema language
Annotations
 
Description  BCP 47 language code (optional)
Diagram
Type string
Used by
Source
 

 "language": {
  "type": "string",
  "description": "BCP 47 language code (optional)"
}

JSON Schema documentation generated by ®