Skip to main content

BTV Service data model

Name
Type
Description
Localised
Always available
_idString

Internal identifier for the object.

NoYes
activeBooleanWhether the channel is active.NoYes
CarryingNetworkArray of stringsList of values representing the list of DVB triplets linked to this channel.
The decimal value calculation according to DVB triplet is customer dependent.
NoYes
catchUpSupportBooleanWhether the operator supports catch-up events on this channel.NoYes
CategoriesArray of strings

A list of keywords classifying the content of the channel.
CMS supports these keywords:

  • Action
  • Action-Adventure
  • Adult
  • Adventure
  • Children
  • Comedy
  • Documentary
  • Drama
  • EnEspanol
  • Family
  • Horror
  • International
  • Kids-Family
  • Library
  • NewRelease
  • Romance
  • ScienceFiction
  • SciFi-Horror
  • Sport
  • Suspense
  • Suspense-Thriller
  • ThreeDayRental
  • Thriller
  • Uncensored
  • War
NoNo
companyIdStringThe ID of the broadcaster company to which the channel is attached.

This field is not required, but the CMS always populates it.

NoNo
DescriptionStringA description of the channel, from the CMS Service EPG key Description.YesNo
drmInstanceNameStringA name that uniquely identifies the DRM system that manages access to this channel.
For channels protected by CAS (not DRM), this attribute is not present.
NoNo
drmIdStringThe identifier of the channel used by the DRM system that managies access to this channel.
Values of drmId will only be unique within a particular DRM instance. A drmId value will always be present when a drmInstanceName value is supplied.
For channels protected by CAS (not DRM), this attribute is not present.
NoNo
idStringThe CMS's identifier for the object.NoYes
localeStringThe locale used for the object's localisable fields. NoNo
longNameStringThe channel’s long name, for example, “The Biography Channel”.

This field is not required, but the CMS always populates it.

This field is not localised. Multi-language clients should use the Title field instead.

NoNo
NetworkLocationString

The location of the A/V stream of the channel on the network. For adaptive streaming, this will be the channel's URL.
In case of Harmonic OS, the value must be of the form:

http://<delivery-ip>/Content/
HLS/Live/Channel(<channel-name>)
/index.m3u8
NoNo
PrivateMetadataStringUsed to pass data directly from the operator 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.
NoNo
profileRefStringThe identifier of the profile that applies to this channel.NoNo
PromoImagesArray of stringsA list of promo image URLs for the channel.
The Metadata Server does not validate the format of this field’s value, and does not attempt to access the URLs to verify the existence of the image files.
NoNo
productRefsArray of stringsA list of the IDs of the products that offer this channel.NoNo
providerStringThe identifier of the metadata provider, from the id of the export's CMSBtvData element.NoYes
Rating.codeStringParental rating code (from CMS).NoYes
Rating.precedenceIntegerQuantitative rating value.NoYes
Rating.nameStringLocalised name for the rating, for example, Adult or Adulto.YesYes
shortNameStringA short name for the channel, or its call letters.NoNo
startOverSupportBooleanWhether the operator supports start-over events on this channel.NoYes
TitleStringThe full name of the channel.

The CMS mandates that this field will be populated for at least one locale-form of each channel.

YesNo
tvChannelIntegerThe channel number to be presented to the end user.NoYes
typeStringPresent on an editorial channel. If the channel originates from the CMS ingest this will be set to BTV.NoYes
xmlStringThe type of object. Always editorial.NoYes
nls.TitleStringNative language support for the title field. Allows correct sorting for a language, rather than relying on utf-8 ordering for sort.YesNo
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.