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_NotifyKeyPress (E_MHEG5_KEY key)
	Notify MHEG5 engine of a key press. If FALSE is returned, the external application may use the key. More...
BOOLEAN	MHEG5_IsKeyNeeded (E_MHEG5_KEY key)
	Enquire from MHEG5 engine about whether a key is needed, without actually passing the key to it. 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...
void	MHEG5_KeySupportDisabled (E_MHEG5_KEY key)
	Inform MHEG5 engine that key is not supported by the platform or product. By default MHEG5 engine assumes all keys are supported. Call this function after MHEG5_Open(). More...
void	MHEG5_KeySupportEnabled (E_MHEG5_KEY key)
	Key press support is enabled. May be called after the key has been disabled by MHEG5_KeySupportDisabled() More...

Detailed Description

Key press interface with MHEG5 engine.

Date

23/12/2013

Author

Adam Sturtridge

Function Documentation

BOOLEAN MHEG5_IsKeyNeeded

(

E_MHEG5_KEY

key

)

Enquire from MHEG5 engine about whether a key is needed, without actually passing the key to it.

Parameters

key	Value of Key press

Returns

TRUE - MHEG5 is interested in key press

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.

void MHEG5_KeySupportDisabled

(

E_MHEG5_KEY

key

)

Inform MHEG5 engine that key is not supported by the platform or product. By default MHEG5 engine assumes all keys are supported. Call this function after MHEG5_Open().

Parameters

key	Value of Key press

void MHEG5_KeySupportEnabled

(

E_MHEG5_KEY

key

)

Key press support is enabled. May be called after the key has been disabled by MHEG5_KeySupportDisabled()

Parameters

key	Value of Key press

BOOLEAN MHEG5_NotifyKeyPress

(

E_MHEG5_KEY

key

)

Notify MHEG5 engine of a key press. If FALSE is returned, the external application may use the key.

Parameters

key	Value of Key press

Returns

TRUE - key press was consumed