HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Typedefs | Functions
hbbtv_control.h File Reference

HBBTV control. More...

#include "hbbtv_types.h"
#include "hbbtv_sif_conf.h"

Go to the source code of this file.

Typedefs

typedef E_HBBTV_ERR(* F_KEY_NOTIFY )(E_HBBTV_KEY key)
 

Functions

BOOLEAN HBBTV_CheckOptions (U8BIT mask)
 Checks whether the features represented by the specified mask are supported by the HBBTV module. This depends on the way the module has been initialised (see HBBTV_Initialise) and on the features currently supported by this version of the HBBTV module. More...
 
void HBBTV_SetKeyNotifyFunc (F_KEY_NOTIFY accept, F_KEY_NOTIFY consume)
 Internal function to set the 'accept' and 'consume' key function pointers. More...
 
void HBBTV_GetCurrentChannel (S_HBBTV_DVB_LOCATOR *dvb_locator)
 Returns the current channel, passed the HBBTV engine on Start, as a DVB locator. More...
 
BOOLEAN HBBTV_GetEngineInitialised (void)
 Returns the initialisation status of the HbbTV engine.
 
S_HBBTV_FREESAT_CALLBACKSHBBTV_GetFreesatCallbacks (void)
 Returns the pointer to the internal structure holding the Freesat callbacks. More...
 

Detailed Description

HBBTV control.

Date
8 December 2011
Author
Adam Sturtridge

Function Documentation

BOOLEAN HBBTV_CheckOptions ( U8BIT  mask)

Checks whether the features represented by the specified mask are supported by the HBBTV module. This depends on the way the module has been initialised (see HBBTV_Initialise) and on the features currently supported by this version of the HBBTV module.

Parameters
maskbit mask representing the features to be checked
Returns
TRUE if all the features in mask are supported by the HBBTV module, FALSE otherwise
Note
This function is meant to be internal to the HBBTV module
void HBBTV_GetCurrentChannel ( S_HBBTV_DVB_LOCATOR dvb_locator)

Returns the current channel, passed the HBBTV engine on Start, as a DVB locator.

Parameters
dvb_locatorpointer to the variable where the dvb locator will be stored
S_HBBTV_FREESAT_CALLBACKS* HBBTV_GetFreesatCallbacks ( void  )

Returns the pointer to the internal structure holding the Freesat callbacks.

Returns
Pointer to the internal Freesat callback structure.
void HBBTV_SetKeyNotifyFunc ( F_KEY_NOTIFY  accept,
F_KEY_NOTIFY  consume 
)

Internal function to set the 'accept' and 'consume' key function pointers.

Parameters
acceptfunction pointer of type F_KEY_NOTIFY, used by the engine to determine whether a key will be consumed by the active application
consumefunction pointer of type F_KEY_NOTIFY, used by the engine to deliver a key to the active application