vapi.h File Reference

#include "ut.h"
#include "vapi_profile.h"
#include "vapi_config.h"
#include "vapi_device_config.h"

Classes
struct	_SMailbox
struct	_SMsg
struct	_SChangeConnInfo
struct	_STranscodingOption
struct	_SConfParams
struct	_SConfDTSParams
struct	_SHwCfg
struct	_SEventDetParams
struct	_SSpiEventParams
struct	_SToneDetectEventParams
struct	_SIPToneDetectEventParams
struct	_SToneGenCmpltEventParams
struct	_SPtChangeEventParams
struct	_SSsrcChangeEventParams
struct	_SSsrcViolationEventParams
struct	_SNteRecvdEventParams
struct	_SCallerIdCmpltEventParams
struct	_SG711ConcurntDecoderEventParams
struct	_SPassthruConcurntDecoderEventParams
struct	_SDecoderEventParams
struct	_SRemoteDetectEventParams
struct	_SCIDReceivedMSG
struct	_SFaxSwEventParams
struct	_SUndefinedEventParams
struct	_CidInfo
struct	_SCallerIdInfo
struct	_SCidDetCtrl
struct	_SPlayToneOpt
struct	_STdmBusParams
struct	_STdmSetupParams
struct	_SIpAddrInfo
struct	_SFaxOpts
struct	_SFaxConfigOpts
struct	_SAlrtIndParams
struct	_SH245IndParams
struct	_SSYNCDATParams
struct	_SSYNCEOFParams
struct	_SIpParams
struct	_SC2CConnectOption
struct	_SRequest
struct	_SPlayData
struct	_SRecData
struct	_SConvertData
struct	_SModifyConnectionInfo
Defines
#define	SUCCESS   0
#define	FAILURE   -1
#define	IN
#define	OUT
#define	VAPI_VERSION(a, b, c)   (((a) << 16) + ((b) << 8) + (c))
#define	VAPI_API_VERSION(a, b)   (((a) << 8) + (b))
#define	A_LAW   0
#define	U_LAW   1
#define	CMD_LEVEL_CONN   0
#define	CMD_LEVEL_DEVICE   1
#define	CMD_LEVEL_CONF   2
#define	EVENT_LEVEL_CONN   0
#define	EVENT_LEVEL_DEVICE   1
#define	EVENT_LEVEL_GENERIC   2
#define	FIFO_MIN_SIZE   8
#define	DEFAULT_FIFO_MAX_SIZE   256
#define	PADDING_SIZE   6
#define	VAPI_PCI_DUMP_MAX_BLK   256
#define	NO_DEBUG   0
#define	API_LEVEL   1
#define	API_PACKET_LEVEL   2
#define	VAPI_INFO   3
#define	VAPI_GTL_INFO   4
#define	VAPI_UT   5
#define	ALL_INFO   6
#define	INFO   1
#define	DEBUG   2
#define	PACKET   3
#define	WARN   4
#define	ALWYS   5
#define	MAX_SYNCDAT_BUF_SIZE   240
#define	VAPI_HWCFG_SDRAM_TIMING_MASK   0x01
#define	VAPI_NUM_RESOURCES   eResConferencing + 1
#define	VAPI_EnableConnection(x, y)   VAPI_SetConnectionState(x, eActive, y)
#define	VAPI_DisableConnection(x, y)   VAPI_SetConnectionState(x, eTdmActive, y)
#define	VAPI_EchoCancellorReset(x, y)   VAPI_EchoCancellerReset(x, y)
#define	VAPI_ERROR_BASE   68000
#define	VAPI_ERR_INVALID_DEVID   -(VAPI_ERROR_BASE + 1)
#define	VAPI_ERR_INVALID_CONNID   -(VAPI_ERROR_BASE + 2)
#define	VAPI_ERR_NOMEM   -(VAPI_ERROR_BASE + 3)
#define	VAPI_ERR_INVALID_PARAM   -(VAPI_ERROR_BASE + 4)
#define	VAPI_ERR_NULL_POINTER_PASSED   -(VAPI_ERROR_BASE + 5)
#define	VAPI_ERR_MSP_NO_RESPONSE   -(VAPI_ERROR_BASE + 6)
#define	VAPI_ERR_UNSUPP_FEATURE   -(VAPI_ERROR_BASE + 7)
#define	VAPI_ERR_DEVICE_EXISTS   -(VAPI_ERROR_BASE + 8)
#define	VAPI_ERR_RSRC_INIT_FAILED   -(VAPI_ERROR_BASE + 9)
#define	VAPI_ERR_INVALID_IMAGE   -(VAPI_ERROR_BASE + 10)
#define	VAPI_ERR_UNDEFINED   -(VAPI_ERROR_BASE + 11)
#define	VAPI_ERR_PENDING   -(VAPI_ERROR_BASE + 12)
#define	VAPI_ERR_UNEXPECTED_MSP_RESPONSE   -(VAPI_ERROR_BASE + 13)
#define	VAPI_ERR_INVALID_OPERATION   -(VAPI_ERROR_BASE + 14)
#define	VAPI_ERR_LIB_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 15)
#define	VAPI_ERR_DEV_IS_UP   -(VAPI_ERROR_BASE + 16)
#define	VAPI_ERR_DEV_IS_NOT_UP   -(VAPI_ERROR_BASE + 17)
#define	VAPI_ERR_DEVIP_NOTSET   -(VAPI_ERROR_BASE + 18)
#define	VAPI_ERR_INCOMP_SRC_UDP   -(VAPI_ERROR_BASE + 19)
#define	VAPI_ERR_INCOMP_DEST_IPUDP   -(VAPI_ERROR_BASE + 20)
#define	VAPI_ERR_IP_HDR_NOT_SET   -(VAPI_ERROR_BASE + 22)
#define	VAPI_ERR_INVALID_CONFID   -(VAPI_ERROR_BASE + 23)
#define	VAPI_ERR_INVALID_DEV_STATE   -(VAPI_ERROR_BASE + 24)
#define	VAPI_ERR_INVALID_MEM_IDX   -(VAPI_ERROR_BASE + 25)
#define	VAPI_ERR_INVALID_OFFSET   -(VAPI_ERROR_BASE + 26)
#define	VAPI_ERR_INVALID_CONF_ID   -(VAPI_ERROR_BASE + 28)
#define	VAPI_ERR_SPU_FEATURE_NOT_ENABLED   -(VAPI_ERROR_BASE + 29)
#define	VAPI_ERR_MAAS_ASSIGN   -(VAPI_ERROR_BASE + 34)
#define	VAPI_ERR_PROG_START   -(VAPI_ERROR_BASE + 35)
#define	VAPI_ERR_SUPVSR_READY   -(VAPI_ERROR_BASE + 36)
#define	VAPI_ERR_INVALID_CONN_TYPE   -(VAPI_ERROR_BASE + 37)
#define	VAPI_ERR_TIMEOUT   -(VAPI_ERROR_BASE + 44)
#define	VAPI_ERR_FIFO_SIZE   -(VAPI_ERROR_BASE + 45)
#define	VAPI_ERR_PT_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 46)
#define	VAPI_ERR_MULTI_CMD_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 47)
#define	VAPI_ERR_DEVICE_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 48)
#define	VAPI_ERR_ALT_HDR_NOT_SET   -(VAPI_ERROR_BASE + 49)
#define	VAPI_ERR_UNDEFINED_EVENT   -(VAPI_ERROR_BASE + 50)
#define	VAPI_ERR_RECOVER_TIMESLOT   -(VAPI_ERROR_BASE + 51)
#define	VAPI_ERR_RECOVER_WRONG_TYPE   -(VAPI_ERROR_BASE + 52)
#define	VAPI_ERR_RECOVER_INVALID   -(VAPI_ERROR_BASE + 53)
#define	VAPI_ERR_CREATECONN_FAIL   -(VAPI_ERROR_BASE + 54)
#define	VAPI_ERR_CREATECONF_FAIL   -(VAPI_ERROR_BASE + 55)
#define	VAPI_ERR_INVALID_DEV_TYPE   -(VAPI_ERROR_BASE + 56)
#define	VAPI_ERR_WAIT_READY   -(VAPI_ERROR_BASE + 57)
#define	VAPI_ERR_TS_IN_USE   -(VAPI_ERROR_BASE + 58)
#define	VAPI_ERR_ILLEGAL_COMMAND   -(VAPI_ERROR_BASE + 59)
#define	VAPI_ERR_RES_MGR_NOT_ENABLED   -(VAPI_ERROR_BASE + 61)
#define	VAPI_ERR_NO_RESOURCE   -(VAPI_ERROR_BASE + 62)
#define	VAPI_ERR_NO_RESOURCE_ALLOC   -(VAPI_ERROR_BASE + 63)
#define	VAPI_ERR_INVALID_RESOURCE   -(VAPI_ERROR_BASE + 64)
#define	VAPI_ERR_UNKNOWN_RESOURCE   -(VAPI_ERROR_BASE + 65)
#define	VAPI_ERR_RES_MGR_NOT_SUPPORTED   -(VAPI_ERROR_BASE + 66)
Typedefs
typedef unsigned char	U8
typedef unsigned short	U16
typedef unsigned int	U32
typedef signed char	S8
typedef signed short	S16
typedef signed int	S32
typedef int	VSTATUS
typedef U32	CONNID
typedef U32	DEVID
typedef U32	CONFID
typedef U32	PARTID
typedef struct _SMailbox	SMailbox
typedef struct _SMsg	SMsg
typedef struct _SChangeConnInfo	SChangeConnInfo
typedef struct _STranscodingOption	STranscodingOption
typedef struct _SConfParams	SConfParams
typedef struct _SConfDTSParams	SConfDTSParams
typedef struct _SHwCfg	SHwCfg
typedef struct _SEventDetParams	SEventDetParams
typedef struct _SSpiEventParams	SSpiEventParams
typedef struct _SToneDetectEventParams	SToneDetectEventParams
typedef struct _SIPToneDetectEventParams	SIPToneDetectEventParams
typedef struct _SToneGenCmpltEventParams	SToneGenCmpltEventParams
typedef struct _SPtChangeEventParams	SPtChangeEventParams
typedef struct _SSsrcChangeEventParams	SSsrcChangeEventParams
typedef struct _SSsrcViolationEventParams	SSsrcViolationEventParams
typedef struct _SNteRecvdEventParams	SNteRecvdEventParams
typedef struct _SCallerIdCmpltEventParams	SCallerIdCmpltEventParams
typedef struct _SG711ConcurntDecoderEventParams	SG711ConcurntDecoderEventParams
typedef struct _SPassthruConcurntDecoderEventParams	SPassthruConcurntDecoderEventParams
typedef struct _SDecoderEventParams	SDecoderEventParams
typedef struct _SRemoteDetectEventParams	SRemoteDetectEventParams
typedef struct _SCIDReceivedMSG	SCIDReceivedMSG
typedef struct _SFaxSwEventParams	SFaxSwEventParams
typedef struct _SUndefinedEventParams	SUndefinedEventParams
typedef struct _CidInfo	CidInfo
typedef struct _SCallerIdInfo	SCallerIdInfo
typedef struct _SCidDetCtrl	SCidDetCtrl
typedef struct _SPlayToneOpt	SPlayToneOpt
typedef struct _STdmBusParams	STdmBusParams
typedef struct _STdmSetupParams	STdmSetupParams
typedef struct _SIpAddrInfo	SIpAddrInfo
typedef struct _SFaxOpts	SFaxOpts
typedef struct _SFaxConfigOpts	SFaxConfigOpts
typedef struct _SAlrtIndParams	SAlrtIndParams
typedef struct _SH245IndParams	SH245IndParams
typedef struct _SSYNCDATParams	SSYNCDATParams
typedef struct _SSYNCEOFParams	SSYNCEOFParams
typedef struct _SIpParams	SIpParams
typedef struct _SC2CConnectOption	SC2CConnectOption
typedef void(*	PFNEventCallback )(EEventCode eEventCode, void *pvData)
typedef void(*	PFNIoCompCallback )(U32 uiId, U8 ucCmdLevel, S32 iStatus, void *pvReturnData, U32 uiReturnDataLen, U32 uiReqId)
typedef struct _SRequest	SRequest
typedef struct _SPlayData	SPlayData
typedef struct _SRecData	SRecData
typedef struct _SConvertData	SConvertData
typedef struct _SModifyConnectionInfo	SModifyConnectionInfo
typedef enum _EResAction	EResAction
typedef VSTATUS(*	PFNResetDevice )(void *pvData)
Enumerations
enum	Boolean { False, True }
enum	EHoldState { eUNHOLD = 0, eSIMPLEHOLD = 1, eANNHOLD = 2 }
enum	EEventCode {   eVAPI_SPI_EVENT, eVAPI_TONE_DETECT_EVENT, eVAPI_TONE_GEN_CMPLT_EVENT, eVAPI_PT_CHANGE_EVENT,   eVAPI_SSRC_CHANGE_EVENT, eVAPI_SSRC_VIOLATION_EVENT, eVAPI_NTE_TRANSMIT_COMPLETE_EVENT, eVAPI_NTE_RECVD_EVENT,   eVAPI_CALLER_ID_CMPLT_EVENT, eVAPI_G711_CONCURRENT_DECODER_EVENT, eVAPI_PASSTHRU_CONCURRENT_DECODER_EVENT, eVAPI_DECODER_EVENT,   eVAPI_CALLER_ID_DETECTED_EVENT, eVAPI_REMOTE_DETECT_EVENT, eVAPI_FAX_SWITCH_CMPLT_EVENT, eVAPI_ALERT_IND,   eVAPI_IMSOTDM_H245_EVENT, eVAPI_SYNCDAT_EVENT, eVAPI_SYNCEOF_EVENT, eVAPI_IPTONE_DETECT_EVENT,   eVAPI_UNDEFINED_EVENT }
enum	EConnType {   eVOIP = 0x0002, eFOIP = 0x0007, eVOATM = 0x0008, eIUUPORTP = 0x0009,   eIUUPOAAL2 = 0x000A, eSLIC24 = 0x0010, eComplexTone = 0x0011, eToneDet = 0x0012,   eWARNING_TONEGEN = 0x0013, eIpRedirect = 0x0014, eHDL = 0x0015, eHDLCOTDM = 0x0017,   eDSPDIAG = 0x0020, eAAL1CES = 0x0040, eIMSOTDM = 0x0064, eCCS = 0x0080,   eCSEoPSN = 0x0081 }
enum	EConnMode { eNarrowBand = 0, eWideBand = 1 }
enum	EMediaSubLayer { eAudioSubLayer = 0, eVideoSubLayer = 1 }
enum	EConnOpMode { eInactive = 0, eTdmActive = 1, eActive = 2 }
enum	EChangeOpMode { eOpModeNone = 0, eOpModeMac = 1, eOpModeIP = 2 }
enum	EPartType
enum	ELoopbackType {   eTDM = 1, ePRE_ENCAPS = 2, ePOST_ENCAPS = 3, eRTP_DEC = 4,   eINTER_CHNL_POST_ENCAPS = 5, eINTER_CHNL_TDM = 6, eTHC = 7, eREMOVE_CHNL_LOOPBACK = 8,   eREMOVE_INTER_CHNL_POSTENCAPS_LOOPBACK = 9, eREMOVE_INTER_CHNL_TDM_LOOPBACK = 10, eREMOVE_THC_LOOPBACK = 11 }
enum	ECloseMode { ePURGE, ePURGE_ALL }
enum	EDirection { eTx, eRx, eBoth }
enum	EFaxSwitchEvents {   eLOCAL_CNG = 0x01, eREM_CNG = 0x02, eLOCAL_ANS = 0x04, eREM_ANS = 0x08,   eLOCAL_V21 = 0x10, eREM_UDPTL = 0x20 }
enum	ECountryCode { eUSA = 0, eINDIA = 1 }
enum	EAction { eRemove = 0, eAdd = 1, eModify = 2 }
enum	ECidGenInfoType {   eOnHookXmitInfoType = 0x01, eOffHookXmitInfoType = 0x02, eCPEAlertToneInfoType = 0x03, eCPEAckInfoType = 0x04,   eSASToneInfoType = 0x05, eNTTInfoType = 0x06, eStopBitsInfoType = 0x07, ePacketProcessingInfoType = 0x08 }
enum	ECidDetInfoType {   eDataFormatType = 0x01, eFSKDetectionType = 0x02, eOnHookDetType = 0x03, eOffHookDetType = 0x04,   eAckGenType = 0x05, eNTTDetType = 0x06 }
enum	EToneId {   eDTMFTONE_1 = 0, eDTMFTONE_2 = 1, eDTMFTONE_3 = 2, eDTMFTONE_4 = 3,   eDTMFTONE_5 = 4, eDTMFTONE_6 = 5, eDTMFTONE_7 = 6, eDTMFTONE_8 = 7,   eDTMFTONE_9 = 8, eDTMFTONE_A = 9, eDTMFTONE_B = 10, eDTMFTONE_C = 11,   eDTMFTONE_D = 12, eDTMFTONE_STAR = 13, eDTMFTONE_0 = 14, eDTMFTONE_HASH = 15,   eNULLTONE = 16, eCONGESTIONTONE = 17, eWARNINGTONE = 18, eWAITINGTONE = 19,   eCONFIRMATIONTONE = 20, eDIALTONE = 21, eBUSYTONE = 22, eRINGBACKTONE = 23,   eSPECIALTONE = 24, eSASTONE = 25, eCUSTOM_1 = 26, eCUSTOM_2 = 27,   eCUSTOM_3 = 28, eCUSTOM_4 = 29, eCUSTOM_5 = 30, eCUSTOM_6 = 31,   eCUSTOM_7 = 32, eCUSTOM_8 = 33, eCUSTOM_9 = 34, eCUSTOM_10 = 35,   eCUSTOM_11 = 36, eCUSTOM_12 = 37, eCUSTOM_13 = 38, eCUSTOM_14 = 39,   eCUSTOM_15 = 40, eCUSTOM_16 = 41, eCUSTOM_17 = 42, eCUSTOM_18 = 43,   eCUSTOM_19 = 44, eCUSTOM_20 = 45, eCUSTOM_21 = 46, eCUSTOM_22 = 47,   eCUSTOM_23 = 48, eCUSTOM_24 = 49, eCUSTOM_25 = 50, eCUSTOM_26 = 51,   eCUSTOM_27 = 52, eCUSTOM_28 = 53, eCUSTOM_29 = 54, eCUSTOM_30 = 55 }
enum	EToneDir
enum	EToneType
enum	ECodecType {   eGeneric_Comfort_Noise = 0, eRedundant_Scheme_for_DTMF = 1, eDTMF_RTP = 2, eIFP = 3,   eG711_ULAW_PCM = 4, eG711_ALAW_PCM = 5, eG723_1 = 6, eG728_Audio = 7,   eG729_A = 8, eG726_32 = 9, eReserved_Codec0 = 10, eGSM_FR_Audio = 11,   eClear_Channel = 12, ePassthrough_ULAW = 13, ePassthrough_ALAW = 14, eG726_16_audio = 15,   eG726_24_audio = 16, eG726_40_audio = 17, eGSM_EFR = 18, eAMR = 19,   eEVRC = 20, eCNF_SEC = 21, eSMV = 22, eQCELP_13K = 23,   eQCELP_8K = 24, eCRBT_ADPCM = 25, eG729_EG = 26, eFEC = 27,   eI_LBC_15K = 28, eI_LBC_13K = 29, eRFC2833_EVENT = 30, eGSM_AMR_BWE = 31,   e4GV = 32, eRFC2833_TONE = 33, eAMR_WB = 34, eG729_MSPD = 35,   eCESoPSN = 36, eGSM_HR = 37, eCSD_BS30T_64k = 38, eCSD_BS30T_32k = 39,   eCSD_BS30T_33k6 = 40, eCSD_BS30T_28k8 = 41, eCSD_BS20NT_57k6 = 42, eCSD_BS20NT_28k8 = 43,   eCSD_BS20NT_14k4 = 44, eG729_1 = 45, eAMR_WB_ba = 46, eCCISoIP = 47,   eG722 = 48, eReserved_Codec1 = 49, eReserved_Codec2 = 50, eReserved_Codec3 = 51,   eAMR_IF1 = 52, eAMR_IF2 = 53, eReserved_Codec4 = 54 }
enum	ECodecIndex {   eG711_ULAW_ID = 4, eG711_ALAW_ID = 5, eG723_1_ID = 6, eG728_Audio_ID = 7,   eG729_A_ID = 8, eG726_32_ID = 9, eGSM_FR_Audio_ID = 11, eClear_Channel_ID = 12,   ePassthrough_ULAW_ID = 13, ePassthrough_ALAW_ID = 14, eG726_16_audio_ID = 15, eG726_24_audio_ID = 16,   eG726_40_audio_ID = 17, eGSM_EFR_ID = 18, eAMR_ID = 19, eEVRC_ID = 20,   eSMV_ID = 22, eQCELP_13K_ID = 23, eQCELP_8K_ID = 24, eCRBT_ADPCM_ID = 25,   eG729_EG_ID = 26, eI_LBC_15K_ID = 28, eI_LBC_13K_ID = 29, GSM_AMR_BWE_ID = 31,   e4GV_ID = 32, eAMR_WB_ID = 34, eG729_MSPD_ID = 35, eCESoPSN_ID = 36,   eGSM_HR_ID = 37, eCSD_BS30T_64k_ID = 38, eCSD_BS30T_32k_ID = 39, eCSD_BS30T_33k6_ID = 40,   eCSD_BS30T_28k8_ID = 41, eCSD_BS20NT_57k6_ID = 42, eCSD_BS20NT_28k8_ID = 43, eCSD_BS20NT_14k4_ID = 44,   eG729_1_ID = 45, eAMR_WB_ba_ID = 46, eCCISoIP_ID = 47, eG722_ID = 48,   eReserved_Codec1_ID = 49, eReserved_Codec2_ID = 50, eReserved_Codec3_ID = 51, eAMR_IF1_ID = 52,   eAMR_IF2_ID = 53 }
enum	EVideoCodecIndex { eH263_ID = 0, eRFC2190_ID = 1, eH264_ID = 2, eMPEG4_ID = 3 }
enum	EMapperType { eChannelMap = 0, eTSMap = 1 }
enum	EMediaHostType { ePCI = 0, eCSMENCAPS = 1 }
enum	EAnnounceType { eHSF = 0, ePCM = 1, eRTP = 2, eBOTH = 3 }
enum	ESpeechDataFormat { eHedFormat = 0, eNoHedFormat = 1 }
enum	ECodingScheme {   eCS_G711_ULAW = 4, eCS_G711_ALAW = 5, eCS_G723_1 = 6, eCS_G729_A = 8,   eCS_G726_32 = 9, eCS_G726_16_audio = 15, eCS_G726_24_audio = 16, eCS_G726_40_audio = 17,   eCS_RawPcm = 127 }
enum	EStopAnnType { eDRAIN = 0, eAS_STOP = 1 }
enum	EPlaybackMode { ePlaybackStandard = 2, ePlaybackExt = 3, ePlaybackSpeedChangeable = 4 }
enum	EPlaybackRate {   ePlaybackRate_1_1 = 0x00, ePlaybackRate_2_1 = 0x01, ePlaybackRate_3_2 = 0x02, ePlaybackRate_4_3 = 0x03,   ePlaybackRate_5_4 = 0x04, ePlaybackRate_4_5 = 0x05, ePlaybackRate_3_4 = 0x06, ePlaybackRate_2_3 = 0x07,   ePlaybackRate_1_2 = 0x08 }
enum	_EResAction { eResourceDisable = 0, eResourceEnable = 1, eResourceQuery = 2 }
enum	EResourceIndex {   eResG711_20 = 0, eResG711_10 = 1, eResG711_5 = 2, eResG726_20 = 3,   eResG726_10 = 4, eResG726_5 = 5, eResG729a_20 = 6, eResG729a_10 = 7,   eResG723_1 = 8, eResG728 = 9, eResG729e = 10, eResG722 = 11,   eResG722_2_VAD_ON = 12, eResG722_2_VAD_OFF = 13, eResG729_1_8K = 14, eResG729_1_12K = 15,   eResG729_1_14K = 16, eResG729_1_16K = 17, eResG729_1_18K = 18, eResG729_1_24K = 19,   eResG729_1_28K = 20, eResiLBC = 21, eResGSM_FR = 22, eResGSM_HR = 23,   eResGSM_EFR = 24, eResGSM_AMR = 25, eResCDMA_EVRC = 26, eResCDMA_EVRC_B = 27,   eResCDMA_QCELP8 = 28, eResCDMA_QCELP13 = 29, eResT38 = 30, eResConferencing = 31 }
Functions
VSTATUS	VAPI_RegisterReset (IN DEVID DevId, IN PFNResetDevice pfnReset, void *pvData)
char *	VAPI_GetVersion (void)
VSTATUS	VAPI_Init (void *pstDeviceHeaders)
VSTATUS	VAPI_Close (void)
VSTATUS	VAPI_RegisterEventCallback (IN U32 uiID, IN U8 ucLevel, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_OpenDevice (IN DEVID DevId, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_CloseDevice (IN DEVID DevId, IN ECloseMode eMode)
VSTATUS	VAPI_BootDevice (IN DEVID DevId, IN void *pvImageFile, IN U32 uImageSize, IN SHwCfg *pstSHwCfg, IN SRequest *pstRequest)
VSTATUS	VAPI_BootDeviceFile (IN DEVID DevId, IN char *strFileName, IN SHwCfg *pstSHwCfg, IN SRequest *pstRequest)
VSTATUS	VAPI_InitDevice (IN DEVID DevId, IN U32 ulOperationModeId, IN U32 ulProfileId, IN U32 *pulUserParams, IN SRequest *pstRequest)
VSTATUS	VAPI_GetCoreDump (IN DEVID DevId, IN U8 uchMemTypeIdx, OUT U8 *puchBuff, IN U32 ulBuffSize, OUT U32 *pulDataSize, IN U32 ulOffset, OUT Boolean *pbLastRead, IN SHwCfg *pstSHwCfg, IN SRequest *pstRequest)
VSTATUS	VAPI_PassThru (IN U32 uiID, IN U8 ucLevel, IN SMsg *pstMsg, IN SRequest *pstRequest, OUT U8 *pucBuffer, IN OUT U32 *puBufLen)
VSTATUS	VAPI_ModifyConnection (IN CONNID ConnId, IN U16 usModifyNum, IN SModifyConnectionInfo *pstModifyConnectionInfo, IN SRequest *pstRequest)
VSTATUS	VAPI_SendDeviceMessage (IN U32 uiID, IN SMsg *pstMsg, IN SRequest *pstRequest, OUT U8 *pucBuffer, IN OUT U32 *puBufLen)
VSTATUS	VAPI_SendConnectionMessage (IN U32 uiID, IN SMsg *pstMsg, IN SRequest *pstRequest, OUT U8 *pucBuffer, IN OUT U32 *puBufLen)
VSTATUS	VAPI_SendConferenceMessage (IN U32 uiID, IN SMsg *pstMsg, IN SRequest *pstRequest, OUT U8 *pucBuffer, IN OUT U32 *puBufLen)
VSTATUS	VAPI_CreateConnection (IN DEVID DevId, IN CONNID ConnId, IN EConnType usConnType, IN U16 usTdmTimeSlot, IN U8 ucAU_Law, IN SRequest *pstRequest, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_AllocateConnection (IN DEVID DevId, IN CONNID ConnId, IN EConnType eConnType, IN EConnMode eConnMode, IN U8 ucNumOfParams, IN U16 *pusParams, IN SRequest *pstRequest, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_DestroyConnection (IN CONNID ConnId, IN SRequest *pstRequest)
VSTATUS	VAPI_SetConnectionState (IN CONNID ConnId, IN EConnOpMode eOpMode, IN SRequest *pstRequest)
VSTATUS	VAPI_Loopback (IN CONNID Conn1, IN CONNID Conn2, IN ELoopbackType eLoopback, IN SRequest *pstRequest)
VSTATUS	VAPI_SetEthMac (IN U32 uiID, IN U8 ucLevel, IN U8 *paucSrcMacAddr, IN U8 *paucDestMacAddr, IN SRequest *pstRequest)
VSTATUS	VAPI_SetDeviceVlan (IN DEVID DevId, IN U16 VlanId, IN SRequest *pstRequest)
VSTATUS	VAPI_SetDeviceIPAddr (IN DEVID DevId, IN SIpAddrInfo *pstIpAddrInfo, IN SRequest *pstRequest)
VSTATUS	VAPI_SetCodecType (IN CONNID ConnId, IN ECodecIndex eCodecIndex, IN SRequest *pstRequest)
VSTATUS	VAPI_SetPacketInterval (IN CONNID ConnId, IN U8 uiMilliSec, IN SRequest *pstRequest)
VSTATUS	VAPI_SetPayloadType (IN CONNID ConnId, IN ECodecType eCodec, IN U8 ucPlTypVal, IN EDirection eDir, IN SRequest *pstRequest)
VSTATUS	VAPI_SetRtpSsrcHeader (IN CONNID ConnId, IN U32 uiSsrcVal, IN SRequest *pstRequest)
VSTATUS	VAPI_EchoCancellerReset (IN CONNID ConnId, IN SRequest *pstRequest)
VSTATUS	VAPI_SendNteEvent (IN CONNID ConnId, IN U32 uiNtePyLd, IN U16 usOverRideBitField, IN U16 usRedundancyInterval, IN U32 uiSsrc, IN U16 usPyLdType, IN SRequest *pstRequest)
VSTATUS	VAPI_StartTone (IN CONNID ConnId, U8 ucDir, EToneId eToneId, ECountryCode eCountryCode, IN SRequest *pstRequest)
VSTATUS	VAPI_PlayTone (IN CONNID ConnId, EToneId eToneId, EToneDir eToneDir, SPlayToneOpt *pstPlayToneOpt, U16 usParamNum, IN SRequest *pstRequest,...)
VSTATUS	VAPI_SetTone (EToneId eToneId, EToneType eToneType, U16 usCadenceRpt, U16 usParamNum,...)
VSTATUS	VAPI_StopTone (IN CONNID ConnId, IN U16 usToneDuration, IN U16 usSide, IN SRequest *pstRequest)
VSTATUS	VAPI_SetCidGenInfo (EAction eAction, ECidGenInfoType eCidGenInfoType, U16 usParamNum,...)
VSTATUS	VAPI_StartCallerId (IN CONNID ConnId, IN CidInfo *pstCidInfo, IN SRequest *pstRequest)
VSTATUS	VAPI_PlayCid (IN CONNID ConnId, IN SCallerIdInfo *pstCidInfo, IN SRequest *pstRequest)
VSTATUS	VAPI_StopCallerId (IN CONNID ConnId, IN SRequest *pstRequest)
VSTATUS	VAPI_SetCidDetInfo (EAction eAction, ECidDetInfoType eCidDetInfoType, U16 usParamNum,...)
VSTATUS	VAPI_CreateConference (IN DEVID DevId, IN CONFID ConfId, IN SConfParams *pstConfParams, IN Boolean bIsEnhancedConf, IN SConfDTSParams *pstConfDTSParams, IN SRequest *pstRequest)
VSTATUS	VAPI_DestroyConference (IN CONFID ConfId, IN SRequest *pstRequest)
VSTATUS	VAPI_CreateIpSideParticipant (IN CONFID ConfId, IN PARTID PartId, IN SRequest *pstRequest, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_CreateTranscodingParticipant (IN CONFID ConfId, IN PARTID PartId, IN SRequest *pstRequest, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_SetParticipantDgain (IN PARTID PartId, IN U16 usGain, IN SRequest *pstRequest)
VSTATUS	VAPI_SetParticipantOpt (IN PARTID PartId, IN U16 usRfc2833OnOff, IN SRequest *pstRequest)
VSTATUS	VAPI_SetConferenceDgain (IN DEVID DevId, IN U16 usGain, IN SRequest *pstRequest)
VSTATUS	VAPI_SetConferenceLatency (IN DEVID DevId, IN U16 usLatency, IN SRequest *pstRequest)
VSTATUS	VAPI_CreateTdmSideParticipant (IN CONFID ConfId, IN PARTID PartId, IN U16 usTdmTimeSlot, IN U8 ucAU_Law, IN SRequest *pstRequest, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_AllocateParticipant (IN CONFID ConfId, IN PARTID PartId, IN EPartType ePartType, IN U8 ucNumOfParams, IN U16 *pusParams, IN SRequest *pstRequest, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_DestroyParticipant (IN PARTID PartId, IN SRequest *pstRequest)
VSTATUS	VAPI_EnableParticipant (IN PARTID PartId, IN SRequest *pstRequest)
VSTATUS	VAPI_DisableParticipant (IN PARTID PartId, IN SRequest *pstRequest)
VSTATUS	VAPI_EnableCIDDetection (IN CONNID ConnId, IN ECountryCode eCountryCode, IN U8 ucEnableType, IN SRequest *pstRequest)
VSTATUS	VAPI_SetCidDetection (IN CONNID ConnId, IN SCidDetCtrl *pstCidDetCtrl, IN SRequest *pstRequest)
VSTATUS	VAPI_StartRecord (IN CONNID ConnId, IN SRecData *pstRecData, IN SRequest *pstRequest)
VSTATUS	VAPI_StopRecord (IN CONNID ConnId, IN EStopAnnType eStopAnnType, IN SRequest *pstRequest)
VSTATUS	VAPI_StartPlayback (IN CONNID ConnId, IN SPlayData *pstPlayData, IN SRequest *pstRequest)
VSTATUS	VAPI_StopPlayback (IN CONNID ConnId, IN EStopAnnType eStopAnnType, IN SRequest *pstRequest)
VSTATUS	VAPI_StartRecordFile (IN CONNID ConnId, IN SRecData *pstRecData, IN SRequest *pstRequest)
VSTATUS	VAPI_StartPlaybackFile (IN CONNID ConnId, IN SPlayData *pstPlayData, IN SRequest *pstRequest)
VSTATUS	VAPI_StartRecording (IN CONNID ConnId, IN EMediaHostType eMediaHost, IN ECodingScheme eCodingScheme, IN EAnnounceType eSourceType, IN U32 uiTimeOut, IN U8 *pucBuffer, IN U32 uiBufferLength, IN PFNIoCompCallback pfnFrameHndlr, IN SRequest *pstRequest)
VSTATUS	VAPI_StopRecording (IN CONNID ConnId, IN SRequest *pstRequest)
VSTATUS	VAPI_StartPlaying (IN CONNID ConnId, IN EMediaHostType eMediaHost, IN ECodingScheme eCodingScheme, IN EAnnounceType eDestinationType, IN U32 uiTimeOut, IN U8 *pucBuffer, IN U32 uiBufferLength, IN SRequest *pstRequest)
VSTATUS	VAPI_StopPlaying (IN CONNID ConnId, IN SRequest *pstRequest)
VSTATUS	VAPI_PlaybackSetRate (IN CONNID ConnId, EPlaybackRate ePlaybackRate, IN SRequest *pstRequest)
VSTATUS	VAPI_ConvertHostSpeechData (IN CONNID ConnId, IN SConvertData *pstConvertData, IN SRequest *pstRequest)
VSTATUS	VAPI_SwitchToT38 (IN CONNID ConnId, IN SFaxConfigOpts *pstFaxConfigOpts, IN SRequest *pstRequest)
VSTATUS	VAPI_AssignBootMAC (IN DEVID DevId, IN SRequest *pstRequest)
VSTATUS	VAPI_SetConnIpParams (IN CONNID ConnId, IN SIpParams *pstIpParams, IN SRequest *pstRequest)
VSTATUS	VAPI_SetMediaSubLayer (IN CONNID ConId, IN EMediaSubLayer eMediaSubLayer, IN SRequest *pstRequest)
VSTATUS	VAPI_SendH245Message (IN CONNID ConnId, IN U16 uiH245MsgLength, IN U8 *ptrH245Msg, IN SRequest *pstRequest)
STATUS	VAPI_TranscodingSession (IN CONNID ConnId1, IN CONNID ConnId2, IN STranscodingOption *pstTranscodingOption, IN SRequest *pstRequest)
VSTATUS	VAPI_RecoverConnection (IN DEVID DevId, IN CONNID ConnId, IN EConnType eConnType, IN U16 usTdmTimeSlot, IN U16 usRecoverOption, IN SRequest *pstRequest, IN PFNEventCallback pfnEventCallback)
VSTATUS	VAPI_CESoPSN_Mapper (IN DEVID DevId, IN SRequest *pstRequest, IN EMapperType eMapType, IN CONNID MasterConnId, U16 Action, U16 usConnNum,...)
VSTATUS	VAPI_ChangeConnectionType (IN CONNID ConnId, IN SChangeConnInfo *pstChangeConnInfo, IN U16 NumParam, IN U16 *pusParams, IN SRequest *pstRequest)
VSTATUS	VAPI_C2CConnectUP (IN DEVID DevId, IN SC2CConnectOption *pstC2CConnectOptions, IN SRequest *pstRequest)
void *	VAPI_AllocateMessage (U16 usSize)
void	VAPI_InitMessage (void *pvMsg)
VSTATUS	VAPI_FreeMessage (void *pvMsg)
VSTATUS	VAPI_SetMessage (OUT void *pvMsg, IN U8 ucCmdClass, IN U8 ucCmdType, IN U16 usFcode, IN U16 ucNumParams,...)
VSTATUS	VAPI_SetMessageFromBuffer (OUT void *pvMsg, IN U8 ucCmdClass, IN U8 ucCmdType, IN U16 usFcode, IN U16 ucNumParams, IN U16 *pusParameters)
VSTATUS	VAPI_SetConnectionResource (IN DEVID DevId, IN CONNID ConnId, IN U8 ucResourceNum, IN U8 *pucRequiredResource)
VSTATUS	VAPI_SetResourceManager (IN DEVID DevId, IN EResAction eResAction, OUT U16 *pusQueryInfo)

---

Detailed Description

---

Define Documentation

#define A_LAW   0

PCM Coding Standard A-Law

#define ALL_INFO   6

Debug level: ALL Information level

#define ALWYS   5

Special severity level

#define API_LEVEL   1

Debug level: API level

#define API_PACKET_LEVEL   2

Debug level: Packect level

#define CMD_LEVEL_CONF   2

Command Level conference

#define CMD_LEVEL_CONN   0

Command Level connection

#define CMD_LEVEL_DEVICE   1

Command Level device

#define DEBUG   2

Severity level DEBUG to be passed to VAPI_SetDebugLevel()

#define DEFAULT_FIFO_MAX_SIZE   256

Max fifo len for control message (API commands)

#define EVENT_LEVEL_CONN   0

Event callback connection level

#define EVENT_LEVEL_DEVICE   1

Event callback device level

#define EVENT_LEVEL_GENERIC   2

Event callback generic level

#define FAILURE   -1

Indicate failure of an operation

#define FIFO_MIN_SIZE   8

Min fifo len for control message (API commands)

#define IN

Specifying input parameters in function prototypes

#define INFO   1

Severity level INFO to be passed to VAPI_SetDebugLevel()

#define MAX_SYNCDAT_BUF_SIZE   240

Max available buffer size of SYNCDAT/SYNCEOF packets

#define NO_DEBUG   0

Debug level: No debug

#define OUT

Specifying output parameters in function prototypes

#define PACKET   3

Severity level PACKET to be passed to VAPI_SetDebugLevel()

#define PADDING_SIZE   6

Number of bytes for padding commands

#define SUCCESS   0

Indicate success of an operation

#define U_LAW   1

PCM Coding Standard U-Law

#define VAPI_API_VERSION	(	a,
		b		)	(((a) << 8) + (b))

The VAPI_API_VERSION defines the vapi API user interface release
A same API release can be share by several VAPI release

#define VAPI_DisableConnection	(	x,
		y		)	VAPI_SetConnectionState(x, eTdmActive, y)

Disable voice on a specified connection
This maintains backward compatibility with previous version of VAPI

#define VAPI_EchoCancellorReset	(	x,
		y		)	VAPI_EchoCancellerReset(x, y)

Reset the Echo Canceller on a specified connection
This maintains backward compatibility with previous version of VAPI

#define VAPI_EnableConnection	(	x,
		y		)	VAPI_SetConnectionState(x, eActive, y)

Enable voice on the specified connection
This maintains backward compatibility with previous version of VAPI

#define VAPI_ERR_ALT_HDR_NOT_SET   -(VAPI_ERROR_BASE + 49)

The conenction has no alternate header set

#define VAPI_ERR_CREATECONF_FAIL   -(VAPI_ERROR_BASE + 55)

Create conference failed: the conference is not created at all

#define VAPI_ERR_CREATECONN_FAIL   -(VAPI_ERROR_BASE + 54)

Create connection failed: the connection or the participant is not created at all

#define VAPI_ERR_DEV_IS_NOT_UP   -(VAPI_ERROR_BASE + 17)

Device is not up so no requests can be accepted

#define VAPI_ERR_DEV_IS_UP   -(VAPI_ERROR_BASE + 16)

Returned by VAPI_BootDevice when device is already up

#define VAPI_ERR_DEVICE_EXISTS   -(VAPI_ERROR_BASE + 8)

The device that is being added/opened is already added/opened

#define VAPI_ERR_DEVICE_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 48)

The device has not been initialized with VAPI_InitDevice()

#define VAPI_ERR_DEVIP_NOTSET   -(VAPI_ERROR_BASE + 18)

Device IP address is not set

#define VAPI_ERR_FIFO_SIZE   -(VAPI_ERROR_BASE + 45)

fifo has a wrong size

#define VAPI_ERR_ILLEGAL_COMMAND   -(VAPI_ERROR_BASE + 59)

Wrong combination of Command Type/Class

#define VAPI_ERR_INCOMP_DEST_IPUDP   -(VAPI_ERROR_BASE + 20)

Missing destination UDP port

#define VAPI_ERR_INCOMP_SRC_UDP   -(VAPI_ERROR_BASE + 19)

Missing source UDP port

#define VAPI_ERR_INVALID_CONF_ID   -(VAPI_ERROR_BASE + 28)

Invalid conference ID

#define VAPI_ERR_INVALID_CONFID   -(VAPI_ERROR_BASE + 23)

The specified conference does not exist

#define VAPI_ERR_INVALID_CONN_TYPE   -(VAPI_ERROR_BASE + 37)

Connection in wrong type for current process

#define VAPI_ERR_INVALID_CONNID   -(VAPI_ERROR_BASE + 2)

The specified connection does not exist

#define VAPI_ERR_INVALID_DEV_STATE   -(VAPI_ERROR_BASE + 24)

Device is wrong state for current operation

#define VAPI_ERR_INVALID_DEV_TYPE   -(VAPI_ERROR_BASE + 56)

The specified device type is not supported

#define VAPI_ERR_INVALID_DEVID   -(VAPI_ERROR_BASE + 1)

The specified device ID does not exist

#define VAPI_ERR_INVALID_IMAGE   -(VAPI_ERROR_BASE + 10)

There is something wrong with the image that is being downloaded

#define VAPI_ERR_INVALID_MEM_IDX   -(VAPI_ERROR_BASE + 25)

Core Dump API - requested memory does not exist

#define VAPI_ERR_INVALID_OFFSET   -(VAPI_ERROR_BASE + 26)

Core Dump API - Invalid offset in memory

#define VAPI_ERR_INVALID_OPERATION   -(VAPI_ERROR_BASE + 14)

The operation is invalid with current settings

#define VAPI_ERR_INVALID_PARAM   -(VAPI_ERROR_BASE + 4)

Invalid parameter value was passed

#define VAPI_ERR_INVALID_RESOURCE   -(VAPI_ERROR_BASE + 64)

Allocated resource invalid

#define VAPI_ERR_IP_HDR_NOT_SET   -(VAPI_ERROR_BASE + 22)

Connection IP header not set

#define VAPI_ERR_LIB_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 15)

The Library is not yet initialized

#define VAPI_ERR_MAAS_ASSIGN   -(VAPI_ERROR_BASE + 34)

Error returned for BootDevice API

#define VAPI_ERR_MSP_NO_RESPONSE   -(VAPI_ERROR_BASE + 6)

No response was obtained from MSP (Timeout occured)

#define VAPI_ERR_MULTI_CMD_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 47)

The device has not been set for multi command mode

#define VAPI_ERR_NO_RESOURCE   -(VAPI_ERROR_BASE + 62)

No resource available

#define VAPI_ERR_NO_RESOURCE_ALLOC   -(VAPI_ERROR_BASE + 63)

No resource allocated

#define VAPI_ERR_NOMEM   -(VAPI_ERROR_BASE + 3)

Operation failed due to insufficient memory

#define VAPI_ERR_NULL_POINTER_PASSED   -(VAPI_ERROR_BASE + 5)

NULL pointer was passed for a variable expected to be not NULL.

#define VAPI_ERR_PENDING   -(VAPI_ERROR_BASE + 12)

Command execution is pending within vapi

#define VAPI_ERR_PROG_START   -(VAPI_ERROR_BASE + 35)

Error during Comcerto firmware start

#define VAPI_ERR_PT_NOT_INITIALIZED   -(VAPI_ERROR_BASE + 46)

The payload type for the connection is not initialized

#define VAPI_ERR_RECOVER_INVALID   -(VAPI_ERROR_BASE + 53)

Recover connection failed: Recovered Comcerto channel already in use by another connection

#define VAPI_ERR_RECOVER_TIMESLOT   -(VAPI_ERROR_BASE + 51)

Recover connection failed: no Comcerto channel found with required timeslot

#define VAPI_ERR_RECOVER_WRONG_TYPE   -(VAPI_ERROR_BASE + 52)

Recover connection failed: Recovered Comcerto channel type doesn't match required connection type

#define VAPI_ERR_RES_MGR_NOT_ENABLED   -(VAPI_ERROR_BASE + 61)

Resource manager not enabled

#define VAPI_ERR_RES_MGR_NOT_SUPPORTED   -(VAPI_ERROR_BASE + 66)

Resource manager not supported for this device

#define VAPI_ERR_RSRC_INIT_FAILED   -(VAPI_ERROR_BASE + 9)

Some internal resource initialization failed

#define VAPI_ERR_SPU_FEATURE_NOT_ENABLED   -(VAPI_ERROR_BASE + 29)

SPU control feature not enabled

#define VAPI_ERR_SUPVSR_READY   -(VAPI_ERROR_BASE + 36)

Supervisor Ready returned an error

#define VAPI_ERR_TIMEOUT   -(VAPI_ERROR_BASE + 44)

Timeout on process request

#define VAPI_ERR_TS_IN_USE   -(VAPI_ERROR_BASE + 58)

Timeslot is already used by another channel

#define VAPI_ERR_UNDEFINED   -(VAPI_ERROR_BASE + 11)

Undefined internal error

#define VAPI_ERR_UNDEFINED_EVENT   -(VAPI_ERROR_BASE + 50)

Get into a FSM handler with an unhandled event value

#define VAPI_ERR_UNEXPECTED_MSP_RESPONSE   -(VAPI_ERROR_BASE + 13)

Unexpected response packet obtained from MSP

#define VAPI_ERR_UNKNOWN_RESOURCE   -(VAPI_ERROR_BASE + 65)

Allocated resource unknow configuration: the configuation is not supported by the resource manager

#define VAPI_ERR_UNSUPP_FEATURE   -(VAPI_ERROR_BASE + 7)

This feature is not suported

#define VAPI_ERR_WAIT_READY   -(VAPI_ERROR_BASE + 57)

Specific to M823XX waiting for ready command from MSP

#define VAPI_ERROR_BASE   68000

Error base defined for VAPI defined error codes

#define VAPI_GTL_INFO   4

Debug level: GTL Information level

#define VAPI_HWCFG_SDRAM_TIMING_MASK   0x01

Bits specifying which parameters are set in SHwCfg structure passed to public VAPI functions

#define VAPI_INFO   3

Debug level: VAPI Information level

#define VAPI_NUM_RESOURCES   eResConferencing + 1

Size of the buffer intended to hold the resources information

#define VAPI_PCI_DUMP_MAX_BLK   256

Maximum memory block to be read at a time during Core Dump Currently the maximum values supported are:

• 224 for CSME Slave and
• 256 for PCI Slave

#define VAPI_UT   5

Debug level: UT Information level

#define VAPI_VERSION	(	a,
		b,
		c		)	(((a) << 16) + ((b) << 8) + (c))

The VAPI_VERSION defines the vapi implementation release

#define WARN   4

Severity level WARN to be passed to VAPI_SetDebugLevel()

---

Typedef Documentation

typedef struct _CidInfo CidInfo

Caller Id structure

typedef U32 CONFID

Conference ID: used to identify a conference uniquely across all devices.
Conference IDs may overlap with the values used for Connection IDs (participant IDs may not overlap with Connection IDs).

typedef U32 CONNID

Connection ID: used to identify a connection uniquely across all devices.
A Connection ID used for creating a connection on one device cannot be used for creating a connection on another device

typedef U32 DEVID

Device Id: used to identify a device uniquely.
The valid value of the Device Id is determined by the device list present in the VAPI source code in gtl_config.c

typedef enum _EResAction EResAction

Resource manager setting action

typedef U32 PARTID

Participant ID: used to identify a participant uniquely across all devices.
Participant ID may be used in the same way as the Connection ID for all API functions.

typedef void(* PFNEventCallback)(EEventCode eEventCode, void *pvData)

A pointer to function used to register an event callback.
This function is called when an event is received from a device.
Description of EEventCode is given below.
The pvData term is a void pointer whose type depends on the value of eEventCode.
Event data structures are described as follows.

typedef void(* PFNIoCompCallback)(U32 uiId, U8 ucCmdLevel,S32 iStatus,void *pvReturnData,U32 uiReturnDataLen,U32 uiReqId)

Callback registered by user for informing a request completion A pointer to a function used to register request completion callbacks.
This function is called when a particular request gets completed.
The uiId term contains the Connection or Device Id depending on the request. The uiReqId term is the ID of the completed request specified with the SRequest parameter while issuing a VAPI call.

typedef VSTATUS(* PFNResetDevice)(void *pvData)

A pointer to a function used to register customer specific reset device function.
This function is called (if not NULL) by VAPI when a device reset is required for some particular operation (basically bootload or coredump).
.

typedef signed short S16

signed short

typedef signed int S32

signed int

typedef signed char S8

signed char

typedef struct _SAlrtIndParams SAlrtIndParams

ALERT Indication Structure

typedef struct _SC2CConnectOption SC2CConnectOption

C2C options Structure

typedef struct _SCallerIdCmpltEventParams SCallerIdCmpltEventParams

Caller ID Complete Event Parameters

typedef struct _SCallerIdInfo SCallerIdInfo

Caller Id structure vor VAPI_PlayCid()

typedef struct _SChangeConnInfo SChangeConnInfo

Change connection struct

typedef struct _SCidDetCtrl SCidDetCtrl

CID detection control

typedef struct _SCIDReceivedMSG SCIDReceivedMSG

Caller Id Detection Event

typedef struct _SConfDTSParams SConfDTSParams

Enhanced conferencing dominant talkers parameters structure

typedef struct _SConfParams SConfParams

Enhanced conferencing feature flags structure

typedef struct _SConvertData SConvertData

SConvertData data structure

typedef struct _SDecoderEventParams SDecoderEventParams

Decoder Event Parameters

typedef struct _SEventDetParams SEventDetParams

EVENT structures

typedef struct _SFaxConfigOpts SFaxConfigOpts

FAX configuration information structure

typedef struct _SFaxOpts SFaxOpts

FAX options information structure

typedef struct _SFaxSwEventParams SFaxSwEventParams

Fax Switch Event parameters

typedef struct _SG711ConcurntDecoderEventParams SG711ConcurntDecoderEventParams

G711 Concurrent Decode Event parameters

typedef struct _SH245IndParams SH245IndParams

H.245 Indication Structure

typedef struct _SHwCfg SHwCfg

User data structure for containing Device HW params, please check the M82xxx-SWG-004 documentation for details regarding various SDRAM and CS parameters

typedef struct _SIpAddrInfo SIpAddrInfo

IP address information structure

typedef struct _SIpParams SIpParams

IP parameters Structure

typedef struct _SIPToneDetectEventParams SIPToneDetectEventParams

IP Tone Detection Event Parameters

typedef struct _SMailbox SMailbox

Mailbox registers

typedef struct _SModifyConnectionInfo SModifyConnectionInfo

Modify connection struct

typedef struct _SMsg SMsg

Raw message structure used in Pass-thru API

typedef struct _SNteRecvdEventParams SNteRecvdEventParams

NTE Received Event Parameters

typedef struct _SPassthruConcurntDecoderEventParams SPassthruConcurntDecoderEventParams

Passthrough Concurrent Decoder Event Parameters

typedef struct _SPlayData SPlayData

Play-related data

typedef struct _SPlayToneOpt SPlayToneOpt

Play tone conrol options

typedef struct _SPtChangeEventParams SPtChangeEventParams

PayLoad Type Change event Parameters

typedef struct _SRecData SRecData

Rec-related data

typedef struct _SRemoteDetectEventParams SRemoteDetectEventParams

Tone Detect Event Parameters

typedef struct _SRequest SRequest

A data-structure used in API calls to control the Sync/Async nature of the Call.
If the pfnIoCompCallback member is NULL then it will be a synchronous call, otherwise it is an asynchronous call.

typedef struct _SSpiEventParams SSpiEventParams

SPI Event parameters

typedef struct _SSsrcChangeEventParams SSsrcChangeEventParams

SSRC change Event Parameters

typedef struct _SSsrcViolationEventParams SSsrcViolationEventParams

SSRC Voilation Event Parameters

typedef struct _SSYNCDATParams SSYNCDATParams

SYNCDAT Indication Structure

typedef struct _SSYNCEOFParams SSYNCEOFParams

SYNCEOF Indication Structure

typedef struct _STdmBusParams STdmBusParams

TDM bus parameters

typedef struct _STdmSetupParams STdmSetupParams

TDM buses information structure

typedef struct _SToneDetectEventParams SToneDetectEventParams

Tone Detection Event Parameters

typedef struct _SToneGenCmpltEventParams SToneGenCmpltEventParams

Tone Genration Complete Event Parameters

typedef struct _STranscodingOption STranscodingOption

Transcoding session options

typedef struct _SUndefinedEventParams SUndefinedEventParams

UNDEFINED Event Parameters structure

typedef unsigned short U16

unsigned short

typedef unsigned int U32

unsigned int

typedef unsigned char U8

unsigned char

typedef int VSTATUS

int

---

Enumeration Type Documentation

enum _EResAction

Resource manager setting action

Enumerator:

eResourceDisable	Disable resource manager
eResourceEnable	Enable resource manager
eResourceQuery	Query available resource

enum Boolean

Boolean

Enumerator:

False	0
True	1

enum EAction

CID info block action

Enumerator:

eRemove	0 Remove CID info block
eAdd	1 Add CID info block
eModify	2 Modify CID info block

enum EAnnounceType

Announcement type

Enumerator:

eHSF	Host Speech frame
ePCM	PCM
eRTP	RTP
eBOTH	Both directions

enum EChangeOpMode

Change operation mode of connection

Enumerator:

eOpModeNone	No extra configuration
eOpModeMac	Configure MAC address
eOpModeIP	Configure IP address

enum ECidDetInfoType

CID detection info block type

Enumerator:

eDataFormatType	0x01 Data format block type
eFSKDetectionType	0x02 FSK detection block type
eOnHookDetType	0x03 On hook detection block type
eOffHookDetType	0x04 Off hook detection block type
eAckGenType	0x05 Ack generation block type
eNTTDetType	0x06 NTT detection block type

enum ECidGenInfoType

CID generation info block type

Enumerator:

eOnHookXmitInfoType	0x01 On hook block type
eOffHookXmitInfoType	0x02 Off hook block type
eCPEAlertToneInfoType	0x03 CPE alert block type
eCPEAckInfoType	0x04 CPE ack block type
eSASToneInfoType	0x05 SAS tone block type
eNTTInfoType	0x06 NTT block type
eStopBitsInfoType	0x07 Stop bits block type
ePacketProcessingInfoType	0x08 Packet processing block type

enum ECloseMode

Shutdown modes used in VAPI_CloseDevice
Currently only ePURGE is supported.

Enumerator:

ePURGE	In ePURGE mode the VAPI frees memory allocated to all channels and frees memory allocated for all pending requests. That is, the application must destroy all created connections using the VAPI_DestroyConnection API.
ePURGE_ALL	The same as ePURGE but it frees all MSP resources as well: disable any created channel (including conference participants and transcoding legs), disable any transcoding session, destroy any created channel, destroy any created conference

enum ECodecIndex

Codec Index

Enumerator:

eG711_ULAW_ID	4: g711 uLaw
eG711_ALAW_ID	5: g711 ALaw
eG723_1_ID	6: g723
eG728_Audio_ID	7: g728 audio
eG729_A_ID	8: g729 A
eG726_32_ID	9: g726 32
eGSM_FR_Audio_ID	11: GSM FR
eClear_Channel_ID	12: Clear Channel
ePassthrough_ULAW_ID	13: PassThrough uLaw
ePassthrough_ALAW_ID	14: PassThrough uAaw
eG726_16_audio_ID	15: g726 16
eG726_24_audio_ID	16: g726 24
eG726_40_audio_ID	17: g726 40
eGSM_EFR_ID	18: GSM EFR
eAMR_ID	19: AMR
eEVRC_ID	20: EVRC
eSMV_ID	22: SMV
eQCELP_13K_ID	23: QCELP 13K
eQCELP_8K_ID	24: QCELP 8K
eCRBT_ADPCM_ID	25: CRBT ADPCM
eG729_EG_ID	26: g729 EG
eI_LBC_15K_ID	28: I-LBC 15K
eI_LBC_13K_ID	29: I-LBC 13K
GSM_AMR_BWE_ID	31: GSM_AMR_BWE
e4GV_ID	32: 4GV
eAMR_WB_ID	34: AMR_WB
eG729_MSPD_ID	35: G.729 MSPD
eCESoPSN_ID	36: CESoPSN
eGSM_HR_ID	37: eGSM_HR
eCSD_BS30T_64k_ID	38: CSD_BS30T_64k
eCSD_BS30T_32k_ID	39: CSD_BS30T_32k
eCSD_BS30T_33k6_ID	40: CSD_BS30T_33k6
eCSD_BS30T_28k8_ID	41: CSD_BS30T_28k8
eCSD_BS20NT_57k6_ID	42: CSD_BS20NT_57k6
eCSD_BS20NT_28k8_ID	43: CSD_BS20NT_28k8
eCSD_BS20NT_14k4_ID	44: CSD_BS20NT_14k4
eG729_1_ID	45: G.729.1
eAMR_WB_ba_ID	46: AMR WB(G.722.2)[byte aligned]
eCCISoIP_ID	47: CCISoIP
eG722_ID	48: G.722
eReserved_Codec1_ID	49: Reserved Codec 1
eReserved_Codec2_ID	50: Reserved Codec 2
eReserved_Codec3_ID	51: Reserved Codec 3
eAMR_IF1_ID	52: AMR IF1
eAMR_IF2_ID	53: AMR IF2

enum ECodecType

Codec Type

Enumerator:

eGeneric_Comfort_Noise	0: Comfort noise
eRedundant_Scheme_for_DTMF	1: DTMF redundant scheme
eDTMF_RTP	2: DTMF in RTP
eIFP	3: Internet Fax Protocol
eG711_ULAW_PCM	4: g711 uLaw
eG711_ALAW_PCM	5: g711 ALaw
eG723_1	6: g723
eG728_Audio	7: g728 audio
eG729_A	8: g729 A
eG726_32	9: g726 32
eReserved_Codec0	10: Reserved Codec 0
eGSM_FR_Audio	11: GSM FR
eClear_Channel	12: Clear Channel
ePassthrough_ULAW	13: PassThrough uLaw
ePassthrough_ALAW	14: PassThrough uAaw
eG726_16_audio	15: g726 16
eG726_24_audio	16: g726 24
eG726_40_audio	17: g726 40
eGSM_EFR	18: GSM EFR
eAMR	19: AMR
eEVRC	20: EVRC
eCNF_SEC	21: Secondary CNF
eSMV	22: SMV
eQCELP_13K	23: QCELP 13K
eQCELP_8K	24: QCELP 8K
eCRBT_ADPCM	25: CRBT ADPCM
eG729_EG	26: g729 EG
eFEC	27: Forward Error Correction
eI_LBC_15K	28: I-LBC 15K
eI_LBC_13K	29: I-LBC 13K
eRFC2833_EVENT	30: RFC2833 Event
eGSM_AMR_BWE	31: GSM_AMR_BWE
e4GV	32: 4GV
eRFC2833_TONE	33: RFC2833 Tone
eAMR_WB	34: AMR_WB
eG729_MSPD	35: G.729 MSPD
eCESoPSN	36: CESoPSN
eGSM_HR	37: eGSM_HR
eCSD_BS30T_64k	38: CSD_BS30T_64k
eCSD_BS30T_32k	39: CSD_BS30T_32k
eCSD_BS30T_33k6	40: CSD_BS30T_33k6
eCSD_BS30T_28k8	41: CSD_BS30T_28k8
eCSD_BS20NT_57k6	42: CSD_BS20NT_57k6
eCSD_BS20NT_28k8	43: CSD_BS20NT_28k8
eCSD_BS20NT_14k4	44: CSD_BS20NT_14k4
eG729_1	45: G.729.1
eAMR_WB_ba	46: AMR WB(G.722.2)[byte aligned]
eCCISoIP	47: CCISoIP
eG722	48: G.722:
eReserved_Codec1	49: Reserved Codec 1
eReserved_Codec2	50: Reserved Codec 2
eReserved_Codec3	51: Reserved Codec 3
eAMR_IF1	52: AMR IF1
eAMR_IF2	53: AMR IF2
eReserved_Codec4	54: Reserved Codec 4

enum ECodingScheme

Announcement Coding scheme

Enumerator:

eCS_G711_ULAW	4: g711 uLaw
eCS_G711_ALAW	5: g711 ALaw
eCS_G723_1	6: g723
eCS_G729_A	8: g729 A
eCS_G726_32	9: g726 32
eCS_G726_16_audio	15: g726 16
eCS_G726_24_audio	16: g726 24
eCS_G726_40_audio	17: g726 40
eCS_RawPcm	127: 16 bit signed raw PCM audio

enum EConnMode

Channel mode

Enumerator:

eNarrowBand	Narrow band mode
eWideBand	Wide Band mode

enum EConnOpMode

Operation mode of connection

Enumerator:

eInactive	TDM detection Inactive, packetization inactive
eTdmActive	TDM detection active, packetization inactive.
eActive	TDM detection active, packetization active

enum EConnType

Type of connection

Enumerator:

eVOIP	Voice over IP = 0x02
eFOIP	Fax over IP = 0x07
eVOATM	Voice over ATM = 0x08 (using AAL2 or CDMAoAAL5)
eIUUPORTP	IuUP or NbUP over RTP/UDP/IP
eIUUPOAAL2	IuUP over AAL2 = 0x0A
eSLIC24	Reserved (SLIC24)
eComplexTone	Complex Tone Generation (TONEGEN)
eToneDet	Tone Detection (TONEDET)
eWARNING_TONEGEN	Reserved (warning tone)
eIpRedirect	IPREDIRECT
eHDL	Host Data Link (PCI/uP over IPoAAL5)
eHDLCOTDM	HDLC over TDM
eDSPDIAG	Reserved (DSPDIAG)
eAAL1CES	Reserved (AAL1CES)
eIMSOTDM	IMS over TDM
eCCS	Common Channel Signaling
eCSEoPSN	Customer Edge Signaling over Packet Switched Network

enum ECountryCode

Country Code

Enumerator:

eUSA	USA
eINDIA	INDIA

enum EDirection

Payload type direction (asymmetrical option)

Enumerator:

eTx	Transmit direction
eRx	Receive direction
eBoth	Both direction

enum EEventCode

Event codes defined for events coming from MSP

Enumerator:

eVAPI_SPI_EVENT	Event SPI like On-hook/Off-Hook
eVAPI_TONE_DETECT_EVENT	Event for tone detection (like for DTMF)
eVAPI_TONE_GEN_CMPLT_EVENT	Event Tone Generation completed
eVAPI_PT_CHANGE_EVENT	Event Payload type change
eVAPI_SSRC_CHANGE_EVENT	Event SSRC Change received
eVAPI_SSRC_VIOLATION_EVENT	Event SSRC Violation received
eVAPI_NTE_TRANSMIT_COMPLETE_EVENT	Event NTE transmit completed
eVAPI_NTE_RECVD_EVENT	Event NTE received
eVAPI_CALLER_ID_CMPLT_EVENT	Event caller ID completed
eVAPI_G711_CONCURRENT_DECODER_EVENT	Event G711 concurrent decoder
eVAPI_PASSTHRU_CONCURRENT_DECODER_EVENT	Event Passthru concurrent decoder
eVAPI_DECODER_EVENT	Event Decoder
eVAPI_CALLER_ID_DETECTED_EVENT	Event Caller ID detection
eVAPI_REMOTE_DETECT_EVENT	Event for remote detection
eVAPI_FAX_SWITCH_CMPLT_EVENT	Event VAPI has completed Fax switchover
eVAPI_ALERT_IND	Event ALERT Indication
eVAPI_IMSOTDM_H245_EVENT	IMS over TDM H.245 Indication
eVAPI_SYNCDAT_EVENT	Event SYNCDAT indication
eVAPI_SYNCEOF_EVENT	Event SYNCEOF indication
eVAPI_IPTONE_DETECT_EVENT	Event IP side tone detection
eVAPI_UNDEFINED_EVENT	Event is not suported by VAPI

enum EFaxSwitchEvents

Switchover events

Enumerator:

eLOCAL_CNG	Local Calling tone
eREM_CNG	Remote Calling tone
eLOCAL_ANS	Local Answer tone
eREM_ANS	Remote Answer tone
eLOCAL_V21	Local V21 flags
eREM_UDPTL	Remote UDPTL

enum EHoldState

Participant State

Enumerator:

eUNHOLD	UNHOLD
eSIMPLEHOLD	SIMPLE_HOLD
eANNHOLD	ANNOUNCEMENT_HOLD

enum ELoopbackType

Type of Loopback on channels

Enumerator:

eTDM	TDM loopback (no processing)
ePRE_ENCAPS	Pre encapsulation loopback
ePOST_ENCAPS	Post encapsulation loopback
eRTP_DEC	RTP Decoder loopback
eINTER_CHNL_POST_ENCAPS	Inter channel post encapsulation loopback
eINTER_CHNL_TDM	Mindspeed Reserved
eTHC	TDM Hairpin loopback
eREMOVE_CHNL_LOOPBACK	Stop Loopback on single channel
eREMOVE_INTER_CHNL_POSTENCAPS_LOOPBACK	Stop inter channel post encapsulation loopback
eREMOVE_INTER_CHNL_TDM_LOOPBACK	Stop inter channel TDM loopback
eREMOVE_THC_LOOPBACK	Stop hairpin loopback

enum EMapperType

CESOPSN mapping type

Enumerator:

eChannelMap	Channels are mapped (usage of CESoPSN_MAP_CHANNEL command)
eTSMap	Timeslots are mapped (usage of CESoPSN_SPEC_MAP_CHANNEL command)

enum EMediaHostType

Announcement Media Host Type

Enumerator:

ePCI	Over PCI
eCSMENCAPS	Over CSM_ENCAPS

enum EMediaSubLayer

Channel media sub-layer

Enumerator:

eAudioSubLayer	Address to audio sub-layer
eVideoSubLayer	Address to video sub-layer

enum EPartType

Participant Type

enum EPlaybackMode

Playback mode

Enumerator:

ePlaybackStandard	standard playback mode
ePlaybackExt	extended playback mode
ePlaybackSpeedChangeable	speed changeable playback mode

enum EPlaybackRate

PlaybackRate

Enumerator:

ePlaybackRate_1_1	normal
ePlaybackRate_2_1	fast 2:1
ePlaybackRate_3_2	fast 3:2
ePlaybackRate_4_3	fast 4:3
ePlaybackRate_5_4	fast 5:4
ePlaybackRate_4_5	slow 4:5
ePlaybackRate_3_4	slow 3:4
ePlaybackRate_2_3	slow 2:3
ePlaybackRate_1_2	slow 1:2

enum EResourceIndex

Resource manager index

Enumerator:

eResG711_20	0: g711 u/aLaw 20ms
eResG711_10	1: g711 u/aLaw 10ms
eResG711_5	2: g711 u/aLaw 5ms
eResG726_20	3: g726 20ms
eResG726_10	4: g726 10ms
eResG726_5	5: g726 5ms
eResG729a_20	6: g729a 20ms
eResG729a_10	7: g729a 10ms
eResG723_1	8: g723
eResG728	9: g728a
eResG729e	10: g729e
eResG722	11: g722
eResG722_2_VAD_ON	12: g722.2 VAD On
eResG722_2_VAD_OFF	13: g722.2 VAD Off
eResG729_1_8K	14: g729.1 8k
eResG729_1_12K	15: g729.1 12k
eResG729_1_14K	16: g729.1 14k
eResG729_1_16K	17: g729.1 16k
eResG729_1_18K	18: g729.1 18k
eResG729_1_24K	19: g729.1 24k
eResG729_1_28K	20: g729.1 28k
eResiLBC	21: iLBC
eResGSM_FR	22: GSM FR
eResGSM_HR	23: GSM HR
eResGSM_EFR	24: GSM EFR
eResGSM_AMR	25: ARM
eResCDMA_EVRC	26: CDMA EVRC
eResCDMA_EVRC_B	27: CDMA EVRC B
eResCDMA_QCELP8	28: CDMA QCELP 8
eResCDMA_QCELP13	29: CDMA QCELP 13
eResT38	30: T.38
eResConferencing	31: Conferencing

enum ESpeechDataFormat

Speech data format

Enumerator:

eHedFormat	speech data with frame headers
eNoHedFormat	speech data without frame headers

enum EStopAnnType

Stop announcement type

Enumerator:

eDRAIN	proceed accumulated data, stop
eAS_STOP	clean accumulated data, immediate stop

enum EToneDir

Tonde direction

enum EToneId

Tone Generation Identifier
See astDtmfToneGenParams_g structure for DTMF tones
See astCountryInfoList_g for other tones

Enumerator:

eDTMFTONE_1	DTMF 1
eDTMFTONE_2	DTMF 2
eDTMFTONE_3	DTMF 3
eDTMFTONE_4	DTMF 4
eDTMFTONE_5	DTMF 5
eDTMFTONE_6	DTMF 6
eDTMFTONE_7	DTMF 7
eDTMFTONE_8	DTMF 8
eDTMFTONE_9	DTMF 9
eDTMFTONE_A	DTMF A
eDTMFTONE_B	DTMF B
eDTMFTONE_C	DTMF C
eDTMFTONE_D	DTMF D
eDTMFTONE_STAR	DTMF *
eDTMFTONE_0	DTMF 0
eDTMFTONE_HASH	DTMF #
eNULLTONE	NULL tone (no tone)
eCONGESTIONTONE	Congestion tone
eWARNINGTONE	Warning tone
eWAITINGTONE	Waiting tone
eCONFIRMATIONTONE	Confirmation tone
eDIALTONE	Dialtone tone
eBUSYTONE	Busy tone
eRINGBACKTONE	Ringback tone
eSPECIALTONE	Special tone
eSASTONE	SAS tone
eCUSTOM_1	Custom tone 1
eCUSTOM_2	Custom tone 2
eCUSTOM_3	Custom tone 3
eCUSTOM_4	Custom tone 4
eCUSTOM_5	Custom tone 5
eCUSTOM_6	Custom tone 6
eCUSTOM_7	Custom tone 7
eCUSTOM_8	Custom tone 8
eCUSTOM_9	Custom tone 9
eCUSTOM_10	Custom tone 10
eCUSTOM_11	Custom tone 11
eCUSTOM_12	Custom tone 12
eCUSTOM_13	Custom tone 13
eCUSTOM_14	Custom tone 14
eCUSTOM_15	Custom tone 15
eCUSTOM_16	Custom tone 16
eCUSTOM_17	Custom tone 17
eCUSTOM_18	Custom tone 18
eCUSTOM_19	Custom tone 19
eCUSTOM_20	Custom tone 20
eCUSTOM_21	Custom tone 21
eCUSTOM_22	Custom tone 22
eCUSTOM_23	Custom tone 23
eCUSTOM_24	Custom tone 24
eCUSTOM_25	Custom tone 25
eCUSTOM_26	Custom tone 26
eCUSTOM_27	Custom tone 27
eCUSTOM_28	Custom tone 28
eCUSTOM_29	Custom tone 29
eCUSTOM_30	Custom tone 30

enum EToneType

Tone type

enum EVideoCodecIndex

Video Codec Index

Enumerator:

eH263_ID	0: H.263 (RFC2429/RFC4629)
eRFC2190_ID	1: H.263 (RFC2190)
eH264_ID	2: H.264
eMPEG4_ID	3: MPEG-4