The application/oipfCodManager embedded object
Support in HbbTV
Available since: Not implemented in HbbTV
OITFs that have indicated <clientMetadata> with value “true” and a “type” attribute with value “bcg” SHALL implement an “application/oipfCodManager” embedded object with the following interface.
Content is organised into catalogues, where each catalogue contains a hierarchy of folders that are used to organise individual content items. The structure of the catalogue SHALL be determined by the server managing that catalogue and SHALL be reflected in the structure of the metadata passed to the OITF.
The three types of content in a CoD catalogue are:
- Assets, represented by the CODAsset class. A CODAsset is a user-level description of a piece of CoD content, and so it is more concerned with information such as the price, rental period, description and parental rating rather than detailed technical information about the asset such as encoding format. A CoD asset MAY represent a single movie, or a bundle of movies offered for a single price.
- Folders, represented by the CODFolder class.
- Services represented by the CODService class. CODService objects are a specific type of container representing subscription VoD (SVOD) services, where users purchase a group of assets which may change over time rather than a single movie or TV show.
The CODAsset, CODFolder and CODService classes define a type property that allows these classes to be distinguished by applications. For each class, this property SHALL take the value defined below:
| Class | Value |
| CODFolder | 0 |
| CODAsset | 1 |
| CODService | 2 |
This specification defines the mapping between the CoD API and BCG metadata. Mappings between the CoD API and other CoD metadata sources are not specified in this document.
Properties
| readonly ContentCatalogueCollection catalogues |
| A collection of all available CoD catalogues, as listed in an SD&S BCG Discovery record. |
| function onContentCatalogueEvent( Integer action ) |
| This function is the DOM 0 event handler for events relating to changes in a content catalogue collection. The specified function is called with the argument action: · Integer action – The type of event. For current versions of the specification, this property SHALL always have the value 0 to indicate a change in the list of available catalogues. |
function onContentAction( Integer action, Integer result, Object item, | ||||||||||||||||
This function is the DOM 0 event handler for events relating to actions carried out on an item in a content catalogue. The specified function is called with the following arguments: · Integer action – The type of action that the event refers to. Valid values are:
· Integer result – The result of the action. Valid values are:
· Object item – The item in the catalogue that the event refers to. · ContentCatalogue catalogue – The parent catalogue of the affected object. |
Events
For the intrinsic events listed in the table below, a corresponding DOM event SHALL be generated in the following manner:
| Intrinsic event | Corresponding DOM event | DOM Event properties |
| onContentCatalogueEvent | ContentCatalogueEvent | Bubbles: No Cancellable: No Context Info: action |
| onContentAction | ContentAction | Bubbles: No Cancellable: No Context Info: action, result, item, catalogue |
NOTE: the above DOM events are directly dispatched to the event target, and will not bubble nor capture. Applications SHOULD NOT rely on receiving the events listed above during the bubbling or the capturing phase. Applications that use DOM event handlers SHALL call the addEventListener() method on the LocalSystem object. The third parameter of addEventListener, i.e. “useCapture”, will be ignored.