hbbtv_sif_conf.h File Reference

System Interface, Configuration. More...

Go to the source code of this file.

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...
void	HBBTV_GetPostcode (U8BIT **postcode)
	Retrieves a string containing the postcode where the receiver is located. The HbbTV engine will free it by calling HBBTV_OSFree. The correct implementation of this function is not required for HbbTV 1.2.1, it is used to implement the postcode property as defined in Freesat OPAL v1.0 section 8.4.1.1. More...
BOOLEAN	HBBTV_GetSpeechDescriptionEnabled (void)
	Returns the speech description status. This function is used by the HbbTV engine only if support for speech description has been signalled in the S_HBBTV_SYSTEM_INFO structure. The correct implementation of this function is not required for HbbTV 1.2.1, it is used to implement the Configuration speechDescriptionEnabled property as defined in Freesat OPAL v1.0 section 8.4.1.2. More...
BOOLEAN	HBBTV_GetVoiceControlEnabled (void)
	Returns the voice control status. This function is used by the HbbTV engine only if support for voice control has been signalled in the S_HBBTV_SYSTEM_INFO structure. The correct implementation of this function is not required for HbbTV 1.2.1, it is used to implement the Configuration voiceControlEnable property as defined in Freesat OPAL v1.0 section 8.4.1.3. More...
U8BIT	HBBTV_GetTerminalMode (void)
	Returns the terminal mode as defined by Freesat OPAL v1.0 section 8.4.1.1. The correct implementation of this function is not required by HbbTV 1.2.1. 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

void HBBTV_GetPostcode

(

U8BIT **

postcode

)

Retrieves a string containing the postcode where the receiver is located. The HbbTV engine will free it by calling HBBTV_OSFree. The correct implementation of this function is not required for HbbTV 1.2.1, it is used to implement the postcode property as defined in Freesat OPAL v1.0 section 8.4.1.1.

Parameters

postcode

Pointer to the string containing the postcode when in Freesat mode, NULL otherwise.

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_GetSpeechDescriptionEnabled

(

void

)

Returns the speech description status. This function is used by the HbbTV engine only if support for speech description has been signalled in the S_HBBTV_SYSTEM_INFO structure. The correct implementation of this function is not required for HbbTV 1.2.1, it is used to implement the Configuration speechDescriptionEnabled property as defined in Freesat OPAL v1.0 section 8.4.1.2.

Returns

U8BIT HBBTV_GetTerminalMode

(

void

)

Returns the terminal mode as defined by Freesat OPAL v1.0 section 8.4.1.1. The correct implementation of this function is not required by HbbTV 1.2.1.

Returns

• 0: the terminal has not been configured to receive any type of signal
• 1: the terminal has been configured to receive saltellite signal
• 2: the terminal has been configured to receive terrestrial signal
• 3: the terminal has been configured to receive analog signal
• 4: the terminal has been configured to receive a type of terminal different from the ones listed above
• any other value will be considered error

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

BOOLEAN HBBTV_GetVoiceControlEnabled

(

void

)

Returns the voice control status. This function is used by the HbbTV engine only if support for voice control has been signalled in the S_HBBTV_SYSTEM_INFO structure. The correct implementation of this function is not required for HbbTV 1.2.1, it is used to implement the Configuration voiceControlEnable property as defined in Freesat OPAL v1.0 section 8.4.1.3.

Returns

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