BTV Series data model
Name | Type | Description | Localised | Always available |
---|---|---|---|---|
_id | String | Internal identifier for the object. | No | Yes |
Actors | Array of strings | A list of actors. For example:
| No | No |
Aspect | String | The aspect ratio, for example, 16:9 or Widescreen . | No | No |
Audio | Array of strings | A list of "locale-type" patterns representing the audio streams available for this series.
For example:
| No | No |
AudioMode | String | The audio mode. For example, Mono , SRS , THX , 5.1 , Nicam Stereo , or Dual Mono . | No | No |
BestSalesIndex | Integer | Sales index (position) for use in "Top" lists (for example, Top 10 Best Selling). These are positive numbers, starting at 1. If -1 or not present, this series is not in any "Top n" index. | No | No |
Categories | Array of strings | A list of operator-defined category or genre names for this series. | No | No |
ContentType | String | Free text. Used for implementation-specific data. | No | No |
CopyProtections | String | A list of usage rules for controlling certain hardware outputs to prevent unauthorised content copying. For example:
If the value is 0 or not present, there is no restriction. | No | No |
Copyright | String | A copyright message. | No | No |
Countries | Array of strings | A string of two-letter ISO codes representing countries relevant to this series. | No | No |
Definition | String | The video definition. One of HD , SD , or 3D . | No | No |
Description | String | The description of the series. | Yes | No |
Directors | Array of strings | A list of directors. | No | No |
DvbCategories | Array of strings | Array of DVB genres and sub-genres. | No | No |
Episode | String | Episode text string. | Yes | No |
IsRecordable | Boolean | Whether the end user is allowed to record this series. | No | No |
Language | String | The original language of the series (three-letter ISO language code). | No | No |
nls.Title | String | Native language support for the title field, which allows it to be sorted correctly in the local languare rather than using UTF-8 ordering. | ||
PrivateMetadata | String | Generic field used to pass data directly from the operator to the end-user device without any processing. One possible use is to pass a list of keyword/value pairs. | No | No |
Producers | Array of strings | A list of producers. | No | No |
PromoImages | Array of strings | A list of promo image URLs. Must contain only URL-safe characters. | No | No |
provider | String | The identifier of the metadata provider, from the id of the export's CMSVodData element. | No | Yes |
Rating.code | String | Parental rating code (from CMS). | No | Yes |
Rating.name | String | Localised name for the rating, for example, Adult orAdulto . | Yes | Yes |
Rating.precedence | Integer | Quantitative rating value. | No | Yes |
Scoring | Integer | Score of the series. | No | No |
ShortTitle | String | The short name of the content. | Yes | No |
Studio | String | The content owner. | No | No |
Subtitles | String | A list of “locale-type” patterns representing the subtitle streams available for this series.
Example:
| No | No |
Synopsis | String | A longer description of the series. | Yes | No |
title | String | The name of the series. This field is not localised. Multi-language clients should use the | No | Yes |
Title | String | The name of the series. The CMS mandates that this field will be populated for at least one locale-form of the asset. | Yes | Yes |
TotalDownloads | Integer | Total number of downloads of the series (or of episodes within the series, according to the operator's preference). | No | No |
ViewingCounter | Integer | Number of times a piece of content has been viewed. | No | No |
ViewingNumber | Integer | How many times a user can watch the series (or episodes within it) once purchased. If 0 or not present, there is no limitation. | No | No |
Year | Integer | The year of production of the content. | No | No |