mh5support.h File Reference

Engine support utility functions for MHEG5. More...

#include "mh5base.h"
#include "mheg5_control.h"

Go to the source code of this file.

Enumerations
enum	E_ProfileId { PROFILE_BROADCAST, PROFILE_CI_PLUS }

Functions
E_MhegErr	MH5_SupportInitialise (S_MhegConfig *pConfig)
	Initialise support module - called when 'Open' engine. More...
U8BIT *	MH5_GetManufacturerString (void)
	Returns a pointer to a manufacturer specific platform U8BIT*. More...
U8BIT *	MH5_GetEngineVersionString (void)
	Returns a pointer to the engine version string U8BIT*. More...
U8BIT *	MH5_GetUserAgent (void)
	Return the "User Agent" string for the engine. More...
MHEG5Bool	MH5_SupportInteractionChannel (void)
	Return whether Interaction channel is supported by current profile. More...
MHEG5Bool	MH5_SupportICStreaming (void)
	Return whether Interaction channel Streaming is supported. More...
MHEG5Bool	MH5_SupportMhegProfile (E_MHEG_PROFILE profile)
	Return whether Mheg profile (UK, NZ, AU, HK, SA, FREESAT) is currently supported. More...
MHEG5Bool	MH5_SupportHDGraphics (void)
	Returns whether supporting HD Graphics extension. More...
MHEG5Bool	MH5_SupportHDVideo (void)
	Returns whether supporting HD Video extension. More...
MHEG5Bool	MH5_SupportNativeApplication (void)
	Return whether Native Application extension is supported. More...
MHEG5Bool	MH5_SupportPVRExtension (void)
	Return whether PVR extension (ETSI, and originally NZ) is supported. More...
MHEG5Bool	MH5_SupportServiceInfoExtension (void)
	Return whether Service Info extension is supported. More...
void	MH5_SetCurrentProfile (E_ProfileId profile)
	Set current profile - CI plus or broadcast (Could extend this fnc to distuinguish between UK/HK/NZ/AU etc) More...
E_ProfileId	MH5_GetCurrentProfile (void)
	Get current profile - CI plus or broadcast. More...
MHEG5Bool	MH5_SupportFontClass (void)
	Return whether font class is supported by current profile. More...
MHEG5Int	MH5_MaxStorageFileLength (void)
	Return maximum length of file for persistent storage depending on supported profiles (e.g. for just UK, it is 1024) More...
MHEG5Bool	MH5_GetEngineSupport (MHEG5String feature)
	Used by the GetEngineSupport action. More...
MHEG5String	MH5_WhoAmI (void)
	Used by the WhoAmI resident program to obtain WhoAmI string. See UK1.06 profile section 3.10.10.1. More...
const char *	MHEG5VersionString (void)
const char *	MHEG5RevisionString (void)

Detailed Description

Engine support utility functions for MHEG5.

Date

01/10/2010

Author

Adam Sturtridge

Function Documentation

E_ProfileId MH5_GetCurrentProfile

(

void

)

Get current profile - CI plus or broadcast.

Returns

void

MHEG5Bool MH5_GetEngineSupport

(

MHEG5String

feature

)

Used by the GetEngineSupport action.

Parameters

feature

Get engine support sting to test

Returns

MHEG5Bool - True if supported

U8BIT* MH5_GetEngineVersionString

(

void

)

Returns a pointer to the engine version string U8BIT*.

Returns

Pointer to a manufacturer specific platform U8BIT*.

U8BIT* MH5_GetManufacturerString

(

void

)

Returns a pointer to a manufacturer specific platform U8BIT*.

Returns

Pointer to a manufacturer specific platform U8BIT*.

U8BIT* MH5_GetUserAgent

(

void

)

Return the "User Agent" string for the engine.

Returns

User agent string for the engine

MHEG5Int MH5_MaxStorageFileLength

(

void

)

Return maximum length of file for persistent storage depending on supported profiles (e.g. for just UK, it is 1024)

Returns

int

void MH5_SetCurrentProfile

(

E_ProfileId

profile

)

Set current profile - CI plus or broadcast (Could extend this fnc to distuinguish between UK/HK/NZ/AU etc)

Parameters

profile

Profile

Returns

void

MHEG5Bool MH5_SupportFontClass

(

void

)

Return whether font class is supported by current profile.

Returns

TRUE if supported

MHEG5Bool MH5_SupportHDGraphics

(

void

)

Returns whether supporting HD Graphics extension.

Returns

TRUE is supported

MHEG5Bool MH5_SupportHDVideo

(

void

)

Returns whether supporting HD Video extension.

Returns

TRUE is supported

MHEG5Bool MH5_SupportICStreaming

(

void

)

Return whether Interaction channel Streaming is supported.

Returns

TRUE if supported

E_MhegErr MH5_SupportInitialise

(

S_MhegConfig *

pConfig

)

Initialise support module - called when 'Open' engine.

Parameters

pConfig

Structure passed to Open function

Returns

E_MhegErr

Parameters

pSetup

Structure passed to MHEG5_Open()

Returns

void

MHEG5Bool MH5_SupportInteractionChannel

(

void

)

Return whether Interaction channel is supported by current profile.

Returns

TRUE if supported

MHEG5Bool MH5_SupportMhegProfile

(

E_MHEG_PROFILE

profile

)

Return whether Mheg profile (UK, NZ, AU, HK, SA, FREESAT) is currently supported.

Returns

void

MHEG5Bool MH5_SupportNativeApplication

(

void

)

Return whether Native Application extension is supported.

Returns

TRUE if supported

MHEG5Bool MH5_SupportPVRExtension

(

void

)

Return whether PVR extension (ETSI, and originally NZ) is supported.

Returns

TRUE if supported

MHEG5Bool MH5_SupportServiceInfoExtension

(

void

)

Return whether Service Info extension is supported.

Returns

TRUE if supported

MHEG5String MH5_WhoAmI

(

void

)

Used by the WhoAmI resident program to obtain WhoAmI string. See UK1.06 profile section 3.10.10.1.

Returns

the WhoAmI string