AssetStorageDataSpecSchema

Properties

container

• Type: string
• Required: Yes
• Description: The name of the storage container.

error

• Type: map
• Keys: string
• Values: string
• Required: No
• Description: A dictionary containing error information. This field will be populated in cases where no valid tracks are present.

exceptions

• Type: object (ExceptionsSchema)
• Required: No
• Description: A list of exceptions that occurred during the retrieval process. This is a non-critical field and will only be populated if an exception occurs.

additionalProperties

• Type: string
• Required: Yes

files

• Type: list of objects (FileSchema)
• Required: Yes
• Description: A list of files in the storage container. This only represents files present at the top-level of the container.
  • FileSchema Properties:
    • name: string (Required)
    • size: integer (Required)

folders

• Type: list of objects (FolderSchema)
• Required: Yes
• Description: A list of folders in the storage container.
  • FolderSchema Properties:
    • name: string (Required)
    • formatHint: string (Required)

periods

• Type: map
• Keys: string
• Values: object (Period)
• Required: No
• Description: A map of available content for each eligible file in the storage container. Typically just '0/index/edge'.

adaptation_set

• Type: list of objects (AdaptationSet)
• Required: No

accessibility

• Type: list of objects (Accessibility)
• Required: No

representation

• Type: list of objects (Representation)
• Required: No

audio_channel_configuration

• Type: list of objects (AudioChannelConfiguration)
• Required: No

role

• Type: list of objects (Role)
• Required: No

asset_identifier

• Type: object (AssetIdentifier)
• Required: No

resource_type

• Type: string (Required)

start

• Type: string (Optional)

tracks

• Type: map
• Keys: string
• Values: object (TrackSchema)
• Required: No

body

• Type: object (BodySchema)
• Required: Yes
• Properties:
  • audio: list of objects (AudioSchema) (Required)
    • AudioSchema Properties:
      • src: string (Required)
      • systemBitrate: string (Required)
      • systemLanguage: string (Required)
      • trackID: string (Required)
      • trackName: string (Required)
  • textstream: list of objects (TextStreamSchema) (Required)
    • TextStreamSchema Properties:
      • Scheme: string (Optional)
      • manifestOutput: string (Required)
      • parentTrackName: string (Required)
      • src: string (Required)
      • systemBitrate: string (Required)
      • timescale: string (Optional)
      • trackID: string (Required)
      • trackName: string (Required)
  • video: list of objects (VideoSchema) (Required)
    • VideoSchema Properties:
      • src: string (Required)
      • systemBitrate: string (Required)
      • systemLanguage: string (Required)
      • trackID: string (Required)
      • trackName: string (Required)

head

• Type: object (HeadSchema)
• Required: Yes
• Properties:
  • availabilityStartTime: string (Required, format: date-time)
  • clientManifestRelativePath: string (Required)
  • compatVersion: string (Required)
  • extra: map
  • formats: string (Required)
  • fragmentsPerHLSSegment: string (Required)