mh5keypress.h File Reference

Key Press related functionality. More...

#include "mh5base.h"

Go to the source code of this file.

Functions
void	MHEG5setInputEventRegister (MHEG5Int inputEventRegister)
	Change the input event register. This indicates which keypresses the MHEG-5 engine requires to be passed. See UK 1.05 profile section 3.6 for a description of which keypresses must be passed to MHEG-5 for the different input event register values. These values are likely to change for UK1.06 profile. More...
MHEG5Bool	MHEG5IsInputMaskSupported (MHEG5String query_mask)
	Tell whether the set of keys indicated by the input mask is supported by the receiver (this means that every key in the mask is supported). More...
void	MHEG5setInputEventMask (MHEG5String *inputEventMask)
	Change the input mask. This indicates which keypresses the MHEG-5 engine requires to be passed. More...
void	MHEG5PromotionalLinkControl (BOOLEAN isEnabled)

Detailed Description

Key Press related functionality.

Date

30/08/2008

Author

Adam Sturtridge

Definition in file mh5keypress.h.

Function Documentation

MHEG5Bool MHEG5IsInputMaskSupported

(

MHEG5String

query_mask

)

Tell whether the set of keys indicated by the input mask is supported by the receiver (this means that every key in the mask is supported).

Parameters

query_mask

The input key mask to check

Returns

TRUE if the input key mask is supported, FALSE otherwise

Definition at line 1076 of file mh5keypress.c.

void MHEG5PromotionalLinkControl

(

BOOLEAN

isEnabled

)

Definition at line 1248 of file mh5keypress.c.

void MHEG5setInputEventMask

(

MHEG5String *

inputEventMask

)

Change the input mask. This indicates which keypresses the MHEG-5 engine requires to be passed.

Parameters

inputEventMask

New input mask. The input mask is only valid if the input event register is 0.

Returns

None.

Parameters

inputMask

New input mask. The input mask is only valid if the input event register is 0.

Returns

None.

Definition at line 1146 of file mh5keypress.c.

void MHEG5setInputEventRegister

(

MHEG5Int

inputEventRegister

)

Change the input event register. This indicates which keypresses the MHEG-5 engine requires to be passed. See UK 1.05 profile section 3.6 for a description of which keypresses must be passed to MHEG-5 for the different input event register values. These values are likely to change for UK1.06 profile.

Parameters

inputEventRegister

New input event register value. 0 indicates that there is no scene currently running, or that the input mask is used (if supported).

Returns

None.

Parameters

inputEventRegister

New input event register value. 0 indicates that there is no scene currently running.

Returns

None.

Definition at line 320 of file mh5keypress.c.