| CE Gobi SDK 2.14 GobiApi

- Main Page
- Modules
- Classes
- Files

- File List

SwiM2MAVAPI.h
1 /*===========================================================================
2 FILE:
3 SwiM2MAVAPI.h
4
5 DESCRIPTION:
6 Sierra Wireless M2M AV Service APIs, Service Type 0xF5
7
8 Copyright (C) 2015 Sierra Wireless Incorporated. All rights reserved.
9 Sierra Wireless Proprietary/GTDR
10 ==========================================================================*/
11
12 #ifndef __SWI_M2MAV_API_H__
13 #define __SWI_M2MAV_API_H__
14
18
19
20 /*=========================================================================*/
21 // Definitions
22 /*=========================================================================*/
23 #ifdef GOBIAPI_EXPORTS
24 #define IMPORTGOBI extern "C" __declspec( dllexport )
25 #else //GOBIAPI_EXPORTS
26 #ifdef __cplusplus
27 /* C++ callable DLL */
28 #define IMPORTGOBI extern "C" __declspec( dllimport )
29 #else
30 /* C callable DLL */
31 #define IMPORTGOBI __declspec( dllimport )
32 #endif
33 #endif //GOBIAPI_EXPORTS
34
35 // Calling convention for API
36 #define GOBICALLBACK __stdcall
37 #define GOBICMAPI __stdcall
38
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42
43 #define MAX_PIFACE_TABLE_SIZE 9
44
45 /*=========================================================================*/
46 // Structs
47 /*=========================================================================*/
48 typedef struct
49 {
50 BYTE PIFACEParamLen;
51 BYTE PIFACEParam[MAX_PIFACE_TABLE_SIZE];
52 } PIFACETable;
53
54 typedef struct
55 {
56 BYTE AudioProfile;
57 BYTE ACDBDevice;
58 BYTE PIFACEID;
59 PIFACETable PIFACETbl;
60 } AudioConfig;
61
62 typedef struct
63 {
64 LONG B0;
65 LONG B1;
66 LONG B2;
67 LONG A1;
68 LONG A2;
69 } PCMIIRFilter;
70
71 typedef struct
72 {
73 BYTE Profile;
74 BYTE Switch;
75 BYTE Stage;
76 } PCMIIRSetConfig;
77
78 typedef struct
79 {
80 BYTE Profile;
81 BYTE Stage;
82 PCMIIRFilter Coeff;
83 } PCMIIRSetCoeff;
84 #ifdef __cplusplus
85 };
86 #endif
87
88 /*=========================================================================*/
89 // Prototypes
90 /*=========================================================================*/
91
123 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetProfile(
124 // req params
125 BYTE* pGenerator,
126 // resp params
127 BYTE* pProfile,
128 BYTE* pEarMute,
129 BYTE* pMicMute,
130 BYTE* pOutGenerator,
131 BYTE* pVolume,
132 BYTE* pCwtMute
133 );
134
164 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetProfile(
165 // req params
166 BYTE* pProfile,
167 BYTE* pEarMute,
168 BYTE* pMicMute,
169 BYTE* pGenerator,
170 BYTE* pVolume,
171 BYTE* pCwtMute
172 // resp params
173 );
174
191 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetVolume(
192 // req params
193 BYTE* pProfile,
194 BYTE* pGenerator,
195 // resp params
196 BYTE* pVolume
197 );
198
217 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetVolume(
218 // req params
219 BYTE* pProfile,
220 BYTE* pGenerator,
221 BYTE* pVolume
222 // resp params
223 );
224
244 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVMute(
245 // req params
246 BYTE* pProfile,
247 BYTE* pEarMute,
248 BYTE* pMicMute,
249 BYTE* pcwtMute//waiting tone mute
250 // resp params
251 );
252
272 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVMute(
273 // req params
274 BYTE* pProfile,
275 BYTE* pEarMute,
276 BYTE* pMicMute,
277 BYTE* pcwtMute//waiting tone mute
278 // resp params
279 );
280
310 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVCFG(
311 // req params
312 BYTE* pAudioProfile,
313 BYTE* pACDBDevice,
314 BYTE* pPIFACEID,
315 PIFACETable* pPIFACETable
316 // resp params
317 );
318
329 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVCFG(
330 // req params
331 // resp params
332 AudioConfig* pAudioConfig,
333 BYTE* pSize
334 );
343 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioNVDef(
344 // req params
345 // resp params
346 );
360 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetLPBK(
361 // req params
362 BYTE* pEnable
363 // resp params
364 );
365
379 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetSpeakerGain(
380 // req params
381 BYTE* pProfile,
382 // resp params
383 USHORT* pSpkrGain
384 );
385
399 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetSpeakerGain(
400 // req params
401 BYTE* pProfile,
402 USHORT* pSpkrGain
403 // resp params
404 );
405
419 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetSTG(
420 // req params
421 BYTE* pProfile,
422 // resp params
423 WORD* pGainValue
424 );
425
439 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetSTG(
440 // req params
441 BYTE* pProfile,
442 WORD* pGainValue
443 // resp params
444 );
445
458 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetTxVolume(
459 // req params
460 BYTE* pProfile,
461 // resp params
462 WORD* pTxVolume
463 );
464
477 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetTxVolume(
478 // req params
479 BYTE* pProfile,
480 WORD* pTxVolume
481 // resp params
482 );
483
496 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetMicGain(
497 // req params
498 BYTE* pProfile,
499 // resp params
500 WORD* pMicGain
501 );
502
517 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetMicGain(
518 // req params
519 BYTE* pProfile,
520 WORD* pMicGain
521 // resp params
522 );
523
541 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetVolDB(
542 // req params
543 BYTE* pProfile,
544 BYTE* pGenerator,
545 BYTE* pLevel,
546 // resp params
547 WORD* pValue
548 );
549
567 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetVolDB(
568 // req params
569 BYTE* pProfile,
570 BYTE* pGenerator,
571 BYTE* pLevel,
572 WORD* pValue
573 // resp params
574 );
575
576 /*IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetTXPCMIIR(
577 // req params
578 BYTE* pProfile,
579 BYTE* pOpMode,
580 // resp params
581 BYTE* pSwitch,
582 BYTE* pStage,
583 PCMIIRFilter* pFilterCoeff
584 );
585
586 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetTXPCMIIR(
587 // req params
588 PCMIIRSetConfig* pConfig,
589 PCMIIRSetCoeff* pCoeff
590 // resp params
591 );
592
593 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetRXPCMIIR(
594 // req params
595 BYTE* pProfile,
596 BYTE* pOpMode,
597 // resp params
598 BYTE* pSwitch,
599 BYTE* pStage,
600 PCMIIRFilter* pFilterCoeff
601 );
602
603 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetRXPCMIIR(
604 // req params
605 PCMIIRSetConfig* pConfig,
606 PCMIIRSetCoeff* pCoeff
607 // resp params
608 );*/
609
623 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVTXG(
624 // req params
625 BYTE* pProfile,
626 // resp params
627 WORD* pEncoderGain
628 );
629
643 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVTXG(
644 // req params
645 BYTE* pProfile,
646 WORD* pEncoderGain
647 // resp params
648 );
649
663 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVRXG(
664 // req params
665 BYTE* pProfile,
666 // resp params
667 WORD* pDecoderGain
668 );
669
683 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVRXG(
684 // req params
685 BYTE* pProfile,
686 WORD* pDecoderGain
687 // resp params
688 );
689
703 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVEC(
704 // req params
705 BYTE* pProfile,
706 // resp params
707 BYTE* pSwitch
708 );
709
723 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVEC(
724 // req params
725 BYTE* pProfile,
726 BYTE* pSwitch
727 // resp params
728 );
729
743 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVNS(
744 // req params
745 BYTE* pProfile,
746 // resp params
747 BYTE* pSwitch
748 );
749
763 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVNS(
764 // req params
765 BYTE* pProfile,
766 BYTE* pSwitch
767 // resp params
768 );
769
785 IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioPlayTone(
786 // req params
787 BYTE* pGenerator,
788 BYTE* pAudioTone,
789 USHORT* pToneDuration //optional
790 // resp params
791 ); // End of SwiM2MAV group
793 #endif //SwiM2MAVAPI_H
SwiM2MAV_AudioGetMicGain
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetMicGain(BYTE *pProfile, WORD *pMicGain)
SwiM2MAV_AudioGetAVRXG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVRXG(BYTE *pProfile, WORD *pDecoderGain)
AudioConfig
Definition: SwiM2MAVAPI.h:54
PCMIIRFilter
Definition: SwiM2MAVAPI.h:62
SwiM2MAV_AudioGetProfile
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetProfile(BYTE *pGenerator, BYTE *pProfile, BYTE *pEarMute, BYTE *pMicMute, BYTE *pOutGenerator, BYTE *pVolume, BYTE *pCwtMute)
SwiM2MAV_AudioSetAVEC
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVEC(BYTE *pProfile, BYTE *pSwitch)
SwiM2MAV_AudioGetAVTXG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVTXG(BYTE *pProfile, WORD *pEncoderGain)
SwiM2MAV_AudioSetMicGain
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetMicGain(BYTE *pProfile, WORD *pMicGain)
SwiM2MAV_AudioSetLPBK
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetLPBK(BYTE *pEnable)
SwiM2MAV_AudioGetAVEC
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVEC(BYTE *pProfile, BYTE *pSwitch)
PIFACETable
Definition: SwiM2MAVAPI.h:48
SwiM2MAV_AudioSetProfile
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetProfile(BYTE *pProfile, BYTE *pEarMute, BYTE *pMicMute, BYTE *pGenerator, BYTE *pVolume, BYTE *pCwtMute)
SwiM2MAV_AudioSetTxVolume
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetTxVolume(BYTE *pProfile, WORD *pTxVolume)
SwiM2MAV_AudioGetTxVolume
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetTxVolume(BYTE *pProfile, WORD *pTxVolume)
SwiM2MAV_AudioSetAVTXG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVTXG(BYTE *pProfile, WORD *pEncoderGain)
SwiM2MAV_AudioSetAVRXG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVRXG(BYTE *pProfile, WORD *pDecoderGain)
SwiM2MAV_AudioGetVolDB
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetVolDB(BYTE *pProfile, BYTE *pGenerator, BYTE *pLevel, WORD *pValue)
SwiM2MAV_AudioGetSpeakerGain
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetSpeakerGain(BYTE *pProfile, USHORT *pSpkrGain)
SwiM2MAV_AudioSetVolume
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetVolume(BYTE *pProfile, BYTE *pGenerator, BYTE *pVolume)
SwiM2MAV_AudioSetAVCFG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVCFG(BYTE *pAudioProfile, BYTE *pACDBDevice, BYTE *pPIFACEID, PIFACETable *pPIFACETable)
SwiM2MAV_AudioGetAVCFG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVCFG(AudioConfig *pAudioConfig, BYTE *pSize)
PCMIIRSetCoeff
Definition: SwiM2MAVAPI.h:78
SwiM2MAV_AudioSetAVMute
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVMute(BYTE *pProfile, BYTE *pEarMute, BYTE *pMicMute, BYTE *pcwtMute)
SwiM2MAV_AudioSetVolDB
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetVolDB(BYTE *pProfile, BYTE *pGenerator, BYTE *pLevel, WORD *pValue)
SwiM2MAV_AudioGetAVMute
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVMute(BYTE *pProfile, BYTE *pEarMute, BYTE *pMicMute, BYTE *pcwtMute)
PCMIIRSetConfig
Definition: SwiM2MAVAPI.h:71
SwiM2MAV_AudioSetAVNS
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetAVNS(BYTE *pProfile, BYTE *pSwitch)
SwiM2MAV_AudioPlayTone
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioPlayTone(BYTE *pGenerator, BYTE *pAudioTone, USHORT *pToneDuration)
SwiM2MAV_AudioGetVolume
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetVolume(BYTE *pProfile, BYTE *pGenerator, BYTE *pVolume)
SwiM2MAV_AudioGetSTG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetSTG(BYTE *pProfile, WORD *pGainValue)
SwiM2MAV_AudioNVDef
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioNVDef()
SwiM2MAV_AudioGetAVNS
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioGetAVNS(BYTE *pProfile, BYTE *pSwitch)
SwiM2MAV_AudioSetSTG
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetSTG(BYTE *pProfile, WORD *pGainValue)
SwiM2MAV_AudioSetSpeakerGain
IMPORTGOBI ULONG GOBICMAPI SwiM2MAV_AudioSetSpeakerGain(BYTE *pProfile, USHORT *pSpkrGain)