MHEG  17.9.0
 All Data Structures Files Functions Variables Typedefs Enumerations Macros Pages
mheg5_ci.h
Go to the documentation of this file.
1 /*******************************************************************************
2  * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
3  * Copyright © 2012 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  *******************************************************************************/
34 #ifndef _MHEG5_CI_H
35 #define _MHEG5_CI_H
36 
37 #include "techtype.h"
38 #include "mherrors.h"
39 
40 /*---Constant and macro definitions for public use-----------------------------*/
41 
42 /*---Enumerations for public use-----------------------------------------------*/
43 
44 /*---Global type defs for public use-------------------------------------------*/
45 
46 /*---Global Function prototypes for public use---------------------------------*/
47 
75 E_MhegErr MHEG5_StartCIApplication(U32BIT module, U8BIT *application);
76 
77 
94 E_MhegErr MHEG5_StopCIApplication(void);
95 
96 
110 E_MhegErr MHEG5_CiFileAcknowledge(U32BIT module, BOOLEAN fileOK,
111  U8BIT *pFileData, U32BIT fileSize);
112 
113 
114 #endif /* _MHEG5_CI_H */
MHEG5 engine interface error codes.
E_MhegErr MHEG5_StartCIApplication(U32BIT module, U8BIT *application)
Instruct the MHEG5 component to start a specified CI application. This process may be stopped by a ca...
E_MhegErr MHEG5_CiFileAcknowledge(U32BIT module, BOOLEAN fileOK, U8BIT *pFileData, U32BIT fileSize)
The MMI FileAcknowledge message, which is a reply from the CI module to an MMI FileRequest sent using...
System Wide Global Technical Data Type Definitions.
E_MhegErr MHEG5_StopCIApplication(void)
Stop any currently running CI MHEG5 applications. This is a non-blocking function, and may return before completion. This function will asynchronously return MHEG5_CI_APPLICATION_STOPPED, through through event call back function F_NotifyMhegEvent, when the current CI application(s) have been stopped. If there are no CI applications running then the notification, MHEG5_CI_APPLICATION_STOPPED, will still be sent. If any currently running CI application is stopped then the default DSM-CC auto-boot application will be launched. See section 6.10 of reference [1] for details of interaction between the MHEG-5 component and the CI module.