MHEG5 1.0
DTVKit MHEG5 1.0 API Documentation
 All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Enumerations | Functions
mheg5_keypress.h File Reference

Key press interface with MHEG5 engine. More...

#include "techtype.h"

Go to the source code of this file.

Enumerations

enum  E_MHEG5_KEY {
  MHEG5_KEY_UP, MHEG5_KEY_DOWN, MHEG5_KEY_LEFT, MHEG5_KEY_RIGHT,
  MHEG5_KEY_0, MHEG5_KEY_1, MHEG5_KEY_2, MHEG5_KEY_3,
  MHEG5_KEY_4, MHEG5_KEY_5, MHEG5_KEY_6, MHEG5_KEY_7,
  MHEG5_KEY_8, MHEG5_KEY_9, MHEG5_KEY_SELECT, MHEG5_KEY_CANCEL,
  MHEG5_KEY_HELP, MHEG5_KEY_RED, MHEG5_KEY_GREEN, MHEG5_KEY_YELLOW,
  MHEG5_KEY_BLUE, MHEG5_KEY_TEXT, MHEG5_KEY_INFO, MHEG5_KEY_EPG,
  MHEG5_KEY_STOP, MHEG5_KEY_PLAY, MHEG5_KEY_PAUSE, MHEG5_KEY_SKIP_FWD,
  MHEG5_KEY_SKIP_BACK, MHEG5_KEY_FAST_FWD, MHEG5_KEY_REWIND, MHEG5_KEY_PLAY_PAUSE,
  MHEG5_KEY_RECORD, TOTAL_MHEG5_KEYS
}
 

Functions

BOOLEAN MHEG5_IsKeyNeeded (E_MHEG5_KEY key)
 
BOOLEAN MHEG5_NotifyKeyPress (E_MHEG5_KEY key)
 Notifies the MHEG-5 component of a user key press. The keys shown in section 2.3 of reference [1] are required by the MHEG-5 component. If the key is in a function group that the MHEG-5 application has disabled, then MHEG5_NotifyKeyPress() returns MHEG5_IGNOR_REQUEST. This is a non-blocking function. More...
 
BOOLEAN MHEG5_IsPromotionalLinkingEnabled (void)
 This function is relevant to PVR products that support NativeApplicationExtension for broadcast-triggered native applications, The returned state indicates whether MHEG group 3 keys (CANCEL, RED, GREEN, YELLOW, BLUE, TEXT) may be intercepted by the external application for promotional linking. Only when the state is set to TRUE, can group 3 keys be used for broadcast-triggered native application. If the key is not consumed for this purpose, then it must be presented to MHEG5_NotifyKeyPress(), as normal. More...
 
BOOLEAN DVB_MhegIsKeySupported (E_MHEG5_KEY key)
 

Detailed Description

Key press interface with MHEG5 engine.

Date
23/12/2013
Author
Adam Sturtridge

Enumeration Type Documentation

enum E_MHEG5_KEY
Enumerator
MHEG5_KEY_UP 
MHEG5_KEY_DOWN 
MHEG5_KEY_LEFT 
MHEG5_KEY_RIGHT 
MHEG5_KEY_0 
MHEG5_KEY_1 
MHEG5_KEY_2 
MHEG5_KEY_3 
MHEG5_KEY_4 
MHEG5_KEY_5 
MHEG5_KEY_6 
MHEG5_KEY_7 
MHEG5_KEY_8 
MHEG5_KEY_9 
MHEG5_KEY_SELECT 
MHEG5_KEY_CANCEL 
MHEG5_KEY_HELP 
MHEG5_KEY_RED 
MHEG5_KEY_GREEN 
MHEG5_KEY_YELLOW 
MHEG5_KEY_BLUE 
MHEG5_KEY_TEXT 
MHEG5_KEY_INFO 
MHEG5_KEY_EPG 
MHEG5_KEY_STOP 
MHEG5_KEY_PLAY 
MHEG5_KEY_PAUSE 
MHEG5_KEY_SKIP_FWD 
MHEG5_KEY_SKIP_BACK 
MHEG5_KEY_FAST_FWD 
MHEG5_KEY_REWIND 
MHEG5_KEY_PLAY_PAUSE 
MHEG5_KEY_RECORD 
TOTAL_MHEG5_KEYS 

Function Documentation

BOOLEAN DVB_MhegIsKeySupported ( E_MHEG5_KEY  key)
BOOLEAN MHEG5_IsKeyNeeded ( E_MHEG5_KEY  key)
BOOLEAN MHEG5_IsPromotionalLinkingEnabled ( void  )

This function is relevant to PVR products that support NativeApplicationExtension for broadcast-triggered native applications, The returned state indicates whether MHEG group 3 keys (CANCEL, RED, GREEN, YELLOW, BLUE, TEXT) may be intercepted by the external application for promotional linking. Only when the state is set to TRUE, can group 3 keys be used for broadcast-triggered native application. If the key is not consumed for this purpose, then it must be presented to MHEG5_NotifyKeyPress(), as normal.

Returns
TRUE - Promotional linking is allowed FALSE - disable promotional linking.
BOOLEAN MHEG5_NotifyKeyPress ( E_MHEG5_KEY  key)

Notifies the MHEG-5 component of a user key press. The keys shown in section 2.3 of reference [1] are required by the MHEG-5 component. If the key is in a function group that the MHEG-5 application has disabled, then MHEG5_NotifyKeyPress() returns MHEG5_IGNOR_REQUEST. This is a non-blocking function.

Parameters
keyPressEnumerated key press value.
Returns
MHERR_OK - Success MHERR_REQUEST_IGNORED - key was not consumed MHERR_COMP_NOT_STARTED - Component not started. MHERR_BAD_PARAMETER - Invalid parameter.