OpenTV ENTera & OpenTV Platform Documentation

metadataSet (child of editorialChannel > channelEvents > event)

The metadataSetelement represents metadata for the event. Its structure is shown in the following diagram:

5781ee9baa3ac4b425b21351d8b37260.png

Elements and attributes

metadataSet
XML Element Type Required Description
Attribute: locale string Required 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".
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>

Specific metadata for event

The following metadata fields are used in event:

Key name

Description

Notes

Title

The event title


Description

Description of the event


broadcastEventId

The broadcast event ID.

This value should typically match the one in the DVB Event Information Table (EIT), allowing client applications to cross-reference actual (DVB) to expected (Platform) events.

Note that this must be defined in the metadata locale="none" block.


serverGlobalBlackoutControl

Specifies whether the event should be blacked out according to the defined blackout rules.


BlackoutControlRulesetId

The ID of the blackout ruleset that applies to the event.

These rules must be added in OpCon.

You can find the ruleset ID using the config-manager GET /admin/v1/blackoutRules endpoint – see config-manager API documentation.


filteringList

A comma-separated list of country codes, used for geo-filtering

These fields are related to geofiltering and geoblocking. They can be set at both channel and event level.

If one is set at the channel level, it cannot be overridden at the event level. The channel setting always takes precedence.

filteringListIsAllowList

Specifies whether filteringList is an allowed list (true) or a restricted list (false)

blockingList

A list of country codes where playback is allowed

blockVpn

A global per operator value to indicate if VPN blocking is turned on or off (true or false)

blockIfOffNet

Filtering of content for on/off network (true or false)

blockingListIsAllowList

Indicates if the blockingList is an allowed list or not.

EntityType

Entity type setting the contentType on the generated editorial content


recommendable

Whether the event should be included in recommendations from the recommendation engine. Default: true. Must be in the "locale": "none" block.