Native language, reminder and banner functions for South Africa profile.
More...
#include "techtype.h"
#include "mherrors.h"
Go to the source code of this file.
|
| E_MhegErr | DVB_MhegGetAudioLangs (S32BIT serviceIndex, S32BIT eventIndex, U8BIT *audioLangs) |
| | Return a list of available audio languages for the specified event. The language list is extracted from the component descriptors of the present or following event (EITpf). It is returned as a null-terminated sequence of 3-letter codes separated by a space character. The buffer provided is allocated by the MHEG-5 engine and is large enough to store up to 64 languages (256 bytes including the null-terminator). This MUST be a non-blocking function, returning results immediately. More...
|
| |
| E_MhegErr | DVB_MhegGetSubtitleLangs (S32BIT serviceIndex, S32BIT eventIndex, U8BIT *subsLangs) |
| | Return a list of available subtitles languages for the specified event. The language list is extracted from the component descriptors of the present or following event (EITpf). It is returned as a null-terminated sequence of 3-letter codes separated by a space character. The buffer provided is allocated by the MHEG-5 engine and is large enough to store up to 64 languages (256 bytes including the null-terminator). This MUST be a non-blocking function, returning results immediately. More...
|
| |
| E_MhegErr | DVB_MhegGetADLangs (S32BIT serviceIndex, S32BIT eventIndex, U8BIT *adLangs) |
| | Return a list of available audio description languages for the specified event. The language list is extracted from the component descriptors of the present or following event (EITpf). It is returned as a null-terminated sequence of 3-letter codes separated by a space character. The buffer provided is allocated by the MHEG-5 engine and is large enough to store up to 64 languages (256 bytes including the null-terminator). This MUST be a non-blocking function, returning results immediately. More...
|
| |
| E_MhegErr | DVB_MhegGetOSDLanguage (U8BIT *language) |
| | Return the language of the native UI (menu etc.) as a three character code as defined by ISO 639-2. This is a non-blocking function. More...
|
| |
| E_MhegErr | DVB_MhegSetNativeReminder (S32BIT serviceIndex, S32BIT eventId, BOOLEAN *result) |
| | Set a native reminder for the given event on the given service. This MUST be a non-blocking function, returning results immediately. More...
|
| |
| E_MhegErr | DVB_MhegGetNativeReminder (S32BIT serviceIndex, S32BIT eventId, BOOLEAN *set) |
| | Return whether a native reminder has been set for the given event on the given service. This MUST be a non-blocking function, returning results immediately. More...
|
| |
| E_MhegErr | DVB_MhegCancelNativeReminder (S32BIT serviceIndex, S32BIT eventId) |
| | Cancel any native reminder set for the given event on the given service. This MUST be a non-blocking function, returning results immediately. More...
|
| |
| E_MhegErr | DVB_MhegGetBannerTransparency (S32BIT *transparency) |
| | Return the banner transparency as a percentage 0-100, where 100 is fully transparent. This setting is related to the information banner on the native UI of the receiver. More...
|
| |
| E_MhegErr | DVB_MhegGetBannerTimeout (S32BIT *timeout) |
| | Return the banner timeout period in seconds. This setting is related to the information banner on the native UI of the receiver. More...
|
| |
Native language, reminder and banner functions for South Africa profile.
- Date
- 20/12/2012
- Author
- Adam Sturtridge
| E_MhegErr DVB_MhegCancelNativeReminder |
( |
S32BIT |
serviceIndex, |
|
|
S32BIT |
eventId |
|
) |
| |
Cancel any native reminder set for the given event on the given service. This MUST be a non-blocking function, returning results immediately.
- Parameters
-
| serviceIndex | A receiver specific identifier for the service. |
| eventId | The unique event identifier on the given serviceIndex of the event to cancel a reminder for. |
- Returns
- The following return values are allowed from this function MHEG5_OK - Success MHEG5_ERR_BAD_PARAMETER - Invalid parameter. MHEG5_ERR_OTHER - Controlling application specific error.
| E_MhegErr DVB_MhegGetADLangs |
( |
S32BIT |
serviceIndex, |
|
|
S32BIT |
eventIndex, |
|
|
U8BIT * |
adLangs |
|
) |
| |
Return a list of available audio description languages for the specified event. The language list is extracted from the component descriptors of the present or following event (EITpf). It is returned as a null-terminated sequence of 3-letter codes separated by a space character. The buffer provided is allocated by the MHEG-5 engine and is large enough to store up to 64 languages (256 bytes including the null-terminator). This MUST be a non-blocking function, returning results immediately.
- Parameters
-
| serviceIndex | A receiver specific integer identifying a service. This value shall be consistent with the values returned by DVB_MhegDvbLocatorToIndex. |
| eventIndex | 0 for the current event, 1 for the following event |
| adLangs | A space separated list of 3 character language codes. Each code corresponds to an audio description stream that is available to the event as signalled by the EITpf. |
- Returns
- The following return values are allowed from this function MHEG5_OK - Success MHEG5_ERR_BAD_PARAMETER - Invalid parameter. MHEG5_ERR_OTHER - Controlling application specific error.
| E_MhegErr DVB_MhegGetAudioLangs |
( |
S32BIT |
serviceIndex, |
|
|
S32BIT |
eventIndex, |
|
|
U8BIT * |
audioLangs |
|
) |
| |
Return a list of available audio languages for the specified event. The language list is extracted from the component descriptors of the present or following event (EITpf). It is returned as a null-terminated sequence of 3-letter codes separated by a space character. The buffer provided is allocated by the MHEG-5 engine and is large enough to store up to 64 languages (256 bytes including the null-terminator). This MUST be a non-blocking function, returning results immediately.
- Parameters
-
| serviceIndex | A receiver specific integer identifying a service. This value shall be consistent with the values returned by DVB_MhegDvbLocatorToIndex. |
| eventIndex | 0 for the current event, 1 for the following event |
| audioLangs | A space separated list of 3 character language codes. Each code corresponds to an audio stream that is available to the event as signalled by the EITpf. |
- Returns
- The following return values are allowed from this function MHEG5_OK - Success MHEG5_ERR_BAD_PARAMETER - Invalid parameter. MHEG5_ERR_OTHER - Controlling application specific error.
| E_MhegErr DVB_MhegGetBannerTimeout |
( |
S32BIT * |
timeout | ) |
|
Return the banner timeout period in seconds. This setting is related to the information banner on the native UI of the receiver.
- Parameters
-
| timeout | Pointer to return banner timeout in seconds |
| E_MhegErr DVB_MhegGetBannerTransparency |
( |
S32BIT * |
transparency | ) |
|
Return the banner transparency as a percentage 0-100, where 100 is fully transparent. This setting is related to the information banner on the native UI of the receiver.
- Parameters
-
| transparency | Banner transparency as a percentage |
| E_MhegErr DVB_MhegGetNativeReminder |
( |
S32BIT |
serviceIndex, |
|
|
S32BIT |
eventId, |
|
|
BOOLEAN * |
set |
|
) |
| |
Return whether a native reminder has been set for the given event on the given service. This MUST be a non-blocking function, returning results immediately.
- Parameters
-
| serviceIndex | A receiver specific identifier for the service. |
| eventId | The unique event identifier on the given serviceIndex of the event to return the reminder setting for. |
| set | TRUE if a reminder has been set for the given eventId and service, FALSE otherwise. |
- Returns
- The following return values are allowed from this function MHEG5_OK - Success MHEG5_ERR_BAD_PARAMETER - Invalid parameter. MHEG5_ERR_OTHER - Controlling application specific error.
| E_MhegErr DVB_MhegGetOSDLanguage |
( |
U8BIT * |
language | ) |
|
Return the language of the native UI (menu etc.) as a three character code as defined by ISO 639-2. This is a non-blocking function.
- Parameters
-
- Returns
- The following return values are allowed from this function MHERR_OK - Success. MHERR_BAD_PARAMETER - Invalid parameter. MHERR_OTHER - Controlling application specific error.
| E_MhegErr DVB_MhegGetSubtitleLangs |
( |
S32BIT |
serviceIndex, |
|
|
S32BIT |
eventIndex, |
|
|
U8BIT * |
subsLangs |
|
) |
| |
Return a list of available subtitles languages for the specified event. The language list is extracted from the component descriptors of the present or following event (EITpf). It is returned as a null-terminated sequence of 3-letter codes separated by a space character. The buffer provided is allocated by the MHEG-5 engine and is large enough to store up to 64 languages (256 bytes including the null-terminator). This MUST be a non-blocking function, returning results immediately.
- Parameters
-
| serviceIndex | A receiver specific integer identifying a service. This value shall be consistent with the values returned by DVB_MhegDvbLocatorToIndex. |
| eventIndex | 0 for the current event, 1 for the following event |
| subsLangs | A space separated list of 3 character language codes. Each code corresponds to a subtitles stream that is available to the event as signalled by the EITpf. |
- Returns
- The following return values are allowed from this function MHEG5_OK - Success MHEG5_ERR_BAD_PARAMETER - Invalid parameter. MHEG5_ERR_OTHER - Controlling application specific error.
| E_MhegErr DVB_MhegSetNativeReminder |
( |
S32BIT |
serviceIndex, |
|
|
S32BIT |
eventId, |
|
|
BOOLEAN * |
result |
|
) |
| |
Set a native reminder for the given event on the given service. This MUST be a non-blocking function, returning results immediately.
- Parameters
-
| serviceIndex | A receiver specific identifier for the service. |
| eventId | The unique event identifier on the given serviceIndex of the event to set a reminder for. |
| result | TRUE if the receiver could access the event in the EIT cache, FALSE otherwise. |
- Returns
- The following return values are allowed from this function MHEG5_OK - Success MHEG5_ERR_BAD_PARAMETER - Invalid parameter. MHEG5_ERR_OTHER - Controlling application specific error.
1.8.11
