mheg5_ci.h File Reference

This file describes the interface to an MHEG5 component for CI. For example, MHEG5_StartCIApplication() is an alternative to MHEG5_Start() - see 'mheg5_control.h'. Please be aware that ONLY when the platform has a CI+ software stack, would these functions do something useful. References: [1] UK1 Profile - Digital Terrestrial Television MHEG-5 Specification, Version 1.05, October 1999. [2] Digital Terrestrial Television MHEG-5 Specification, Version 1.06, May 2003. More...

#include "techtype.h"
#include "mherrors.h"

Go to the source code of this file.

Functions
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 call to MHEG5_StopCIApplications. This function will asynchronously return either MHEG5_CI_APPLICATION_START_FAILED, MHEG5_CI_APPLICATION_STARTED or MHEG5_CI_APPLICATION_STOPPED through event call back function F_NotifyMhegEvent. Asynchronous notifications that will occur during the start of a CI application process are: More...
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. More...
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 STB_CIFileRequest. The memory for storing the fileData is managed by the controlling application. When the MHEG5 component has finished using the fileData it will invoke the DVB_MhegCiAckData function. More...

Detailed Description

This file describes the interface to an MHEG5 component for CI. For example, MHEG5_StartCIApplication() is an alternative to MHEG5_Start() - see 'mheg5_control.h'. Please be aware that ONLY when the platform has a CI+ software stack, would these functions do something useful. References: [1] UK1 Profile - Digital Terrestrial Television MHEG-5 Specification, Version 1.05, October 1999. [2] Digital Terrestrial Television MHEG-5 Specification, Version 1.06, May 2003.

Date

20/12/2012

Author

Adam Sturtridge

Function Documentation

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 STB_CIFileRequest. The memory for storing the fileData is managed by the controlling application. When the MHEG5 component has finished using the fileData it will invoke the DVB_MhegCiAckData function.

Parameters

fileOK	FileOK flag from the FileAcknowledge message
pFileData	Pointer to the response data, following the FileOK flag
fileSize	Size of response data

Returns

MHERR_OK - Success MHERR_COMP_NOT_STARTED - Component not started. MHERR_BAD_PARAMETER - Invalid parameter.

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 call to MHEG5_StopCIApplications. This function will asynchronously return either MHEG5_CI_APPLICATION_START_FAILED, MHEG5_CI_APPLICATION_STARTED or MHEG5_CI_APPLICATION_STOPPED through event call back function F_NotifyMhegEvent. Asynchronous notifications that will occur during the start of a CI application process are:

1. MHEG5_CI_APPLICATION_START_FAILED - Failed to launch the CI application because it was either not present, a CI session was not established or there was an internal error.
2. MHEG5_CI_APPLICATION_STARTED - CI application started successfully.
3. MHEG5_CI_APPLICATION_STOPPED - Returned after call to either MHEG5_StopCIApplication() or MHEG5_Stop() whilst trying to start the CI application. This notification will also occur when the CI application has completed with a quit application action. This is a non-blocking function, which may return before completion.

   Parameters

   application

   Application name, relative to the root of the CI file system. This has a maximum length of 64 characters.

   Returns

   MHERR_OK - Success MHERR_COMP_NOT_STARTED - Component not started. MHERR_BAD_PARAMETER - Invalid parameter. MHERR_INTERNAL - Internal MHEG5 component error.

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.

Returns

MHERR_OK - Success MHERR_COMP_NOT_STARTED - Component not started. MHERR_INTERNAL - Internal MHEG5 component error.