HbbTv  17.9.0
Open source HBBTV engine
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros
Data Fields
S_HBBTV_EVENT_DETAILS Struct Reference

Data Fields

void * dvb_user_data
 
S_HBBTV_STRING event_name
 
S_HBBTV_STRING short_description
 
U32BIT parental_rating
 
U32BIT start_date
 
S_HBBTV_TIME start_time
 
S_HBBTV_TIME duration
 
BOOLEAN use_crid
 
U16BIT event_id
 
S_HBBTV_STRING crid
 
S_HBBTV_STRING long_description
 
U8BIT audio_type
 
BOOLEAN is_multilingual
 
U8BIT num_audio_languages
 
S_HBBTV_STRINGaudio_language_array
 
BOOLEAN is_hd
 
BOOLEAN has_audio_description
 
BOOLEAN has_sign_language
 
U8BIT num_genres
 
S_HBBTV_STRINGgenre_array
 
BOOLEAN has_guidance
 
U8BIT num_guidance_strings
 
S_HBBTV_STRINGguidance_string_array
 
U8BIT num_media_assets
 
S_HBBTV_MEDIA_ASSETmedia_asset_array
 
S_HBBTV_STRING promotional_content
 
BOOLEAN has_hd_simulcast
 
U8BIT num_series_crids
 
S_HBBTV_STRINGseries_crid_array
 
U8BIT num_recommendation_crids
 
S_HBBTV_STRINGrecommendation_crid_array
 
BOOLEAN has_recording
 
U32BIT recording_id
 
U32BIT timer_id
 

Field Documentation

S_HBBTV_STRING* audio_language_array

The correct value for the 'audio_language_array' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme audioLanguages as defined by Freesat OPAL v1.0, section 17.2.14, set it to NULL if this functionality is not needed. This field contains the pointer to an array of language code strings.

U8BIT audio_type

The correct value for the 'audio_type' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme audioType as defined by Freesat OPAL v1.0, section 17.2.10

S_HBBTV_STRING* genre_array

The correct value for the 'genre_array' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme genre as defined by Freesat OPAL v1.0, section 17.2.12, set it to NULL if this functionality is not needed. This field contains the pointer to an array of content genre coding as carried in content descriptor of the EIT.

S_HBBTV_STRING* guidance_string_array

The correct value for the 'guidance_string_array' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme guidance property as defined by Freesat OPAL v1.0, section 17.2.24, set it to NULL if this functionality is not needed. This field contains the pointer to an array of guidance strings as carried in guidance descriptor of the EIT.

BOOLEAN has_audio_description

The correct value for the 'has_audio_description' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme hasAudioDescription as defined by Freesat OPAL v1.0, section 17.2.19

BOOLEAN has_guidance

The correct value for the 'has_guidance' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme hasGuidance as defined by Freesat OPAL v1.0, section 17.2.23.

BOOLEAN has_hd_simulcast

The correct value for the 'has_hd_simulcast' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme hasHDSimulcast property as defined by Freesat OPAL v1.0, section 17.2.25.

BOOLEAN has_recording

The correct value for the 'has_recording' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme hasRecording property as defined by OIPF Volume 5, section 7.16.2.3.1.

BOOLEAN has_sign_language

The correct value for the 'has_sign_language' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme hasSignLanguage as defined by Freesat OPAL v1.0, section 17.2.18

BOOLEAN is_hd

The correct value for the 'is_hd' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme isHdas defined by OIPF Volume 5, section 7.16.2.3.1.

BOOLEAN is_multilingual

The correct value for the 'is_multilingual' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme isMultilingual as defined by Freesat OPAL v1.0, section 17.2.11

S_HBBTV_MEDIA_ASSET* media_asset_array

The correct value for the 'media_asset_array' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme mediaAssets property as defined by Freesat OPAL v1.0, section 17.2.21, set it to NULL if this functionality is not needed. This field contains the pointer to an array of media asset structures as defined in OPAL v1.0, section 17.2.21.

U8BIT num_audio_languages

The correct value for the 'num_audio_languages' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme audioLanguages as defined by Freesat OPAL v1.0, section 17.2.14, set it to 0 if this functionality is not needed. This field represents the number of 3 bytes language code in 'audio_language_array'

U8BIT num_genres

The correct value for the 'num_genres' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme genre as defined by Freesat OPAL v1.0, section 17.2.12, set it to 0 if this functionality is not needed. This field represents the number of genre strings in 'genre_array'

U8BIT num_guidance_strings

The correct value for the 'num_guidance_strings' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme guidance property as defined by Freesat OPAL v1.0, section 17.2.24, set it to 0 if this functionality is not needed. This field represents the number of guidance strings in 'guidance_string_array'

U8BIT num_media_assets

The correct value for the 'num_media_assets' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme mediaAssets property as defined by Freesat OPAL v1.0, section 17.2.21, set it to 0 if this functionality is not needed. This field represents the number of media assets in 'media_asset_array'

U8BIT num_recommendation_crids

The correct value for the 'num_recommendation_crids' field is not mandatory for HbbTV 1.2.1. This field (together with crid) is used to implement Programme CRIDS property as defined by Freesat OPAL v1.0, section 17.2.27. This field represents the number of CRID strings in 'num_recommendation_crids', set it to 0 if this functionality is not needed.

U8BIT num_series_crids

The correct value for the 'num_series_crids' field is not mandatory for HbbTV 1.2.1. This field (together with crid) is used to implement Programme CRIDS property as defined by Freesat OPAL v1.0, section 17.2.27. This field represents the number of CRID strings in 'series_crid_array', set it to 0 if this functionality is not needed.

S_HBBTV_STRING promotional_content

The correct value for the 'promotional_content' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme promotionalContentText property as defined by Freesat OPAL v1.0, section 17.2.22, set it zptr to NULL and zlen to 0 if this functionality is not needed or such information is not available, otherwise use the content from the appropriate descriptor.

S_HBBTV_STRING* recommendation_crid_array

The correct value for the 'recommendation_crid_array' field is not mandatory for HbbTV 1.2.1. This field (together with crid) is used to implement Programme CRIDS property as defined by Freesat OPAL v1.0, section 17.2.27. This field contains a pointer to an array of strings representing recommendation CRIDs, set it to NULL if this functionality is not needed.

U32BIT recording_id

The correct value for the 'recording_id' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme recording property as defined by OIPF Volume 5, section 7.16.2.5. If this functionality is implemented, has_recording is TRUE and the recording is completed or in progress, this field contains the value of the recording ID as returned in S_HBBTV_RECORDING_DETAILS structure, 0 otherwise.

S_HBBTV_STRING* series_crid_array

The correct value for the 'series_crid_array' field is not mandatory for HbbTV 1.2.1. This field (together with crid) is used to implement Programme CRIDS property as defined by Freesat OPAL v1.0, section 17.2.27. This field contains a pointer to an array of strings representing series CRIDs, set it to NULL if this functionality is not needed.

U32BIT timer_id

The correct value for the 'timer_id' field is not mandatory for HbbTV 1.2.1. This field is used to implement Programme recording property as defined by OIPF Volume 5, section 7.16.2.5. If this functionality is implemented and has_recording is TRUE, this field contains the value of the timer ID of the scheduled recording associated with this event as returned in S_HBBTV_SCHEDULED_RECORDING_DETAILS structure, 0 otherwise.

BOOLEAN use_crid

If TRUE the HbbTV engine will use the CRID identify the event, otherwise the engine will use the event ID.


The documentation for this struct was generated from the following file: