MHEG  17.9.0
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Pages
mh5support.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2010 Ocean Blue Software Ltd
4  *
5  * This file is part of a DTVKit Software Component
6  * You are permitted to copy, modify or distribute this file subject to the terms
7  * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
8  *
9  * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
10  * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
11  * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
12  *
13  * If you or your organisation is not a member of DTVKit then you have access
14  * to this source code outside of the terms of the licence agreement
15  * and you are expected to delete this and any associated files immediately.
16  * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
17  *******************************************************************************/
25 #ifndef _MH5_SUPPORT_H
26 #define _MH5_SUPPORT_H
27 
28 /*---includes for this file--------------------------------------------------*/
29 #include "mh5base.h"
30 #include "mheg5_control.h"
31 
32 /*---Constant and macro definitions for public use---------------------------*/
33 
34 /*---Enumerations for public use---------------------------------------------*/
35 
36 /*---Global type defs for public use-----------------------------------------*/
37 
38 typedef enum
39 {
40  PROFILE_BROADCAST,
41  PROFILE_CI_PLUS
42 } E_ProfileId;
43 
44 /*---Global variable declarations for public use-----------------------------*/
45 
46 /*---Global Function prototypes for public use-------------------------------*/
47 
53 E_MhegErr MH5_SupportInitialise( S_MhegConfig *pConfig );
54 
59 U8BIT* MH5_GetManufacturerString(void);
60 
65 U8BIT* MH5_GetEngineVersionString(void);
66 
71 U8BIT* MH5_GetUserAgent(void);
72 
77 MHEG5Bool MH5_SupportInteractionChannel(void);
78 
83 MHEG5Bool MH5_SupportICStreaming(void);
84 
91 MHEG5Bool MH5_SupportMhegProfile( E_MHEG_PROFILE profile );
92 
97 MHEG5Bool MH5_SupportHDGraphics(void);
98 
103 MHEG5Bool MH5_SupportHDVideo(void);
104 
109 MHEG5Bool MH5_SupportNativeApplication(void);
110 
115 MHEG5Bool MH5_SupportPVRExtension(void);
116 
117 
122 MHEG5Bool MH5_SupportServiceInfoExtension(void);
123 
130 void MH5_SetCurrentProfile( E_ProfileId profile );
131 
138 void MH5_SetCurrentProfile( E_ProfileId profile );
139 
145 E_ProfileId MH5_GetCurrentProfile( void );
146 
151 MHEG5Bool MH5_SupportFontClass( void );
152 
158 MHEG5Int MH5_MaxStorageFileLength( void );
159 
165 MHEG5Bool MH5_GetEngineSupport( MHEG5String feature );
166 
172 MHEG5String MH5_WhoAmI(void);
173 
174 const char* MHEG5VersionString(void);
175 const char* MHEG5RevisionString(void);
176 
177 #endif /*_MH5_SUPPORT_H*/
void MH5_SetCurrentProfile(E_ProfileId profile)
Set current profile - CI plus or broadcast (Could extend this fnc to distuinguish between UK/HK/NZ/AU...
Definition: mh5support.c:528
Basis MHEG5 data types.
MHEG5Bool MH5_SupportHDGraphics(void)
Returns whether supporting HD Graphics extension.
Definition: mh5support.c:465
Definition: mh5base.h:82
U8BIT * MH5_GetUserAgent(void)
Return the "User Agent" string for the engine.
Definition: mh5support.c:1552
MHEG5Bool MH5_SupportPVRExtension(void)
Return whether PVR extension (ETSI, and originally NZ) is supported.
Definition: mh5support.c:498
U8BIT * MH5_GetManufacturerString(void)
Returns a pointer to a manufacturer specific platform U8BIT*.
Definition: mh5support.c:405
E_ProfileId MH5_GetCurrentProfile(void)
Get current profile - CI plus or broadcast.
Definition: mh5support.c:551
MHEG5Bool MH5_SupportICStreaming(void)
Return whether Interaction channel Streaming is supported.
Definition: mh5support.c:436
MHEG5Int MH5_MaxStorageFileLength(void)
Return maximum length of file for persistent storage depending on supported profiles (e...
Definition: mh5support.c:574
MHEG5Bool MH5_SupportHDVideo(void)
Returns whether supporting HD Video extension.
Definition: mh5support.c:474
This file provides the control interface for MHEG5 engine. The use of this component MUST comply with...
MHEG5String MH5_WhoAmI(void)
Used by the WhoAmI resident program to obtain WhoAmI string. See UK1.06 profile section 3...
Definition: mh5support.c:709
E_MhegErr MH5_SupportInitialise(S_MhegConfig *pConfig)
Initialise support module - called when 'Open' engine.
Definition: mh5support.c:235
MHEG5Bool MH5_SupportNativeApplication(void)
Return whether Native Application extension is supported.
Definition: mh5support.c:483
Definition: mheg5_control.h:152
MHEG5Bool MH5_SupportMhegProfile(E_MHEG_PROFILE profile)
Return whether Mheg profile (UK, NZ, AU, HK, SA, FREESAT) is currently supported. ...
Definition: mh5support.c:451
MHEG5Bool MH5_SupportInteractionChannel(void)
Return whether Interaction channel is supported by current profile.
Definition: mh5support.c:423
MHEG5Bool MH5_SupportServiceInfoExtension(void)
Return whether Service Info extension is supported.
Definition: mh5support.c:513
MHEG5Bool MH5_SupportFontClass(void)
Return whether font class is supported by current profile.
Definition: mh5support.c:560
U8BIT * MH5_GetEngineVersionString(void)
Returns a pointer to the engine version string U8BIT*.
Definition: mh5support.c:414
MHEG5Bool MH5_GetEngineSupport(MHEG5String feature)
Used by the GetEngineSupport action.
Definition: mh5support.c:584