BTV Programme data model
Name | Type | Description | Localised | Always available |
---|---|---|---|---|
_id | String | Internal identifier for the object. | No | Yes |
Actors | Array of strings | The actors associated with the programme. | No | No |
Aspect | String | The aspect ratio.
| No | No |
Audio | Array of strings | A list of “locale-type” patterns representing the audio streams available for this content.
For example:
| No | No |
AudioMode | String | The audio mode. For example, | No | No |
Categories | Array of strings | The operator-defined category or genre names that apply to this content. | No | No |
Copyright | String | A copyright message. | Yes | No |
Countries | Array of strings | The two-letter ISO codes representing countries that apply to this programme. | No | No |
Definition | String | The video definition. One of: HD , SD , or 3D. | No | No |
Description | String | The description of the programme. | Yes | No |
Directors | Array of strings | The directors associated with the programme. | No | No |
editorial | BTV Content data model object | The associated parent editorial of this programme. | No | No |
editorial.technicals | Array of BTV Content data model objects | The child technicals of the associated editorial. | No | No |
Episode | String | Localised text representation of the index of the episode in the series. This field is used to display the episode number.
| Yes | No |
eventId | Number | The ID of the scheduled programme. | No | No |
id | String | The CMS's identifier for the object. | No | Yes |
isCatchUp | Boolean | Whether the time-shift “catch-up” function is available for this event. | No | No |
IsRecordable | Boolean | Whether the end user is allowed to record this series. | No | No |
isStartOver | Boolean | Whether the time-shift “start-over” function is available for this event. | No | No |
IsTimeshifted | Boolean | Whether the programme is a time-shifted broadcast of an earlier programme. Typically used for "+1 hour" channels. | No | No |
Language | String | The original language of the content (three-letter ISO language code). | No | No |
locale | String | The locale used for the object's localisable fields. | No | Yes |
nls.Title | String | The native language support for the title field – allowing for sorting according to the native language, rather than utf-8 order, as would be done through the Title field itself. | Yes | No |
period | JSON object (see below) | Details of the broadcast schedule for this programme. | No | Yes |
period.duration | Number | The length of time this item will appear in the catalogue, in seconds. If not supplied, the duration is omitted, not calculated. | No | No |
period.end | String: a date and time in ISO 8601 format | The end time of the broadcast event. | No | Yes |
period.providerId | String | The identifier of the metadata provider, from the ID of the export's CMSVodData element. | No | Yes |
period.start | string: a date and time in ISO 8601 Sormat | The start time of the broadcast event. | No | Yes |
PrivateMetadata | String | Generic field used to pass directly data from the operator to the end-user device without any processing. One possible use is to pass a list of keyword/value pairs separated by semi-colons. | No | No |
Producers | Array of strings | The producers associated with the programme. | No | No |
productRefs | Array of strings | The CMS IDs of the products that provide access to this programme. | No | No |
profileRef | String | The CMS ID of the encoding profile that applies to this asset. | No | No |
PromoImages | Array of strings | The URLs of promo images. Must be composed of URL-safe characters only. | No | No |
provider | String | The identifier of the metadata provider, from the id of the export's CMSBtvData element. | No | Yes |
Rating.code | String | Parental rating code (from CMS). | No | Yes |
Rating.name | String | Localized name for the rating, for example, Adult or Adulto . | Yes | Yes |
Rating.precedence | Integer | Quantitative rating value. | No | Yes |
RecommendedProgrammeIds | Array of strings | The CMS programme IDs recommended for this programme (information taken from a recommendation engine or from the customer) with rank (a positive integer, where a higher number means a stronger recommendation) using the following pattern:
A referenced programme might be scheduled before or after the current one, and might be on a different channel. | No | No |
RecommendedVodItemIds | Array of strings | The CMS
| No | No |
serviceRef | String | The CMS ID of the channel carrying the programme. | No | Yes |
ShortTitle | String | The short form of the title of this programme. Indended for use on devices with limited space. | Yes | No |
SOCU_filename | String | Name of the asset file when this event is available via catch-up or start-over functionality. | No | No |
Studio | String | The name of the owner of the content broadcast in this programme. | No | No |
Subtitles | String | A list of “locale-type” patterns representing the subtitle streams available for this content.
For example:
| No | No |
Synopsis | String | A longer description of the programme. | Yes | No |
title | String | The name of the programme. This field is not localised. Multi-language clients should use the | No | Yes |
Title | String | The title of the programme displayed to the user. The CMS mandates that this field will be populated for at least one locale-form of the asset. | Yes | No |
type | String | The domain of the object, always btv in this case. | No | No |
xml | String | The type of the object. In this case, always Programme . | No | Yes |
Year | String | The year of production of the content. | No | No |