HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
hbbtv_sif_conf.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2014 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
26 /* pre-processor mechanism so multiple inclusions don't cause compilation error*/
27 
28 #ifndef _HBBTV_SIF_CONF_H
29 
30 #define _HBBTV_SIF_CONF_H
31 
32 /*---Constant and macro definitions for public use-----------------------------*/
33 
34 /*---Enumerations for public use-----------------------------------------------*/
35 
36 /*---Global type defs for public use-------------------------------------------*/
37 
38 /*---Global Function prototypes for public use---------------------------------*/
39 
51 E_HBBTV_ERR HBBTV_GetPrefAudioLang(U8BIT **lang_string, U32BIT *size);
52 
63 E_HBBTV_ERR HBBTV_GetPrefSubtLang(U8BIT **lang_string, U32BIT *size);
64 
75 E_HBBTV_ERR HBBTV_GetPrefUiLang(U8BIT **lang_string, U32BIT *size);
76 
87 E_HBBTV_ERR HBBTV_GetPrefCountryId(U8BIT **lang_string, U32BIT *size);
88 
94 void HBBTV_ReleaseLangString(U8BIT *lang_string);
95 
107 U8BIT* HBBTV_GetDeliverySystemsString(void);
108 
113 void HBBTV_ReleaseDeliverySystemsString(U8BIT *systems);
114 
123 void HBBTV_GetParentalControlSettings(BOOLEAN *enabled, U8BIT *age);
124 
133 void HBBTV_GetPostcode(U8BIT **postcode);
134 
144 
153 BOOLEAN HBBTV_GetVoiceControlEnabled(void);
154 
167 U8BIT HBBTV_GetTerminalMode(void);
168 
175 
176 
177 #endif /* _HBBTV_SIF_CONF_H */
U8BIT HBBTV_GetTerminalMode(void)
Returns the terminal mode as defined by Freesat OPAL v1.0 section 8.4.1.1. The correct implementation...
void HBBTV_GetParentalControlSettings(BOOLEAN *enabled, U8BIT *age)
Query whether parental control is enabled and the selected age, if applicable. The age is the actual ...
BOOLEAN HBBTV_GetUiSubtitlesEnabled()
Retrieves if the user has enabled the subtitles, so HBBTV can know when to start subtitle components ...
void HBBTV_ReleaseDeliverySystemsString(U8BIT *systems)
Frees the Broadacast Delivery Systems string, returned by HBBTV_GetDeliverySystemsString.
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.
E_HBBTV_ERR HBBTV_GetPrefCountryId(U8BIT **lang_string, U32BIT *size)
Retrieves a string containing the three character string representing country code identifying the co...
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...
BOOLEAN HBBTV_GetSpeechDescriptionEnabled(void)
Returns the speech description status. This function is used by the HbbTV engine only if support for ...
void HBBTV_GetPostcode(U8BIT **postcode)
Retrieves a string containing the postcode where the receiver is located. The HbbTV engine will free ...
BOOLEAN HBBTV_GetVoiceControlEnabled(void)
Returns the voice control status. This function is used by the HbbTV engine only if support for voice...
void HBBTV_ReleaseLangString(U8BIT *lang_string)
Frees the string obtained from HBBTV_GetPrefAudioLang, HBBTV_GetPrefSubtLang, HBBTV_GetPrefUiLang or ...
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...
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.