Metadata APIs

Support in HbbTV

Available since: HbbTV 1.5 (ETSI TS 102 796 V1.2.1, OIPF DAE V1.2)

This section defines the JavaScript APIs used by DAE applications for reading and searching metadata about programmes. This API does not specify whether these query operations are carried out on the OITF or whether they require communication with a server.

The metadata API provides DAE applications with high-level access to metadata about programmes and channels. This document describes the mapping between this API and CoD and programme guide metadata. Mappings between this API and other metadata sources are not specified in this document.

This section SHALL apply for OITFs that have indicated <clientMetadata> with value “true” and a “type” attribute with value “bcg” or “dvb-si” as defined in section 9.3.7 in their capability.

Note that in order to access the metadata of programmes and channels several extensions to the Programme and Channel classes have been defined when the OITF has indicated support for <clientMetadata>. See sections “Metadata extensions to Programme” and “Metadata extensions to Channel” for more information).

The functionality as described in this section is subject to the security model of section 10 (in particular section