OpenTV ENTera & OpenTV Platform Documentation

technicalChannel

The technicalChannel element represents a technical channel. Its structure is shown in the following diagram:

technicalChannel.png

Elements and attributes

technicalChannel
XML Element Type Required Description
Attribute: start string Optional The start date of the Technical channel. This attribute is optional. ISO 8601 format up to the second and using the "Z" GMT time zone indicator. Example: 2012-05-31T06:10:30Z.
Attribute: end string Optional The end date of the Technical channel. This attribute is optional. ISO 8601 format up to the second and using the "Z" GMT time zone indicator. Example: 2012-05-31T06:10:30Z.
Attribute: deliveryUri string Optional Intended to provide the location of the A/V stream of the channel on the network. Used to hold the URL for adaptive streaming
Attribute: profileId anySimpleType Optional DEPRECATED Weak reference to the id of the profile characterizing the technical channel
Attribute: profileIds anySimpleType Optional Weak references to the ids of profiles characterizing the technical channel. This list is semicolon separated. If "profileId" and "profileIds" both present "profileIds" will be considered, as "profileId" is going to be deprecated
Attribute: isFreeToAir boolean Optional isFreeToAir of the Technical channel. This attribute is optional.These value should be true or false
Attribute: isMandatoryContentProtection boolean Optional isMandatoryContentProtection of the Technical channel. This attribute is optional.These value should be true or false
Attribute: name string Required Working name of the resource (used usually to identify a resource in the operator UI)
Attribute: providerId string Required id of the content provider
Attribute: providerResourceId string Required id of the resource for this specific content provider
metadataSet [MetadataSetType]
  • Occurrence0..unbounded
Optional This element defines a specific set of metadata for a specific locale. Only one MetadataSet per locale is allowed.<dl><dt>locale</dt><dd>Language-country code in which the metadata set is written. It must be conformed to ISO-639 and ISO 3166-1. If the MetadataSet is not localised, the locale must be set to "none".</dd></dl>
MetadataSetType / metadata [MetadataType]
  • Occurrence0..unbounded
Optional Metadata editorial or not of the metadata owner. The different metadata allowed and their definition must be defined outside of the scheme<dl><dt>key</dt><dd>Metadata key. it must be unique for a specific resource and for a specific locale.</dd></dl>
editorialChannelRef [BaseResourceType]
  • Occurrence1
Required Reference to the editorial channel containing this technical channel.<dl><dt>providerId</dt><dd>id of the content provider</dd><dt>providerResourceId</dt><dd>id of the resource for this specific content provider</dd></dl>
securityInfo [SecurityInfoType]
  • Occurrence0..1
Optional Element describing a set of data related to a specific security device (CAS, DRM).<dl><dt>id</dt><dd>DRM or CAS id of the element for the specified security device (DRM or CAS). This DRM/CAS id is only valid in the context of the DRM/CAS device specified</dd><dt>securityDeviceId</dt><dd>Id of the security device (CAS or DRM) assigned to the content.</dd><dt>sessionGroupId</dt><dd>Id of the session group assigned to the content.</dd><dt>usageRule</dt><dd>This field defines the Definition of the channel.</dd><dt>qmWatermark</dt><dd>The requirement here is the ability to select individual content to be watermarked.</dd></dl>
SecurityInfoType / cdnTokenDetails [CdnTokenType]
  • Occurrence0..1
Optional This feature is going to enable customers to enable playback for contents which is protected by CDN tokens.
CdnTokenType / cdnType string
  • Whitespacepreserve
  • Occurrence0..1
Optional cdnType
CdnTokenType / cdnId string
  • Whitespacepreserve
  • Occurrence0..1
Optional cdnId
SecurityInfoType / metadataSet [MetadataSetNoLocaleType]
  • Occurrence0..1
Optional The Metadata Set Type which defines a specific set of metadata for the locale "none"<dl><dt>locale</dt><dd>locale will be set to "none" as it is not localised</dd></dl>
MetadataSetNoLocaleType / metadata [MetadataType]
  • Occurrence0..unbounded
Optional A metadata.<dl><dt>key</dt><dd>Metadata key. it must be unique for a specific resource and for a specific locale.</dd></dl>
timeShifting
  • Occurrence0..1
Optional Data relative to the timeShifting feature<dl><dt>networkPvrSupport</dt><dd>Indicate if the network PVR feature is activated for this Technical channel.</dd><dt>shortTermCatchUpSupport</dt><dd>Indicate if the Short Term Catch-Up feature is activated for this technical channel.</dd><dt>longTermCatchUpSupport</dt><dd>Indicate if the Long Term Catch-Up feature is activated for this technical channel.</dd><dt>startOverSupport</dt><dd>Indicate if the Start Over feature is activated for this technical channel.</dd></dl>
shortTermCatchUpParameters
  • Occurrence0..1
Optional Definition of the configuration parameters relative to the Short Term Catch-Up feature
sourceId string
  • Whitespacepreserve
  • Occurrence1
Required Identifier of the rolling-buffer stream providing Short Term Catch-Up access. This identifier should be unique cross technical channels delivered from the same encoder platform. Value syntax is specific to the encoder platform.
validityStartOffset duration
  • Whitespacecollapse
  • Occurrence1
Required Offset from any Short Term Catch-Up event end allowing to define the start validity of the corresponding Short Term Catch-Up contents (compliant to ISO 8601 standard. Ex: "P3Y6M4DT12H30M5S")
validityDuration duration
  • Whitespacecollapse
  • Occurrence1
Required Validity duration from any Short Term Catch-Up contents start allowing to define the end validity of the corresponding Short Term Catch-Up contents (compliant to ISO 8601 standard. Ex: "P3Y6M4DT12H30M5S")
longTermCatchUpParameters
  • Occurrence0..1
Optional Definition of the configuration parameters relative to the Long Term Catch-Up feature
sourceId string
  • Whitespacepreserve
  • Occurrence1
Required Identifier of the source stream to be recorded (id or URI). This identifier should generally be unique cross technical channels.
validityStartOffset duration
  • Whitespacecollapse
  • Occurrence1
Required Offset from any Long Term Catch-Up event end allowing to define the start validity of the corresponding Short Term Catch-Up contents (compliant to ISO 8601 standard. Ex: "P3Y6M4DT12H30M5S")
validityDuration duration
  • Whitespacecollapse
  • Occurrence1
Required Validity duration from any Long Term Catch-Up contents start allowing to define the end validity of the corresponding Short Term Catch-Up contents (compliant to ISO 8601 standard. Ex: "P3Y6M4DT12H30M5S")
purgeGracePeriod duration
  • Whitespacecollapse
  • Occurrence1
Required Offset from the technical content end date used to set the minimum purge date of the record. Positive value. (compliant to ISO 8601 standard. Ex: "P3Y6M4DT12H30M5S")
startOverParameters
  • Occurrence0..1
Optional Definition of the configuration parameters relative to the Start Over feature
startOverDeliveryUri string
  • Whitespacepreserve
  • Occurrence1
Required Specify the template to build the Start Over play out delivery URL.
networkPvrParameters
  • Occurrence0..1
Optional Definition of the configuration parameters relative to nPVR feature.
sourceId string
  • Whitespacepreserve
  • Occurrence1
Required Identifier of the rolling-buffer stream providing nPVR access. This identifier should be unique cross technical channels delivered from the same encoder platform.Value syntax is specific to the encoder platform.
validityDuration duration
  • Whitespacecollapse
  • Occurrence1
Required Validity duration from any nPVR contents start allowing to define the end validity of the corresponding nPVR contents (compliant to ISO 8601 standard. Ex: "P3Y6M4DT12H30M5S")
dynamicRange string
  • Whitespacepreserve
  • Occurrence0..unbounded
Optional Intended to provide the dynamic range capability.
rights
  • Occurrence0..1
Optional Set of properties describing the consumption capabilities of a content <dl><dt>storageAllowed</dt><dd>Allow a client to download the Content </dd></dl>

Complex child elements

The following complex child elements are described in their own pages: