Extensions to A/V Control object for playing media objects

Available since: HbbTV 1.0 (ETSI TS 102 796 V1.1.1, OIPF DAE V1.1)
Security: Trusted

Support in HbbTV

Shall be supported if either the download or PVR features are supported.

Calls to the setSource() method where id is a recording identifier shall result in the type attribute being set to “video/mpeg” regardless of the format in which the content is recorded.

Base definition (OIPF DAE)

OITFs that support the API defined in sections 7.12, 7.4.6 and 7.4 SHALL support playback of downloaded and / or recorded content as follows:

Firstly, by setting the data attribute of the A/V Control object to that returned from the uri property of the Download or Recording object to be played back.
Using the method defined below on the A/V Control object which SHALL be supported if any of the APIs defined in those sections are supported.
where the HTML5 media elements are supported (see section 9.3.17), by setting the src attribute of a <video> element to that returned from the uri property of the Download or Recording object to be played back.

Boolean setSource( String id )

Description

Change the content item to be played by the A/V Control object to the content item represented by id. Valid IDs include:

· Download identifiers (i.e. corresponding to property Download.id)

· Recording identifiers (i.e. corresponding to property Recording.id)

· CODAsset identifiers (i.e. corresponding to property CODAsset.uid)

Support for each of these identifier types depends on the support for the individual sections in which they are defined.

Depending on the type of content for id, the following semantics apply:

If id is a download identifier, the OITF SHALL change the content item to be played to the downloaded item, or item being downloaded, for which the Download.id property (as defined in section 7.4.4.1) corresponds to the given download identifier. The type attribute of the A/V Control object SHOULD change to the MIME type of the content item represented by the download identifier, or the MIME type of the content item corresponding to the first content item listed in the Content Access Download Descriptor in case the download identifier represents a download of a Content Access Download Descriptor that contains multiple <ContentItem> elements. The data attribute SHALL change to the same value as the download identifier. Section 7.14.1.5 defines more details about playback of downloaded content, and how it relates to the states of the A/V Control object.

If id is a recording identifier, the OITF SHALL change the content item to be played to the recorded item, or item being recorded, for which the Recording.id property (as defined in section 7.10.5.1) corresponds to the given recording identifier. The type attribute of the A/V Control object SHOULD change to the MIME type of the format in which the content was recorded. The data attribute SHALL change to the same value as the recording identifier.

If id is a COD asset identifier, the OITF SHALL change the content item to be played to the CODAsset, for which the CODAsset.uid property (as defined in section 7.5.6.1) corresponds to the given COD asset identifier. The type attribute of the A/V Control object SHOULD change to the MIME type of the COD Asset. The data attribute SHALL change to the same value as to COD asset identifier.

If the content item represented by id can be accepted by the A/V Control object for playback, the method returns true. The method returns false if the item cannot be accepted for playback.

Arguments

The ID of the item to be played.

Help us improve the HbbTV Developer Portal. If you spot an issue, have a question, or would like to suggest an improvement to the API Reference or Developer Guide, please let us know by raising an issue on GitHub.