System Interface, Configuration. More...

Functions
E_HBBTV_ERR	HBBTV_GetPrefAudioLang (U8BIT *lang_string, U32BIT size)
	Retrieves a string containing a comma-separated set of languages to be used for audio playback, in order of preference. The returned string must be freed with HBBTV_ReleaseLangString. More...

E_HBBTV_ERR	HBBTV_GetPrefSubtLang (U8BIT *lang_string, U32BIT size)
	Retrieves a string containing a comma-separated set of languages to be used for subtitles, in order of preference. The returned string must be freed with HBBTV_ReleaseLangString. More...

E_HBBTV_ERR	HBBTV_GetPrefUiLang (U8BIT *lang_string, U32BIT size)
	Retrieves a string containing a comma-separated set of languages to be used for the user interface, in order of preference. The returned string must be freed with HBBTV_ReleaseLangString. More...

E_HBBTV_ERR	HBBTV_GetPrefCountryId (U8BIT *lang_string, U32BIT size)
	Retrieves a string containing the three character string representing country code identifying the country in which the receiver is deployed. The returned string must be freed with HBBTV_ReleaseLangString. More...

void	HBBTV_ReleaseLangString (U8BIT *lang_string)
	Frees the string obtained from HBBTV_GetPrefAudioLang, HBBTV_GetPrefSubtLang, HBBTV_GetPrefUiLang or HBBTV_GetPrefCountryId. More...

U8BIT *	HBBTV_GetDeliverySystemsString (void)
	Retrieves the string describing the supported Broadcast Delivery Systems (DVB_S, DVB_C, DVB_T, DVB_C2, DVB_T2 or DVB_S2) as defined in Section 9.2, Table 15, under "UI Profile Name Fragment". the HbbTV engine will call HBBTV_ReleaseDeliverySystemsString when the string is not needed any more. More...

void	HBBTV_ReleaseDeliverySystemsString (U8BIT *systems)
	Frees the Broadacast Delivery Systems string, returned by HBBTV_GetDeliverySystemsString. More...

void	HBBTV_GetParentalControlSettings (BOOLEAN enabled, U8BIT age)
	Query whether parental control is enabled and the selected age, if applicable. The age is the actual age, so for DVB the valid values are 4 to 18, inclusive. More...

BOOLEAN	HBBTV_GetUiSubtitlesEnabled ()
	Retrieves if the user has enabled the subtitles, so HBBTV can know when to start subtitle components on channel change for example. More...

Detailed Description

System Interface, Configuration.

Date: January 2014

Author: Sergio Panseri

Function Documentation

U8BIT* HBBTV_GetDeliverySystemsString ( void )

Retrieves the string describing the supported Broadcast Delivery Systems (DVB_S, DVB_C, DVB_T, DVB_C2, DVB_T2 or DVB_S2) as defined in Section 9.2, Table 15, under "UI Profile Name Fragment". the HbbTV engine will call HBBTV_ReleaseDeliverySystemsString when the string is not needed any more.

Returns: Pointer to an allocated buffer containing a string describing the list of supported broadcast deliverys systems (e.g. "+DVB_T2+DVB_T+DVB_C", note that the first '+' character is needed). The buffer will be freed by the HbbTV engine using HBBTV_ReleaseDeliverySystemsString.

void HBBTV_GetParentalControlSettings	(	BOOLEAN *	enabled,
		U8BIT *	age
	)

Query whether parental control is enabled and the selected age, if applicable. The age is the actual age, so for DVB the valid values are 4 to 18, inclusive.

Parameters

enabled	Used to return a boolean defining whether parental control is enabled (TRUE), or not (FALSE).
age	Pointer to returned age value. Should be returned as 0 if parental control is disabled or age isn't set

E_HBBTV_ERR HBBTV_GetPrefAudioLang	(	U8BIT **	lang_string,
		U32BIT *	size
	)

Retrieves a string containing a comma-separated set of languages to be used for audio playback, in order of preference. The returned string must be freed with HBBTV_ReleaseLangString.

Parameters

lang_string	Pointer to the returned string
size	Pointer to the number of bytes in the returned string

Returns

- HBBTV_OK on success

HBBTV_ERR_BAD_PARAMETER invalid parameter
HBBTV_ERR_ALLOCATING_MEMORYThe string couldn't be allocated

E_HBBTV_ERR HBBTV_GetPrefCountryId	(	U8BIT **	lang_string,
		U32BIT *	size
	)

Retrieves a string containing the three character string representing country code identifying the country in which the receiver is deployed. The returned string must be freed with HBBTV_ReleaseLangString.

Parameters

lang_string	Pointer to the returned string
size	Pointer to the number of bytes in the returned string

Returns

- HBBTV_OK on success

HBBTV_ERR_BAD_PARAMETER invalid parameter
HBBTV_ERR_ALLOCATING_MEMORYThe string couldn't be allocated

E_HBBTV_ERR HBBTV_GetPrefSubtLang	(	U8BIT **	lang_string,
		U32BIT *	size
	)

Retrieves a string containing a comma-separated set of languages to be used for subtitles, in order of preference. The returned string must be freed with HBBTV_ReleaseLangString.

Parameters

lang_string	Pointer to the returned string
size	Pointer to the number of bytes in the returned string

Returns

- HBBTV_OK on success

HBBTV_ERR_BAD_PARAMETER invalid parameter
HBBTV_ERR_ALLOCATING_MEMORYThe string couldn't be allocated

E_HBBTV_ERR HBBTV_GetPrefUiLang	(	U8BIT **	lang_string,
		U32BIT *	size
	)

Retrieves a string containing a comma-separated set of languages to be used for the user interface, in order of preference. The returned string must be freed with HBBTV_ReleaseLangString.

Parameters

lang_string	Pointer to the returned string
size	Pointer to the number of bytes in the returned string

Returns

- HBBTV_OK on success

HBBTV_ERR_BAD_PARAMETER invalid parameter
HBBTV_ERR_ALLOCATING_MEMORYThe string couldn't be allocated

BOOLEAN HBBTV_GetUiSubtitlesEnabled ( )

Retrieves if the user has enabled the subtitles, so HBBTV can know when to start subtitle components on channel change for example.

Returns: TRUE if subtitles enabled within the UI

void HBBTV_ReleaseDeliverySystemsString ( U8BIT * systems )

Frees the Broadacast Delivery Systems string, returned by HBBTV_GetDeliverySystemsString.

Parameters

systems Pointer to string to be freed

void HBBTV_ReleaseLangString ( U8BIT * lang_string )

Frees the string obtained from HBBTV_GetPrefAudioLang, HBBTV_GetPrefSubtLang, HBBTV_GetPrefUiLang or HBBTV_GetPrefCountryId.

Parameters

lang_string Pointer to string to be freed

Functions

Detailed Description

Function Documentation