The editorialChannel element represents an editorial channel. Its top-level structure is shown in the following diagram:
Elements and attributes
| editorialChannel | |||
|---|---|---|---|
| XML Element | Type | Required | Description |
| Attribute: sourcePreference | string | Optional | Channel source preference |
| 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]
|
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> |
| periodToDelete | [PeriodWithOptionalStartEndType]
|
Optional | All Events of this editorial channel with Start and End included in the specified period will be deleted<dl><dt>start</dt><dd>Start date of the parent resource. A ISO 8601 compatible gmt datetime up to the second : yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against start will be true</dd><dt>end</dt><dd>End date of the parent resource. A ISO 8601 compatible gmt datetime up to the second: yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against end will be true.</dd></dl> |
| event | [EventType]
|
Optional | This element is deprecated for CMS-5 and used only for CMS-4 backward compatibility support. This element defines all editorial metadata for an event.<dl><dt>name</dt><dd>Working name of the resource (used usually to identify a resource in the operator UI)</dd><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> |
| channelEvents | [ChannelEventsType]
|
Optional | This element defines all editorial metadata for an channelSet.<dl><dt>startFrom</dt><dd>The duration start from date to be used to filter the results. ISO 8601 format up to the second but no time zone. Example: 2012-05-31T06:10:30Z.</dd><dt>endUntil</dt><dd>The duration end until date to be used to filter the results. ISO 8601 format up to the second but no time zone. Example: 2012-05-31T06:10:30Z.</dd></dl> |
| ppvEnabled | boolean
|
Optional | This Flag indicates if Channel can have PPV Events |
| timeShifting |
|
Optional | Data relative to the timeShifting feature<dl><dt>shortTermCatchUpSupport</dt><dd>Indicate if the Short Term Catch-Up feature is activated for this editorial channel.</dd><dt>longTermCatchUpSupport</dt><dd>Indicate if the Long Term Catch-Up feature is activated for this editorial channel.</dd><dt>startOverSupport</dt><dd>Indicate if the Start Over feature is activated for this editorial channel.</dd><dt>networkPvrSupport</dt><dd>Indicate if the network PVR feature is activated for this editorial channel.</dd></dl> |
| guardTime |
|
Optional | <dl><dt>start</dt><dd>Schedule event start accuracy given as an offset. It will be used for any record order to specify the capture start (event.start - start). The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS.If guardTime Start is not specified, capture start will equals event start. </dd><dt>end</dt><dd>Schedule event end accuracy given as an offset. It will be used for any record order to specify the capture end (event.end + end). The format is based on ISO 8601 with restricted allowed pattern: PnDTnHnMnS. If guardTime End is not specified, capture end will equals event end. </dd></dl> |
| images | [ImageSetType]
|
Optional | Set of images for this channel and associated metadata |
| parentalRatings | [ParentalRatingSetType]
|
Optional | Parental ratings used to decide suitability for certain audiences based on its content |
| clientControlsSet | [ClientControlsSet]
|
Optional | client Controls used to decide suitability for certain audiences based on its content |
| regionalSettings | [RegionalSettingSetType]
|
Optional | Regional details of the channel |
| dvbinfo | [DvbinfoTypes]
|
Optional | Digital video broadcasting (DVB) is a set of standards that define digital broadcasting using DVB satellite, cable and terrestrial broadcasting infrastructures. |
| aliases | [AliasesSet]
|
Optional | Define the attributes of aliases for editorial channel. |
| rights |
|
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> |
| csaiEnabled | boolean
|
Optional | This Flag indicates if EditorialChannel is csaiEnabled configured |
| period | [PeriodType]
|
Optional | This period allow to specify the start and end date of the editorialChannel<dl><dt>start</dt><dd>Start date of the parent resource. A ISO 8601 compatible gmt datetime up to the second : yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against start will be true</dd><dt>end</dt><dd>End date of the parent resource. A ISO 8601 compatible gmt datetime up to the second: yyyy-mm-ddThh:mm:ssZ. If not available, any query condition against end will be true.</dd></dl> |
Complex child elements
The following complex child elements are described in their own pages: