VOD Promotion data model
This object represents a trailer or "promotion" in CMS terms. The objects are organised in a two-level hierarchy. The second level, or promotion "version" holds the details of the playable media file and its metadata. The top-level, or "main" promotion is a container to group together the different media of the same trailer.
Name | Type | Description | Localised | Always available |
|---|---|---|---|---|
_id | String | Internal identifier for the object. | No | Yes |
Definition | String | The video definition. One of HD, SD, or 3D. | No | No |
duration | Number | The approximate duration of the trailer, in seconds. | No | Yes |
id | String | The CMS identifier for the object. | No | Yes |
media | Sub-object | The media details of the promo. Will only be present in promotion versions. | No | Yes |
media.{format} | Sub-object | The format of the media object. | No | No |
media.{format}.fileName | String | The endpoint filename. | No | No |
media.{format}.frameDuration | Number | The duration of the trailer in frames. | No | No |
media.{format}.format | String | The format of the media promotion. | No | No |
media.{format}.id | String | The ID of the media promotion. | No | No |
PrivateMetadata | String | Generic field used to pass directly data from the customer to the end-user device without any CMS/SDP processing. One possible use is to pass a list of keyword/value pairs, separated by semi-colons. | No | No |
profileRef | String | The CMS ID of the associated encoding profile. Will only be present in promotion versions. | No | No |
provider | String | The identifier of the metadata provider, from the ID of the export's | No | Yes |
technicals | Sub-object | The parent main promotion's child technicals. (There can be one or more.) A list of "VOD Promotion" objects, that is, as defined in this page. Will not be present in promotion versions. Since MDS 1.1. | No | No |
title | String | The title of the trailer. | No | Yes |
voditem | Sub-object | A VOD item containing scheduling information about the promotion. Will only be present in promotion versions. For further details, see VodItem Data Model. Since MDS 1.1. | No | No |