Developer Portal

Developer Guide API Reference News & Insight Deployments Showcase

Developer Guide API Reference News & Insight Deployments Showcase

Browse the API Reference

Developer Guide API Reference

API reference introduction

Application Management

application/oipfApplicationManager object
Application class
ApplicationPrivateData class
Keyset class
Application management examples

Configuration and Capabilities

application/oipfConfiguration object
Configuration class
application/oipfCapabilities object
UI profiles

Broadcast Video Management

video/broadcast embedded object
ChannelConfig class
ChannelList class
Channel class
Resource Management

Media Playback APIs

The A/V Control object
Extensions to A/V Control object for playback through Content-Access Streaming Descriptor
Extensions to A/V Control object for trickmodes
Extensions to A/V Control object for playback of selected components
Extensions to A/V Control object for parental rating errors
Extensions to A/V Control object for DRM rights errors
Extensions to A/V Control object for playing media objects
DOM events for A/V Control object
Playback of memory audio

The application/oipfSearchManager embedded object
The MetadataSearch class
The Query class
The SearchResults class

Content Service Protection API

The application/oipfDrmAgent embedded object

Parental Rating and Parental Control APIs

The oipfParentalControlManager embedded object
The ParentalRatingScheme class
The ParentalRatingSchemeCollection class
The ParentalRating class
The ParentalRatingCollection class

Miscellaneous APIs

Debug print API

Object factory API

Methods
Examples

Defined JavaScript APIs

Acquisition of DSM-CC stream events
Carousel objects access with XMLHttpRequest
APIs for media synchronization
APIs for obtaining the LCN of a service
Companion Screen discovery APIs

Shared Utility Classes and Features

AVComponent class
AVVideoComponent class
AVAudioComponent class
AVSubtitleComponent class
AVComponentCollection class
Base collections
Programme class
ProgrammeCollection class
Extensions for playback of selected media components
Additional support for protected content

Scheduled Recording APIs

Extensions to video/broadcast for recording and time-shift
The application/oipfRecordingScheduler embedded object
The ScheduledRecording class
The ScheduledRecordingCollection class
Extension to application/oipfRecordingScheduler for control of recordings
The Recording class

Content Download APIs

The application/oipfDownloadTrigger embedded object
The application/oipfDownloadManager embedded object
The Download class
The DownloadCollection class
The DRMControlInformation class
The DRMControlInfoCollection class
APIs for automatic deletion of downloaded content

Communication Services APIs

The application/oipfCommunicationServices embedded object
Extensions to application/oipfCommunicationServices for presence and messaging services
The UserData class
The UserDataCollection class
The FeatureTag class
The FeatureTagCollection class
The Contact class
The ContactCollection class
Extensions to application/oipfCommunicationServices for voice telephony services
Extensions to application/oipfCommunicationServices for video telephony services
The DeviceInfo class
The DeviceInfoCollection class
The CodecInfo class
The CodecInfoCollection class

Content on Demand Metadata APIs

The application/oipfCodManager embedded object
The ContentCatalogueCollection class
The ContentCatalogue class
The ContentCatalogueEvent class
The CODFolder class
The CODAsset class
The CODService class

Gateway Discovery and Control APIs

The application/oipfGatewayInfo embedded object

Miscellaneous APIs

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

Debug print API

← PreviousThe ParentalRatingCollection class Next →Debug print API

© 2026 HbbTV Association · Geneva, Switzerland

HbbTV Cookie Policy Privacy Policy