DVBCore  22.11.0
Open Source DVB Engine
Enumerations | Functions
hbbtv_api.h File Reference

Application level HBBTV callback functions. More...

#include "techtype.h"

Go to the source code of this file.

Enumerations

enum  E_HBBTV_CHANNEL_CHANGE_STATUS {
  HBBTV_CHANNEL_CHANGE_WRONG_TUNER, HBBTV_CHANNEL_CHANGE_NO_SIGNAL, HBBTV_CHANNEL_CHANGE_TUNER_IN_USE, HBBTV_CHANNEL_CHANGE_PARENTAL_LOCKED,
  HBBTV_CHANNEL_CHANGE_ENCRYPTED, HBBTV_CHANNEL_CHANGE_UNKNOWN_CHANNEL, HBBTV_CHANNEL_CHANGE_INTERRUPTED, HBBTV_CHANNEL_CHANGE_RECORDING_IN_PROGRESS,
  HBBTV_CHANNEL_CHANGE_CANNOT_RESOLVE_URI, HBBTV_CHANNEL_CHANGE_INSUFFICIENT_BANDWIDTH, HBBTV_CHANNEL_CHANGE_CANNOT_BE_CHANGED, HBBTV_CHANNEL_CHANGE_INSUFFICIENT_RESOURCES,
  HBBTV_CHANNEL_CHANGE_CHANNEL_NOT_IN_TS, HBBTV_CHANNEL_CHANGE_UNKNOWN_ERROR = 100, HBBTV_CHANNEL_CHANGE_BAD_SIGNAL, HBBTV_CHANNEL_CHANGE_RECOVERING = 128,
  HBBTV_CHANNEL_CHANGE_STARTING = 129, HBBTV_CHANNEL_CHANGE_SUCCEEDED = 130, HBBTV_CHANNEL_CHANGE_STOPPED = 131
}
 
enum  E_HBBTV_RECORDING_EVENT {
  HBBTV_RECORDING_NEWLY_SCHEDULED, HBBTV_RECORDING_ABOUT_TO_START, HBBTV_RECORDING_ACQUIRING_RESOURCES, HBBTV_RECORDING_STARTED,
  HBBTV_RECORDING_UPDATED, HBBTV_RECORDING_COMPLETED, HBBTV_RECORDING_PART_COMPLETED, HBBTV_RECORDING_FAILED_RESOURCE_LIMITATION,
  HBBTV_RECORDING_FAILED_INSUFFICIENT_STORAGE, HBBTV_RECORDING_FAILED_TUNER_CONFLICT, HBBTV_RECORDING_FAILED_NOT_ALLOWED, HBBTV_RECORDING_FAILED_UNKNOWN_ERROR,
  HBBTV_RECORDING_DELETED, HBBTV_RECORDING_TS_STARTING, HBBTV_RECORDING_TS_STARTED, HBBTV_RECORDING_TS_STOPPED,
  HBBTV_RECORDING_TS_NOT_POSSIBLE, HBBTV_RECORDING_TS_NOT_ALLOWED, HBBTV_RECORDING_TS_FAILED
}
 
enum  E_HBBTV_COMPONENT_TYPE { HBBTV_COMPONENT_TYPE_VIDEO = 0x1, HBBTV_COMPONENT_TYPE_AUDIO = 0x2, HBBTV_COMPONENT_TYPE_SUBTITLE = 0x4, HBBTV_COMPONENT_TYPE_OTHER = 0x8 }
 

Functions

void HBBTV_ProcessAitSection (U16BIT ait_pid, U16BIT service_id, U8BIT *data, U32BIT nbytes)
 Requests the HbbTV engine to process the specified AIT. The HbbTV engine expects the relevant AITs only (the first one after HBBTV_Start, when the version/PID changes). If more than one stream is signalled in the PMT for a service with an application_signalling_descriptor, then the application_signalling_descriptor for the stream containing the AIT for the HbbTV application shall include the HbbTV application_type (0x0010). More...
 
void HBBTV_NotifyServiceListChange (void)
 Notifies the HbbTV ending that it must update Service list. This will cause the engine to subsequently call HBBTV_ObtainServiceList().
 
void HBBTV_NotifyParentalRatingChange (BOOLEAN blocked)
 Notifies the HbbTV engine that the parental rating of the currently playing service has changed. More...
 
void HBBTV_NotifyChannelChangeStatus (U16BIT onet_id, U16BIT trans_id, U16BIT serv_id, E_HBBTV_CHANNEL_CHANGE_STATUS status)
 Notifies the HbbTV engine of a change in the status of the service identified by the specified DVB triplet. More...
 
void HBBTV_NotifyStreamsChange (U16BIT onet_id, U16BIT trans_id, U16BIT serv_id, E_HBBTV_COMPONENT_TYPE component_type)
 Notifies the HbbTV engine of a possible change in streams for the service identified by specified DVB triplet. More...
 
void HBBTV_NotifyProgrammeChanged (void)
 Notifies the HbbTV engine that the present/following events have changed on the current service.
 
void HBBTV_NotifyRecordingEvent (U32BIT id, E_HBBTV_RECORDING_EVENT event)
 Notifies the HbbTV engine of a recording event. More...
 
void HBBTV_NotifyPlaySpeedChanged (S16BIT speed)
 Notify the video broadcast object that the timeshift play speed has changed. More...
 

Detailed Description

Application level HBBTV callback functions.

Date
December 2017

Function Documentation

void HBBTV_NotifyChannelChangeStatus ( U16BIT  onet_id,
U16BIT  trans_id,
U16BIT  serv_id,
E_HBBTV_CHANNEL_CHANGE_STATUS  status 
)

Notifies the HbbTV engine of a change in the status of the service identified by the specified DVB triplet.

Parameters
onet_idOriginal Network ID
trans_idTransport Stream ID
serv_idService ID
statusNew status
void HBBTV_NotifyParentalRatingChange ( BOOLEAN  blocked)

Notifies the HbbTV engine that the parental rating of the currently playing service has changed.

Parameters
blockedTRUE if the current service is blocked by the parental control system.
void HBBTV_NotifyPlaySpeedChanged ( S16BIT  speed)

Notify the video broadcast object that the timeshift play speed has changed.

Parameters
speedspeed represented as a signed percentage value, with 100 as normal speed
void HBBTV_NotifyRecordingEvent ( U32BIT  id,
E_HBBTV_RECORDING_EVENT  event 
)

Notifies the HbbTV engine of a recording event.

Parameters
idscheduled or completed recording ID
eventrecording event
void HBBTV_NotifyStreamsChange ( U16BIT  onet_id,
U16BIT  trans_id,
U16BIT  serv_id,
E_HBBTV_COMPONENT_TYPE  component_type 
)

Notifies the HbbTV engine of a possible change in streams for the service identified by specified DVB triplet.

Parameters
onet_idOriginal Network ID
trans_idTransport Stream ID
serv_idService ID
component_typeThe type of component whose presentation has changed
void HBBTV_ProcessAitSection ( U16BIT  ait_pid,
U16BIT  service_id,
U8BIT *  data,
U32BIT  nbytes 
)

Requests the HbbTV engine to process the specified AIT. The HbbTV engine expects the relevant AITs only (the first one after HBBTV_Start, when the version/PID changes). If more than one stream is signalled in the PMT for a service with an application_signalling_descriptor, then the application_signalling_descriptor for the stream containing the AIT for the HbbTV application shall include the HbbTV application_type (0x0010).

Parameters
ait_pidPID of the AIT
service_idService ID the AIT refers to
datapointer to the buffer containing the AIT row data. It can be released as soon as the function returns.
nbytesnumber of bytes contained in data