smsctrllib.h

组拨技术

								 		UINT32*		pPidList );

/*************************************************************************/

/*!
	Requests to add IP to IP filters list.
	
	\param[in]	pIpFilter		DVB-H service information, according to #SMSHOSTLIB_IP_DVBH_SRV_ST structure

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous, the callback given at
				\c SmsHostLibInit() is executed when a response is available.

	\see		Response type is SMSHOSTLIB_MSG_ADD_IP_FILTER_RES \n
				There are no supplementary parameters in the response.
*/
	
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API 
	SmsHostAddIpFilter_Req(	SMSHOSTLIB_IP_DVBH_SRV_ST*	pIpFilter );

/*************************************************************************/

/*!
	Requests to remove IP from IP filters list
	
	\param[in]	pIpFilter		Structure contains DVB-H service information

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous, the callback given at
				\c SmsHostLibInit() is executed when a response is available

	\see		Response type is SMSHOSTLIB_MSG_REMOVE_IP_FILTER_RES \n
				There are no supplementary parameters in the response.
*/	
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API 
	SmsHostRemoveIpFilter_Req(	SMSHOSTLIB_IP_DVBH_SRV_ST*	pIpFilter );

/*************************************************************************/

/*!
	Requests IP filters list.
	
	\param[in]	MaxNumFilters	The maximum number of IP filters may reported (Maximum buffer length).
	\param[out]	pActNum		The actual number of reported IP filters
	\param[out]	pIpFilter	Buffer of reported filtered IPs

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous, the callback given at
				\c SmsHostLibInit() is executed when a response is available.

	\see		Response type is SMSHOSTLIB_MSG_GET_IP_FILTER_LIST_RES \n
				There are no supplementary parameters in the response.
*/	
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API 
	SmsHostGetIpFilterList_Req( UINT32						MaxNumFilters,
								UINT32*						pActNum,
								SMSHOSTLIB_IP_DVBH_SRV_ST*	pIpFilter );

/*************************************************************************/

/*!
	Request a list of available IP platforms

	\param[in]	MaxNumIpPlatforms	The maximum number of IP platforms may reported (Maximum buffer length).
	\param[out]	pActNum				The actual number of reported IP platforms
	\param[out]	pIpPlatforms		Buffer of reported IP platforms

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous, the callback given at
				\c SmsHostLibInit() is executed when a response is available.

	\see		Response type is SMSHOSTLIB_MSG_GET_AVAIL_IP_PLATFORMS_RES \n
				The response will provide a pointer to a structure of type AVAIL_IPO_PLAT_ST
	*/	
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API  
	SmsHostGetAvailableIpPlatforms_Req (	UINT32					MaxNumIpPlatforms,  
											UINT32*					pActNum,
											SMSHOSTLIB_IP_PLAT_ST*	pIpPlatforms ); 


/*************************************************************************/

/*!
	Request a DVB SI table

	\param[in]	TablePID			The PID of the required table
	\param[in]	TableID				The ID of the required table
	\param[in]	MaxTableBuffSize	The maximum length (byte) available in the application buffer
	\param[out]	pActSize			The actual size of the table
	\param[out]	pTableBuff			Pointer to the application buffer that will contain the table
	
	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous, the callback given at
				\c SmsHostLibInit() is executed when a response is available.

	\see		Response type is SMSHOSTLIN_MSG_GET_SI_TBL_RES \n
*/	
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API 
	SmsHostDvbGetSITable_Req(	UINT32	TablePID,
								UINT32	TableID,
								UINT32	MaxTableBuffSize,
								UINT32*	pActSize,
								UINT8*	pTableBuff );

/*************************************************************************/
/*!
	Retrieves TDT's UTC time field .

	\param[out]	pUtcTime		Current time and date

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous, the callback given at
				\c SmsHostLibInit() is executed when a response is available.
				
	\see		Response type is SMSHOSTLIB_MSG_UTC_TIME_RES. \n
				There are no supplementary parameters in the response.
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API 
	SmsHostDvbTDT_Req( UTC_TIME_ST* pUtcTime );

/*************************************************************************/

/*!
	Retrieves TOT's data

	\param[out]	pUtcTime			Current time and date
	\param[in]	MaxNumElemnt		Maximum number of elements
	\param[out]	pActElemntNum		Actual number of reported time offset elements
	\param[out]	pTimeElementsArray	Buffer for time offset elements

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous, the callback given at
				\c SmsHostLibInit() is executed when a response is available.
				
	\see		Response type is SMSHOSTLIB_MSG_TIME_OFFSET_RES. \n
				There are no supplementary parameters in the response.
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API 
	SmsHostDvbTOT_Req(	UTC_TIME_ST*	pUtcTime,
						UINT32			MaxNumElemnt,
						UINT32*			pActElemntNum,
						TIME_OFFSET_ST*	pTimeElementsArray );


/*************************************************************************/

/** 
*  @}
*/

/** @defgroup group5 DAB/DMB APIs
 *  @{
 */

/*************************************************************************
*			 DAB/DMB API
*************************************************************************/

/*************************************************************************/

/*!
	Get current Ensemble information
	
	\param[in]	MaxNumOfEnsembles	The maximum number of ensembles may reported (Maximum buffer length).
	\param[out]	pActNum				The actual number of reported ensembles
	\param[out]	pEnsembleInfo		Buffer of reported ensembles

	\return		Error code by #SMSHOSTLIB_ERR_CODES_E enumerator

	\remark		This command execution is asynchronous. The buffer is\n
				filled when the response SMSHOSTLIB_MSG_GET_ENSEMBLE_INFO_RES is generated.\n

				pActNum can return zero elements with OK error code.
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API  
	SmsHostDabGetEnsembleInfo_Req(	UINT32 							MaxNumOfEnsembles,
									UINT32*							pActNum,
									SMSHOSTLIB_ENSEMBLE_INFO_ST*	pEnsembleInfo );

/*************************************************************************/

/*!
	Request to retrieve information about available services in a specific ensemble

	\param[in]	EIdx				The ensemble index
	\param[in]	MaxNumOfServices	The maximum number of services may reported (Maximum buffer length).
	\param[out]	pActNum				The actual number of reported services
	\param[out] pServiceInfos		Pointer to array of service information structures

	\return		Error code by #SMSHOSTLIB_ERR_CODES_E enumerator

	\remark		This command execution is asynchronous. 
				Response type is SMSHOSTLIB_MSG_GET_SERVICES_RES
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API  
	SmsHostDabGetServices_Req (	UINT32 						EIdx,
								UINT32 						MaxNumOfServices,
								UINT32*						pActNum,
								SMSHOSTLIB_SERVICE_INFO_ST* pServiceInfos );

/*************************************************************************/

/*!
	Request to retrieve information about available service components for a given service
	and a given ensemble

	\param[in]	EIdx				The ensemble index
	\param[in]	ServiceID			The service ID
	\param[in]	MaxNumOfComponents	The maximum number of service components may reported (Maximum buffer length).
	\param[out]	pActNum				The actual number of reported service components
	\param[out] pComponentInfos		Pointer to array of service components information structures

	\return		Error code by #SMSHOSTLIB_ERR_CODES_E enumerator

	\remark		This command execution is asynchronous. 
				Response type is SMSHOSTLIB_MSG_GET_COMPONENTS_INFO_RES
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API  
	SmsHostDabGetComponentsInfo_Req(UINT32							EIdx,
									UINT32							ServiceID, 
								 	UINT32							MaxNumOfComponents,
								 	UINT32*							pActNum,
									SMSHOSTLIB_COMPONENT_INFO_ST*	pComponentInfos );

/*************************************************************************/

/*!
	Request to retrieve all information about available service components

	\param[in]	MaxNumOfCombinedComponents	The maximum number of service components may reported (Maximum buffer length).
	\param[out]	pActNum						The actual number of reported service components
	\param[out] pCombinedComponentInfos		Pointer to array of combined service components information structures

	\return		Error code by #SMSHOSTLIB_ERR_CODES_E enumerator

	\remark		This command execution is asynchronous. 
				Response type is SMSHOSTLIB_MSG_GET_COMBINED_COMPONENTS_INFO_RES
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API  
	SmsHostDabGetCombinedComponentsInfo_Req(
				UINT32									MaxNumOfCombinedComponents,
				UINT32*									pActNum,
				SMSHOSTLIB_COMBINED_COMPONENT_INFO_ST*	pCombinedComponentInfos );

/*************************************************************************/

/*!
	Requests to begin reception of a given service

	\param[in]  EIdx			The ensemble index
	\param[in]  ServiceID		Service Identifier
	\param[in]  SCIdS			Service Component Identifier within the Service
	\param[out] pServiceHandle	Returned service handle, valid only when the response is OK

	\return		Response type is a handle that represents the data stream being played.

	\remark		This command execution is asynchronous\n
				Response is SMSHOSTLIB_MSG_START_SERVICE_RES
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API  
	SmsHostDabStartService_Req(	UINT32 EIdx,
								UINT32 ServiceID,
								UINT32 SCIdS,
								UINT32 *pServiceHandle );

/*************************************************************************/

/*!
	Requests to stop reception of a given service

	\param[in]	ServiceHandle	Handle of given service, obtained from SmsHostDabStartService_Req()

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous \n
				Response is SMSHOSTLIB_MSG_STOP_SERVICE_RES
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API
	SmsHostDabStopService_Req (UINT32 ServiceHandle);

/*************************************************************************/

/*!
	Request to get the index of the current ensemble

	\param[out]	pEIdx	Pointer to Ensemble ID

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous\n
				Response is SMSHOSTLIB_GET_CURR_ENSEMBLE_INDEX_RES
*/
SMSHOSTLIB_ERR_CODES_E SMSHOSTLIB_API  
	SmsHostDabGetCurrentEnsembleIndex_Req ( UINT32* pEIdx );


/*************************************************************************/

/*!
	Requests to set or clear the state of measuring the post Viterbi BER on one DMB service.

	\param[in]	setOrClear is a boolean parameter to set (TRUE) or clear (FALSE) the machine state

	\return		Error code by  #SMSHOSTLIB_ERR_CODES_E enumerator.

	\remark		This command execution is asynchronous \n
				Response is SMSHOSTLIB_MSG_POST_VITERBI_BER_STATE_SET_RES

	\note		The function can be called only when none of the services is played.\n
				When in measuring state, only one video (DMB) service can be activated. \n
																			 \n 
				Before calling this function make sure you do the following: \n
				-# Tune to the frequency you want.                           \n
				-# Make sure the modem is locked.						     \n
				-# Call this function.										 \n 
																		     \n
				After calling this function make sure you do the following:  \n				
																			 \n
				-# Start a DMB service