OpenTV ENTera & OpenTV Platform Documentation

technicalChannel (editorial-based)

Legend

Colour

Meaning


Mandatory for ingest, optional or not used for ION


Mandatory for ION, optional for ingest


Mandatory for both ingest and ION


Optional for ingest and optional or not used for ION

cmsData - technicalChannel

Elements

Fields/​attributes

Type

Required

Sample data

Description

ION

MDS

cmsData









technicalChannel


TechnicalChannelType

Optional


This element defines a technical channel

Not used


providerId

string

Mandatory

GLOBAL

Provider

Mandatory

companyId

providerResourceId

string

Mandatory

STCUEnabled_TechnicalLevel_New

Technical channel ID

Mandatory


name

string

Mandatory

STCUEnabled_New_LiveTechnicalChannel

Technical channel name

Mandatory

longName

deliveryUri

string

Optional

http://delivery.uri/dash/live/BBC_v1/28107e25-309c-a557-2f4e-ea2000868a6e/manifest.mpd

The location of the A/V stream of the channel on the network. Holds the URL for adaptive streaming.

Mandatory

NetworkLocation

profileIds

string

Optional

Profile_STCU_CIM_9089

The IDs of the profile applied to the technical channel (semicolon-separated)

Not used

profileRef

isFreeToAir

boolean

Optional

true

Whether the channel is free-to-air or not.

This is used by client applications to determine how and when to apply parental controls to the channel's events (only applicable for certain parental control bodies).



isMandatoryContentProtection

boolean

Optional

true

Whether client apps are required to enforce parental control for playback for the channel (typically for non-free-to-air channels).

This is used by client applications to determine how and when to apply parental controls to the channel's events (only applicable for certain parental control bodies).



dynamicRange

string

Optional

HDR10

The dynamic range of the content. Required for QuickMark watermarking.

Allowed values include but are not limited to: SDR, HDR10, HDR10+, HLG, and DV.

Multiple values are allowed. The default is SDR.



cmsData - technicalChannel - metadataSet(locale)

Elements

Fields/​attributes

Type

Required

Sample data

Description

ION

MDS

cmsData









technicalChannel










metadataSet(locale)



MetadataSetType

Optional


Language/country code in which the metadata set is written. It must conform to ISO-639 and ISO 3166-1. If the MetadataSet is not localised, the locale must be set to "none".

Not used

EpgDescription


locale


Mandatory



Mandatory


metadata


MetadataType

Optional



Not used

EpgElement

key="Title"

string

Optional

STCUEnabled_EditorialLevel_New_LiveTechnicalChannel

Technical channel title

Mandatory


key="ChannelNumber"

string

Optional

25

Rating for the technical channel

Mandatory


key="ShortName"

string

Optional

ESPN

Short name for technical channel

Mandatory

shortName

cmsData - technicalChannel - editorialChannelRef

Elements

Fields/​attributes

Type

Required

Sample data

Description

ION

MDS

cmsData









technicalChannel









editorialChannelRef


EditorialChannelType

Mandatory


Reference to the editorial channel containing this technical channel

Not used

mainChannelId

providerId

string

Mandatory

GLOBAL

Provider

Mandatory

companyId

providerResourceId

string

Mandatory

STCUEnabled_EditorialLevel_New

Editorial channel ID

Mandatory


cmsData - technicalChannel - securityInfo

Elements

Fields/​attributes

Type

Required

Sample data

Description

ION

MDS

cmsData









technicalChannel











securityInfo




SecurityInfoType

Optional


Element describing a set of data related to a specific security device (CAS, DRM)

Not used

securityInfo

id



string

Mandatory

drmid01

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 specified DRM/CAS device.

Mandatory

drmId

securityDeviceId



string

Mandatory

drmInstanceName01

ID of the security device (CAS or DRM) assigned

Not used

drmInstanceName

sessionGroupId



string

Optional


ID of the session group assigned to the channel (used for channel group session limits)



usageRule



string

Optional


Usage rule



qmWaterMark



string

Optional


Quickmark watermark details



cdnTokenDetails



CdnTokenType

Optional






cdnType


string

Optional


The CDN type (e.g., Broadpeak)




cdnId


string

Optional


The CDN ID (e.g., brdpk_cdn_id1)



metadataSet(locale)



MetadataSetType

Optional


Language/country code in which the metadata set is written. It must conform to ISO-639 and ISO 3166-1. If the MetadataSet is not localised, the locale must be set to "none".

Not used

EpgDescription


locale


Mandatory



Not used


metadata


MetadataType

Optional



Not used

EpgElement

key="CMS4MigratedData"

string

Optional

TRUE

Migrated from CMS4 in boolean

Not used


key="RetentionDuration"

string

Optional

12400

Duration to retain

Not used


key="Evt_id"

string

Optional

4536


Not used


cmsData - technicalChannel - timeShifting

Elements

Fields/​attributes

Type

Required

Sample data

Description

ION

MDS

cmsData









technicalChannel











timeShifting





Optional



Not used




shortTermCatchUpSupport

boolean

Optional

FALSE

Indicates if the short-term catch-up feature is activated for this event.

Not used

catchUpSupport



longTermCatchUpSupport

boolean

Optional

TRUE

Indicates if the long-term catch-up feature is activated for this event.

Not used

catchUpSupport



startOverSupport

boolean

Optional

TRUE

Indicates if the start over feature is activated for this event.

Not used

startOverSupport



networkPvrSupport

boolean

Optional

TRUE

Indicates if the NPVR feature is activated for this technical channel

Not used

networkPvrSupport

shortTermCatchUpParameters




Optional


Indicates if the short-term catch-up feature is activated for this technical channel.

Not used



sourceId

string

Optional

http://nagra.com/Content/HLS/CatchUp/channel(name=CNN,startTime={startTime},endTime={endTime})/index.m3u8

Identifier of the rolling-buffer stream providing short-term catch-up access. This identifier should be unique across technical channels delivered from the same encoder platform. Value syntax is specific to the encoder platform.

Optional



validityStartOffset

duration

Optional

P3Y6M4DT12H30M5S

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)

Optional



validityDuration

duration

Optional

P3Y6M4DT12H30M5S

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)

Optional


longTermCatchUpParameters




Optional


Indicates if the long-term catch-up feature is activated for this technical channel.

Not used



sourceId

string

Optional

http://nagra.com/Content/HLS/CatchUp/channel(name=CNN,startTime={startTime},endTime={endTime})/index.m3u8

Identifier of the rolling-buffer stream providing short-term catch-up access. This identifier should be unique across technical channels delivered from the same encoder platform. Value syntax is specific to the encoder platform.

Optional



validityStartOffset

duration

Optional

P3Y6M4DT12H30M5S

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)

Optional



validityDuration

duration

Optional

P3Y6M4DT12H30M5S

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)

Optional



purgeGracePeriod

duration

Optional

P3Y6M4DT12H30M5S

Offset from the technical content end date used to set the minimum purge date of the record. Positive value (compliant to ISO 8601 standard).

Not used


startOverParameters




Optional


Definition of the configuration parameters relative to the start over feature

Not used



startOverDeliveryUri

string

Optional

http://nagra.com/Content/HLS/StartOver/channel(name={serviceId},startTime={startTime})/index.m3u8

Specifies the template used to build the start over playout delivery URL.

Optional

StartOverLocation

networkPvrParameters


sourceId


string

Optional


Identifier of the rolling-buffer stream providing NPVR access. This identifier should be unique across technical channels delivered from the same encoder platform. Value syntax is specific to the encoder platform.

Optional


validityDuration


string

Optional

P3Y6M4DT12H30M5S

Validity duration from any NPVR contents start, allowing to define the end validity of the corresponding NPVR contents (compliant to ISO 8601 standard, for example, "P3Y6M4DT12H30M5S").

Optional