LinuxSDK  V1.4.0.5
SwiApiGsmVoice.h
Go to the documentation of this file.
1 
14 #ifndef __SWIAPI_GSM_VOICE
15 #define __SWIAPI_GSM_VOICE
16 
17 #ifdef __cplusplus
18 extern "C" {
19 #endif
20 
21 #define LENGTH_MaxPhone 20
22 #define LENGTH_CallerNameVoice (80 * UTF8_MAX_CHAR_SIZE) + 1
23 #define MAX_CALLS 7
24 #define LENGTH_ForwardNumber 38
25 #define LENGTH_SSString 40
26 #define LENGTH_SSPassword 4
27 #define LENGTH_ForwardInfo 18
28 #define MAX_FWD_INFO_ENTRIES 8
29 #define MAX_INFO_DATA 70
30 #define MAX_BS_LIST 70
31 #define LENGTH_RawData 229
32 
33 /* include files */
34 #include "SwiDataTypes.h"
35 #include "SwiRcodes.h"
36 #include "SwiApiGsmSs.h"
37 
38 /* enum declarations */
42 enum SWI_TYPE_SS_ServiceStatus
43 {
44  SWI_STATUS_ServActiveMask = 0x01,
45  SWI_STATUS_ServRegisteredMask = 0x02,
46  SWI_STATUS_ServProvMask = 0x04,
47  SWI_STATUS_ServQuiescentMask = 0x08
48 };
49 
54 enum SWI_TYPE_SS_SubsOptionType
55 {
56  SWI_SUBSOPTIONTYPE_Override = 0x01,
57  SWI_SUBSOPTIONTYPE_CLIR
58 };
59 
64 enum SWI_TYPE_SS_SubsOptionCode
65 {
66  SWI_SUBSOPTIONCODE_OverrideEnabled = 0x00,
67  SWI_SUBSOPTIONCODE_OverrideDisabled = 0x01,
68  SWI_SUBSOPTIONCODE_ClirPermanent = 0x00,
69  SWI_SUBSOPTIONCODE_TempCallIdRestrict = 0x01,
70  SWI_SUBSOPTIONCODE_TempCallIdAllow = 0x02
71 };
72 
76 enum SWI_TYPE_SS_ForwardOption
77 {
78  SWI_FORWARDOPTION_NotifyFwdParyMask = 0x80,
79  SWI_FORWARDOPTION_NotifyCalledPartyMask = 0x20,
80  SWI_FORWARDOPTION_MobileNotReachMask = 0x00,
81  SWI_FORWARDOPTION_FwdBusyMask = 0x04,
82  SWI_FORWARDOPTION_FwdNotReach = 0x08,
83  SWI_FORWARDOPTION_FwdAllCalls = 0x0C
84 };
85 
89 enum SWI_TYPE_SS_CLIRSetting
90 {
91  SWI_CLIRSETTING_Permanent,
92  SWI_CLIRSETTING_TempCallIdRestrict,
93  SWI_CLIRSETTING_TempCallIdAllow
94 };
95 
99 enum SWI_TYPE_SS_ErrorCode
100 {
101  SWI_ERRORCODE_UnknownSubs = 0x01,
102  SWI_ERRORCODE_IllegalSubs = 0x09,
103  SWI_ERRORCODE_BearServNotProv, /* 0x0A */
104  SWI_ERRORCODE_TellServNotProv, /* 0x0B */
105  SWI_ERRORCODE_IllegalEquip, /* 0x0C */
106  SWI_ERRORCODE_CallBarred, /* 0x0D */
107  SWI_ERRORCODE_IllegalOper = 0x10,
108  SWI_ERRORCODE_ErrorStatus, /* 0x11 */
109  SWI_ERRORCODE_NotAvail, /* 0x12 */
110  SWI_ERRORCODE_SubsViolate, /* 0x13 */
111  SWI_ERRORCODE_Incompatible, /* 0x14 */
112  SWI_ERRORCODE_FacilityNotSup, /* 0x15 */
113  SWI_ERRORCODE_AbsentSubs = 0x1B,
114  SWI_ERRORCODE_SystemFail = 0x22,
115  SWI_ERRORCODE_DataMissing, /* 0x23 */
116  SWI_ERRORCODE_UnexpectValue, /* 0x24 */
117  SWI_ERRORCODE_PasswdRegFail, /* 0x25 */
118  SWI_ERRORCODE_NegPasswdChk, /* 0x26 */
119  SWI_ERRORCODE_NumPasswdViolate = 0x2B,
120  SWI_ERRORCODE_UnknownAlphabet = 0x47,
121  SWI_ERRORCODE_UssdBusy, /* 0x48 */
122  SWI_ERRORCODE_MaxMultiExceed = 0x7E,
123  SWI_ERRORCODE_ResourceNotAvail /* 0x7F */
124 };
125 
129 enum SWI_TYPE_SS_ErrorType
130 {
131  SWI_ERRORTYPE_NoInfo,
132  SWI_ERRORTYPE_CallBarring,
133  SWI_ERRORTYPE_Status,
134  SWI_ERRORTYPE_SubsViolate,
135  SWI_ERRORTYPE_AbsentSubs,
136  SWI_ERRORTYPE_SystemFail,
137  SWI_ERRORTYPE_PasswdRegFail,
138  SWI_ERRORTYPE_Incompatible
139 };
140 
144 enum SWI_TYPE_SS_CallBar
145 {
146  SWI_CALLBAR_Active,
147  SWI_CALLBAR_OperatorBarring
148 };
149 
153 enum SWI_TYPE_SS_SystemFail
154 {
155  SWI_SYSTEMFAIL_Plmn,
156  SWI_SYSTEMFAIL_Hlr,
157  SWI_SYSTEMFAIL_Vlr,
158  SWI_SYSTEMFAIL_Pvlr,
159  SWI_SYSTEMFAIL_ControlMsc,
160  SWI_SYSTEMFAIL_VisitMsc,
161  SWI_SYSTEMFAIL_Eir,
162  SWI_SYSTEMFAIL_Rss
163 };
164 
169 enum SWI_TYPE_SS_PasswdRegFail
170 {
171  SWI_PASSWDFAILREASON_Undetermined,
172  SWI_PASSWDFAILREASON_InvalidFormat,
173  SWI_PASSWDFAILREASON_NewMismatch
174 };
175 
179 enum SWI_TYPE_SS_ProblemType
180 {
181  SWI_PROBLEMTYPE_General,
182  SWI_PROBLEMTYPE_Invoke,
183  SWI_PROBLEMTYPE_ReturnResult,
184  SWI_PROBLEMTYPE_ReturnError
185 };
186 
190 enum SWI_TYPE_SS_RejectCode
191 {
192  SWI_REJECTCODE_GeneralUnrecognize = 0x00,
193  SWI_REJECTCODE_GeneralMistype = 0x01,
194  SWI_REJECTCODE_GeneralBadStruct = 0x02,
195  SWI_REJECTCODE_InvokeDupId = 0x00,
196  SWI_REJECTCODE_InvokeUnrecognizeId = 0x01,
197  SWI_REJECTCODE_InvokeMistype = 0x02,
198  SWI_REJECTCODE_InvokeResource = 0x03,
199  SWI_REJECTCODE_InvokeInitRelease = 0x04,
200  SWI_REJECTCODE_InvokeUnrecognizeLink = 0x05,
201  SWI_REJECTCODE_InvokeLinkRspUnexpect = 0x06,
202  SWI_REJECTCODE_InvokeLinkOpUnexpect = 0x07,
203  SWI_REJECTCODE_ResultUnrecognizeId = 0x00,
204  SWI_REJECTCODE_ResultUnexpected = 0x01,
205  SWI_REJECTCODE_ResultMistype = 0x02,
206  SWI_REJECTCODE_ErrorUnrecognizeId = 0x00,
207  SWI_REJECTCODE_ErrorUnexpected = 0x01,
208  SWI_REJECTCODE_ErrorUnrecognizedErr = 0x02,
209  SWI_REJECTCODE_ErrorUnexpectedErr = 0x03,
210  SWI_REJECTCODE_ErrorMistype = 0x04
211 };
212 
216 enum SWI_TYPE_SS_CancelReason
217 {
218  SWI_CANCELREASON_NoPipes,
219  SWI_CANCELREASON_OngoingTrans,
220  SWI_CANCELREASON_MnssReject,
221  SWI_CANCELREASON_NoControl,
222  SWI_CANCELREASON_InvalidId
223 };
224 
225 
229 enum SWI_TYPE_SS_PasswordGuidance
230 {
231  SWI_SSPASSWORDGUIDANCE_Password,
232  SWI_SSPASSWORDGUIDANCE_NewPassword,
233  SWI_SSPASSWORDGUIDANCE_NewPasswordAgain,
234  SWI_SSPASSWORDGUIDANCE_BadPassword,
235  SWI_SSPASSWORDGUIDANCE_BadPasswordFormat
236 };
237 
241 enum SWI_TYPE_SS_ServiceCode
242 {
243  SWI_SERVCODE_AllServices,
244  SWI_SERVCODE_AllLineIdServices = 0x10,
245  SWI_SERVCODE_CallerIdPresent, /* 0x11 */
246  SWI_SERVCODE_CallerIdRestrict, /* 0x12 */
247  SWI_SERVCODE_ConnectIdPresent, /* 0x13 */
248  SWI_SERVCODE_ConnectIdRestrict, /* 0x14 */
249  SWI_SERVCODE_MCI, /* 0x15 */
250  SWI_SERVCODE_CallingNamePresent = 0x19,
251  SWI_SERVCODE_CallFwdAllServices = 0x20,
252  SWI_SERVCODE_CallFwdUnconditional, /* 0x21 */
253  SWI_SERVCODE_CallFwdAllConditional = 0x28,
254  SWI_SERVCODE_CallFwdBusy, /* 0x29 */
255  SWI_SERVCODE_CallFwdNoReply = 0x2A,
256  SWI_SERVCODE_CallFwdNotReachable, /* 0x2B */
257  SWI_SERVCODE_AllCallOffering = 0x30,
258  SWI_SERVCODE_CT, /* 0x31 */
259  SWI_SERVCODE_MAH, /* 0x32 */
260  SWI_SERVCODE_AllCallComplete = 0x40,
261  SWI_SERVCODE_CallWaiting, /* 0x41 */
262  SWI_SERVCODE_CallHold, /* 0x42 */
263  SWI_SERVCODE_CompletionBusySubsciber, /* 0x43 */
264  SWI_SERVCODE_AllMultiparty = 0x50,
265  SWI_SERVCODE_Multiply, /* 0x51 */
266  SWI_SERVCODE_ALL_COMM_OF_INT = 0x60,
267  SWI_SERVCODE_ClosedUserGroup, /* 0x61 */
268  SWI_SERVCODE_AllCharging = 0x70,
269  SWI_SERVCODE_AdviceChargeInfo, /* 0x71 */
270  SWI_SERVCODE_AdviceChargeCharging, /* 0x72 */
271  SWI_SERVCODE_AllAdditionalInfo = 0x80,
272  SWI_SERVCODE_UserToUserSignalling, /* 0x81 */
273  SWI_SERVCODE_AllCallRestriction = 0x90,
274  SWI_SERVCODE_BarrOutgoing, /* 0x91 */
275  SWI_SERVCODE_BarrAllOutgoing, /* 0x92 */
276  SWI_SERVCODE_BarrOutgoingInter, /* 0x93 */
277  SWI_SERVCODE_BarrOutgoingInterExcept, /* 0x94 */
278  SWI_SERVCODE_BarrIncoming = 0x99,
279  SWI_SERVCODE_BarrAllIncoming, /* 0x9A */
280  SWI_SERVCODE_BarrIncomingRoam, /* 0x9B */
281  SWI_SERVCODE_PLMNAllSpecific = 0xF0,
282  SWI_SERVCODE_PLMNSpecific1, /* 0xF1 */
283  SWI_SERVCODE_PLMNSpecific2, /* 0xF2 */
284  SWI_SERVCODE_PLMNSpecific3, /* 0xF3 */
285  SWI_SERVCODE_PLMNSpecific4, /* 0xF4 */
286  SWI_SERVCODE_PLMNSpecific5, /* 0xF5 */
287  SWI_SERVCODE_PLMNSpecific6, /* 0xF6 */
288  SWI_SERVCODE_PLMNSpecific7, /* 0xF7 */
289  SWI_SERVCODE_PLMNSpecific8, /* 0xF8 */
290  SWI_SERVCODE_PLMNSpecific9, /* 0xF9 */
291  SWI_SERVCODE_PLMNSpecificA, /* 0xFA */
292  SWI_SERVCODE_PLMNSpecificB, /* 0xFB */
293  SWI_SERVCODE_PLMNSpecificC, /* 0xFC */
294  SWI_SERVCODE_PLMNSpecificD, /* 0xFD */
295  SWI_SERVCODE_PLMNSpecificE, /* 0xFE */
296  SWI_SERVCODE_PLMNSpecificF /* 0xFF */
297 };
298 
303 enum SWI_TYPE_SS_BasicServGrpType
304 {
305  SWI_BASICSERVGRPTYPE_TeleServices,
306  SWI_BASICSERVGRPTYPE_BearerServices
307 };
308 
312 enum SWI_TYPE_SS_RequestType
313 {
314  SWI_SSREQUESTTYPE_Erase = 0x01,
315  SWI_SSREQUESTTYPE_Activate,
316  SWI_SSREQUESTTYPE_Deactivate,
317  SWI_SSREQUESTTYPE_Interrogate,
318  SWI_SSREQUESTTYPE_Register
319 };
320 
324 enum SWI_TYPE_UMTS_CallControl
325 {
326  SWI_CALL_CONTROL_UMTS_RelAllHeld,
327  SWI_CALL_CONTROL_UMTS_RelAllActAccHeldWait,
328  SWI_CALL_CONTROL_UMTS_ReleaseCallX,
329  SWI_CALL_CONTROL_UMTS_HoldAllActAccHeldWait,
330  SWI_CALL_CONTROL_UMTS_HoldAllActExceptCallX,
331  SWI_CALL_CONTROL_UMTS_AddHeldCall,
332  SWI_CALL_CONTROL_UMTS_ConTwoCallsAndDiscon,
333  SWI_CALL_CONTROL_UMTS_DisconnectAll
334 };
335 
339 enum SWI_TYPE_GSM_CallState
340 {
341  SWI_CALLSTATE_Null,
342  SWI_CALLSTATE_Connecting,
343  SWI_CALLSTATE_Queued,
344  SWI_CALLSTATE_Waiting,
345  SWI_CALLSTATE_Alerting,
346  SWI_CALLSTATE_Connected,
347  SWI_CALLSTATE_Disconnecting
348 };
349 
353 enum SWI_TYPE_CallProgress
354 {
355  SWI_CALL_PROGRESS_Failed,
356  SWI_CALL_PROGRESS_Connecting,
357  SWI_CALL_PROGRESS_Queued,
360  SWI_CALL_PROGRESS_Waiting,
362  SWI_CALL_PROGRESS_Incoming,
363  SWI_CALL_PROGRESS_Ringing,
364  SWI_CALL_PROGRESS_Connected,
365  SWI_CALL_PROGRESS_Disconnecting,
366  SWI_CALL_PROGRESS_Disconnected,
367  SWI_CALL_PROGRESS_Forwarded
370 };
371 
375 enum SWI_TYPE_GSM_CallError
376 {
377  SWI_CALL_ERROR_OK,
378  SWI_CALL_ERROR_SubsciberBusy,
379  SWI_CALL_ERROR_Congestions,
380  SWI_CALL_ERROR_RadioPathUnavail,
381  SWI_CALL_ERROR_Error,
382  SWI_CALL_ERROR_NumberUnobtain,
383  SWI_CALL_ERROR_AuthFailure,
384  SWI_CALL_ERROR_NoNumber,
385  SWI_CALL_ERROR_BckgndCallCtrlFail,
386  SWI_CALL_ERROR_BckgndMMFail,
387  SWI_CALL_ERROR_ChannelBusy,
388  SWI_CALL_ERROR_FDNMismatch,
389  SWI_CALL_ERROR_BCFail,
390  SWI_CALL_ERROR_EmergencyOnly,
391  SWI_CALL_ERROR_ACMExceeded,
392  SWI_CALL_ERROR_HoldError,
393  SWI_CALL_ERROR_BusyProcReq,
394  SWI_CALL_ERROR_ChannelUnavail,
395  SWI_CALL_ERROR_OutgoingBarred,
396  SWI_CALL_ERROR_NumberBlacklisted,
397  SWI_CALL_ERROR_BlackListFull,
398  SWI_CALL_ERROR_RedialNotTimedOut,
399  SWI_CALL_ERROR_ModifyFail,
400  SWI_CALL_ERROR_NotInControl,
401  SWI_CALL_ERROR_NoCauseCode,
402  SWI_CALL_ERROR_CallBarred
403 };
404 
408 enum SWI_TYPE_CallPresentation
409 {
410  SWI_CALL_PRESENTATION_Number,
411  SWI_CALL_PRESENTATION_Restricted,
412  SWI_CALL_PRESENTATION_NoAvail
413 };
414 
418 enum SWI_TYPE_CallScreening
419 {
420  SWI_CALL_SCREENING_NotScreened,
421  SWI_CALL_SCREENING_Passed,
422  SWI_CALL_SCREENING_Failed,
423  SWI_CALL_SCREENING_Network
424 };
425 
429 enum SWI_TYPE_GSM_CallType
430 {
431  SWI_CALL_TYPE_VoiceCallLine1,
432  SWI_CALL_TYPE_VoiceCallLine2,
433  SWI_CALL_TYPE_CSD,
434  SWI_CALL_TYPE_FAX
435 };
436 
440 enum SWI_TYPE_CallValid
441 {
442  SWI_CALL_VALID_NoInfo,
443  SWI_CALL_VALID_InfoValid
444 };
445 
446 
450 enum SWI_TYPE_CallRestrict
451 {
452  SWI_CALL_RESTRICT_Default,
453  SWI_CALL_RESTRICT_Allowed,
454  SWI_CALL_RESTRICT_Restricted,
455  SWI_CALL_RESTRICT_Unknown
456 };
457 
461 enum SWI_TYPE_ToneLength
462 {
463  SWI_TONELENGTH_Short,
464  SWI_TONELENGTH_Medium,
465  SWI_TONELENGTH_Long,
466  SWI_TONELENGTH_UserDefined
467 };
468 
472 enum SWI_TYPE_AudioProfile
473 {
474  SWI_AUDIOPROFILE_Handset,
475  SWI_AUDIOPROFILE_Headset,
476  SWI_AUDIOPROFILE_SpeakerPhone,
477  SWI_AUDIOPROFILE_CarKit,
478  SWI_AUDIOPROFILE_TtyFullAudio,
479  SWI_AUDIOPROFILE_TtyTalkAudio,
480  SWI_AUDIOPROFILE_TtyHearAudio
481 };
482 
486 enum SWI_TYPE_AudioVolLevel
487 {
488  SWI_AUDIOVOLLEVEL_0,
489  SWI_AUDIOVOLLEVEL_1,
490  SWI_AUDIOVOLLEVEL_2,
491  SWI_AUDIOVOLLEVEL_3,
492  SWI_AUDIOVOLLEVEL_4,
493  SWI_AUDIOVOLLEVEL_5,
494  SWI_AUDIOVOLLEVEL_6,
495  SWI_AUDIOVOLLEVEL_7
496 };
497 
501 enum SWI_TYPE_AudioGen
502 {
503  SWI_AUDIOGEN_Voice,
504  SWI_AUDIOGEN_KeyBeep,
505  SWI_AUDIOGEN_Midi
506 };
507 
511 enum SWI_TYPE_AudioResult
512 {
513  SWI_AUDIORESULT_Success,
514  SWI_AUDIORESULT_InvalidSetting
515 };
516 
517 /* structure declarations */
525 struct SWI_STRUCT_MicMute
526 {
528  swi_uint32 sizeStruct;
532  swi_bool bMute;
533 };
534 
542 struct SWI_STRUCT_GSM_SpeakerVolume
543 {
546  swi_uint32 sizeStruct;
547 
550  swi_uint32 nVolume;
551 };
552 
560 struct SWI_STRUCT_GSM_SpeakerMute
561 {
563  swi_uint32 sizeStruct;
567  swi_bool bMute;
568 };
569 
577 struct SWI_STRUCT_NVToneStore
578 {
580  swi_uint32 sizeStruct;
582  enum SWI_TYPE_ToneLength eToneLength;
584  swi_uint32 nUserDefinedToneOnDuration;
586  swi_uint32 nUserDefinedToneOffDuration;
588  swi_uint32 nComfortToneOnDuration;
590  swi_uint32 nComfortToneOffDuration;
594  swi_bool bEarpieceFeedback;
595 };
596 
605 struct SWI_STRUCT_AudioProfile
606 {
608  swi_uint32 sizeStruct;
610  enum SWI_TYPE_AudioProfile eCurrent;
612  swi_bool bEarPieceMute;
614  swi_bool bMicMute;
616  enum SWI_TYPE_AudioVolLevel eVolLevel;
618  enum SWI_TYPE_AudioGen eAudioGen;
620  enum SWI_TYPE_AudioResult eActionResult;
621 };
622 
630 struct SWI_STRUCT_CLIR_Setting
631 {
633  swi_uint32 sizeStruct;
635  enum SWI_TYPE_CallRestrict eCallRestrict;
636 };
637 
643 struct SWI_STRUCT_VoiceMessage
644 {
646  swi_uint32 sizeStruct;
650  swi_bool bVoiceMailWaitingFeature;
654  swi_bool bVoiceMailWaitingLine1;
658  swi_bool bVoiceMailWaitingLine2;
662  swi_bool bFaxMssageWaiting1;
666  swi_bool bFaxMssageWaiting2;
667 };
668 
675 struct SWI_STRUCT_MissedCall
676 {
678  swi_uint32 sizeStruct;
680  swi_uint32 nCount;
681 };
682 
688 struct SWI_STRUCT_CALL_Create
689 {
691  swi_uint32 sizeStruct;
693  enum SWI_TYPE_CallRestrict eCallRestrict;
697  swi_bool bInternational;
699  swi_uint32 nNumberLength;
701  swi_uint8 bcdPhone[LENGTH_MaxPhone];
702 };
703 
710 struct SWI_STRUCT_CALL_EXP_Progress
711 {
713  swi_uint32 sizeStruct;
715  swi_uint32 CallID;
717  enum SWI_TYPE_CallProgress eCallProgress;
719  enum SWI_TYPE_GSM_CallError eCallError;
721  enum SWI_TYPE_CallValid eCallValid;
723  enum SWI_TYPE_CallPresentation eCallPresentation;
725  enum SWI_TYPE_CallScreening eCallScreening;
729  swi_bool bInternational;
731  swi_uint32 nNumberLength;
733  swi_uint8 bcdPhone[LENGTH_MaxPhone];
735  enum SWI_TYPE_GSM_CallType eCallType;
737  swi_char szCallerName[LENGTH_CallerNameVoice];
738 };
739 
745 struct SWI_STRUCT_CallForwarded
746 {
748  swi_uint32 sizeStruct;
750  swi_uint32 nCallID;
754  swi_bool bNotificationStatusPresent;
758  swi_uint32 nNotificationStatus;
759 };
760 
764 struct SWI_STRUCT_CALL_State
765 {
767  swi_uint32 sizeStruct;
769  swi_uint32 CallID;
771  enum SWI_TYPE_GSM_CallState eCallState;
779  swi_uint32 CallInfo;
780 };
781 
782 
789 struct SWI_STRUCT_CALL_Status
790 {
792  swi_uint32 sizeStruct;
794  swi_uint32 nCallSum;
796  swi_uint32 nCallOutgoing;
798  swi_uint32 nCallHeld;
800  swi_uint32 nCallWaiting;
802  swi_uint32 nCallQueued;
804  swi_uint32 nCallMultiparty;
806  swi_uint8 nNumberCalls;
808  struct SWI_STRUCT_CALL_State CallList[MAX_CALLS];
809 };
810 
816 struct SWI_STRUCT_DTMFSend
817 {
819  swi_uint32 sizeStruct;
821  swi_uint32 nNumberOfDigits;
824  swi_uint8 byDigits[20];
826  swi_uint32 nToneOnDuration;
828  swi_uint32 nToneOffDuration;
832  swi_bool bEarpieceFeedback;
833 };
834 
840 struct SWI_STRUCT_CALL_UMTS_Control
841 {
843  swi_uint32 sizeStruct;
845  swi_uint32 nVersion;
847  swi_uint32 nCallID;
851  enum SWI_TYPE_UMTS_CallControl eCallAction;
852 };
853 
859 struct SWI_STRUCT_ContDtmf
860 {
862  swi_uint32 sizeStruct;
864  swi_uint32 nDtmfTone;
868  swi_bool bStart;
869 };
870 
876 struct SWI_STRUCT_CFIcon
877 {
879  swi_uint32 sizeStruct;
883  swi_bool bIconOn;
884 };
885 
891 struct SWI_STRUCT_SS_Request
892 {
894  swi_uint32 sizeStruct;
896  swi_uint32 nVersion;
898  swi_uint32 nHandle;
900  enum SWI_TYPE_SS_RequestType eRequestType;
902  enum SWI_TYPE_SS_ServiceCode eSuppServiceCode;
904  swi_bool bBasicServGrpInfo;
906  enum SWI_TYPE_SS_BasicServGrpType eBasicServGrpType;
908  swi_uint32 eBasicServGrpCode;
910  swi_bool bInternationalNumFlag;
912  swi_uint32 nLengthFwdNum;
914  swi_uint8 byFwdNum[LENGTH_ForwardNumber];
916  swi_bool bNoReplyInfoPresent;
918  swi_int32 nNoReplyTime;
920  swi_bool bStringPresent;
922  swi_uint32 nLengthSSString;
924  swi_uint8 bySSString[LENGTH_SSString];
926  enum SWI_TYPE_SS_RequestStatus eRequestStatus;
927 };
928 
934 struct SWI_STRUCT_SS_Abort
935 {
937  swi_uint32 sizeStruct;
939  swi_uint32 nVersion;
941  swi_uint32 nHandle;
942 };
943 
949 struct SWI_STRUCT_SS_PasswordReg
950 {
952  swi_uint32 sizeStruct;
954  swi_uint32 nVersion;
956  swi_uint32 nHandle;
958  enum SWI_TYPE_SS_ServiceCode eSuppServiceCode;
959 };
960 
967 struct SWI_STRUCT_SS_PasswordStatus
968 {
970  swi_uint32 sizeStruct;
972  swi_uint32 nVersion;
974  swi_uint32 nHandle;
976  swi_uint32 nPasswordLength;
978  swi_uint8 byPassword[LENGTH_SSPassword];
980  enum SWI_TYPE_SS_PasswordGuidance ePasswordGuidance;
981 };
982 
987 struct SWI_STRUCT_SS_RespOK
988 {
990  swi_uint32 sizeStruct;
992  swi_uint32 nVersion;
994  swi_uint32 nHandle;
995 };
996 
1001 struct STRUCT_SS_FwdInfo
1002 {
1004  swi_bool bBasicServGrpInfoPresent;
1006  enum SWI_TYPE_SS_BasicServGrpType eBasicServGrpType;
1008  swi_uint32 eBasicServGrpCode;
1010  swi_bool bServStatusInfoPresent;
1012  enum SWI_TYPE_SS_ServiceStatus eServStatus;
1014  swi_bool bInternational;
1016  swi_uint32 nLengthFwdNum;
1018  swi_uint8 byFwdNum[LENGTH_ForwardInfo];
1020  swi_bool bFwdOptionsInfoPresent;
1022  enum SWI_TYPE_SS_ForwardOption eFwdOptions;
1024  swi_bool bNoReplyTimePresent;
1026  swi_uint32 NoReplyTime;
1027 };
1028 
1033 struct SWI_STRUCT_SS_RespFwdInfo
1034 {
1036  swi_uint32 sizeStruct;
1038  swi_uint32 nVersion;
1040  swi_uint32 nHandle;
1042  swi_bool bServiceCodePresent;
1044  enum SWI_TYPE_SS_ServiceCode eServiceCode;
1046  swi_uint32 nNumEntries;
1048  struct STRUCT_SS_FwdInfo sList[MAX_FWD_INFO_ENTRIES];
1049 };
1050 
1055 struct STRUCT_SS_CALL_BAR
1056 {
1058  swi_bool bBasicServGrpInfoPresent;
1060  enum SWI_TYPE_SS_BasicServGrpType eBasicServGrpType;
1062  swi_uint32 eBasicServGrpCode;
1064  swi_bool bServStatusInfoPresent;
1066  swi_uint32 nServStatus;
1067 };
1068 
1072 struct SWI_STRUCT_SS_RespCallBar
1073 {
1075  swi_uint32 sizeStruct;
1077  swi_uint32 nVersion;
1079  swi_uint32 nHandle;
1081  swi_bool bServiceCodePresent;
1083  enum SWI_TYPE_SS_ServiceCode eServiceCode;
1085  swi_uint32 nNumEntries;
1087  struct STRUCT_SS_CALL_BAR sList[MAX_FWD_INFO_ENTRIES];
1088 };
1089 
1094 struct STRUCT_SS_BasicServiceGroup
1095 {
1097  enum SWI_TYPE_SS_BasicServGrpType eBasicServGrpType;
1099  swi_uint32 eBasicServGrpCode;
1100 };
1101 
1105 struct SWI_STRUCT_SS_RespInfoData
1106 {
1108  swi_uint32 sizeStruct;
1110  swi_uint32 nVersion;
1112  swi_uint32 nHandle;
1114  swi_bool bServiceCodePresent;
1116  enum SWI_TYPE_SS_ServiceCode eServiceCode;
1118  swi_bool bServStatusPresent;
1120  enum SWI_TYPE_SS_ServiceStatus eServStatus;
1122  swi_bool bOptionInfoPresent;
1124  enum SWI_TYPE_SS_SubsOptionType eSubsOptionType;
1126  enum SWI_TYPE_SS_SubsOptionCode eSubsOptionCode;
1128  swi_uint32 nNumEntries;
1130  struct STRUCT_SS_BasicServiceGroup sList[MAX_INFO_DATA];
1131 };
1132 
1136 struct SWI_STRUCT_SS_RespStatus
1137 {
1139  swi_uint32 sizeStruct;
1141  swi_uint32 nVersion;
1143  swi_uint32 nHandle;
1145  swi_uint32 nServiceStatus;
1146 };
1147 
1151 struct SWI_STRUCT_SS_RespFwdNum
1152 {
1154  swi_uint32 sizeStruct;
1156  swi_uint32 nVersion;
1158  swi_uint32 nHandle;
1160  swi_bool bInternational;
1162  swi_uint32 nLengthFwdNum;
1164  swi_uint8 byFwdNum[LENGTH_ForwardNumber];
1165 };
1166 
1170 struct SWI_STRUCT_SS_RespBSList
1171 {
1173  swi_uint32 sizeStruct;
1175  swi_uint32 nVersion;
1177  swi_uint32 nHandle;
1179  swi_uint32 nNumEntries;
1181  struct STRUCT_SS_BasicServiceGroup sList[MAX_BS_LIST];
1182 };
1183 
1187 struct SWI_STRUCT_SS_RespListFwdInfo
1188 {
1190  swi_uint32 sizeStruct;
1192  swi_uint32 nVersion;
1194  swi_uint32 nHandle;
1196  swi_uint32 nNumEntries;
1198  struct STRUCT_SS_FwdInfo sList[MAX_FWD_INFO_ENTRIES];
1199 };
1200 
1204 struct SWI_STRUCT_SS_RespRaw
1205 {
1207  swi_uint32 sizeStruct;
1209  swi_uint32 nVersion;
1211  swi_uint32 nHandle;
1213  swi_uint32 nLength;
1215  swi_uint8 byData[LENGTH_RawData];
1216 };
1217 
1221 struct SWI_STRUCT_SS_RespPassword
1222 {
1224  swi_uint32 sizeStruct;
1226  swi_uint32 nVersion;
1228  swi_uint32 nHandle;
1230  swi_uint32 nPasswordLength;
1232  swi_uint8 byPassword[LENGTH_SSPassword];
1233 };
1234 
1238 struct SWI_STRUCT_SS_RespClir
1239 {
1241  swi_uint32 sizeStruct;
1243  swi_uint32 nVersion;
1245  swi_uint32 nHandle;
1247  enum SWI_TYPE_SS_ServiceStatus eServStatus;
1249  enum SWI_TYPE_SS_CLIRSetting eClir;
1250 };
1251 
1256 struct SubscriptionViolation
1257 {
1259  enum SWI_TYPE_SS_SubsOptionType eSubsOptionType;
1261  enum SWI_TYPE_SS_SubsOptionCode eSubsOptionCode;
1262 };
1263 
1268 struct IncompatibilityReason
1269 {
1271  swi_bool bServiceCodePresent;
1273  enum SWI_TYPE_SS_ServiceCode eServiceCode;
1275  swi_bool bBasicServGrpPresent;
1277  enum SWI_TYPE_SS_BasicServGrpType eBasicServGrpType;
1279  swi_uint32 eBasicServGrpCode;
1281  swi_bool bServStatusInfoPresent;
1283  enum SWI_TYPE_SS_ServiceStatus eServStatusErr;
1284 };
1285 
1290 union ErrorCause
1291 {
1293  enum SWI_TYPE_SS_CallBar eCallBarring;
1295  enum SWI_TYPE_SS_ServiceStatus eServStatus;
1297  swi_bool bAbsentSubs;
1299  enum SWI_TYPE_SS_SystemFail eSystemFail;
1301  enum SWI_TYPE_SS_PasswdRegFail ePasswdRegFail;
1303  struct SubscriptionViolation sSubscripViolation;
1305  struct IncompatibilityReason sIncompatibilityReason;
1306 };
1307 
1311 struct SWI_STRUCT_SS_RespError
1312 {
1314  swi_uint32 sizeStruct;
1316  swi_uint32 nVersion;
1318  swi_uint32 nHandle;
1320  enum SWI_TYPE_SS_ErrorCode eErrorCode;
1322  enum SWI_TYPE_SS_ErrorType eErrorType;
1324  union ErrorCause uErrorCause;
1325 };
1326 
1330 struct SWI_STRUCT_SS_RespReject
1331 {
1333  swi_uint32 sizeStruct;
1335  swi_uint32 nVersion;
1337  swi_uint32 nHandle;
1339  enum SWI_TYPE_SS_ProblemType eProblemType;
1341  enum SWI_TYPE_SS_RejectCode eRejectCode;
1342 };
1343 
1347 struct SWI_STRUCT_SS_RespCancel
1348 {
1350  swi_uint32 sizeStruct;
1352  swi_uint32 nVersion;
1354  swi_uint32 nHandle;
1356  enum SWI_TYPE_SS_CancelReason eCancelReason;
1357 };
1358 
1362 struct SWI_STRUCT_SS_RespRelease
1363 {
1365  swi_uint32 sizeStruct;
1367  swi_uint32 nVersion;
1369  swi_uint32 nHandle;
1370 };
1371 
1375 struct SWI_STRUCT_SSNotify
1376 {
1378  swi_uint32 sizeStruct;
1380  swi_uint32 nVersion;
1382  enum SWI_TYPE_SS_ServiceCode eServiceCode;
1383 };
1384 
1385 /* function prototypes */
1386 extern SWI_API SWI_RCODE SwiGetGsmSpeakerVolume(
1387  struct SWI_STRUCT_GSM_SpeakerVolume *sSpeakerVolume, swi_uint32 timeout);
1388 extern SWI_API SWI_RCODE SwiSetGsmSpeakerVolume(
1389  struct SWI_STRUCT_GSM_SpeakerVolume *sSpeakerVolume, swi_uint32 timeout);
1390 extern SWI_API SWI_RCODE SwiGetMicMute(
1391  struct SWI_STRUCT_MicMute *pMicMute, swi_uint32 timeout);
1392 extern SWI_API SWI_RCODE SwiSetMicMute(
1393  struct SWI_STRUCT_MicMute *pMicMute, swi_uint32 timeout);
1394 extern SWI_API SWI_RCODE SwiGetSpeakerMute(
1395  struct SWI_STRUCT_GSM_SpeakerMute *pSpeakerMute, swi_uint32 timeout);
1396 extern SWI_API SWI_RCODE SwiSetSpeakerMute(
1397  struct SWI_STRUCT_GSM_SpeakerMute *pSpeakerMute, swi_uint32 timeout);
1398 extern SWI_API SWI_RCODE SwiGetNVToneStore(
1399  struct SWI_STRUCT_NVToneStore *pToneLength, swi_uint32 timeout);
1400 extern SWI_API SWI_RCODE SwiSetNVToneStore(
1401  struct SWI_STRUCT_NVToneStore *pToneLength, swi_uint32 timeout);
1402 extern SWI_API SWI_RCODE SwiGetAudioProfile(
1403  struct SWI_STRUCT_AudioProfile* pAudioProfile, swi_uint32 timeout);
1404 extern SWI_API SWI_RCODE SwiSetAudioProfile(
1405  struct SWI_STRUCT_AudioProfile* pAudioProfile, swi_uint32 timeout);
1406 extern SWI_API SWI_RCODE SwiGetCLIRSetting(
1407  struct SWI_STRUCT_CLIR_Setting *pCLIR, swi_uint32 timeout);
1408 extern SWI_API SWI_RCODE SwiSetCLIRSetting(
1409  const struct SWI_STRUCT_CLIR_Setting *pCLIR, swi_uint32 timeout);
1410 extern SWI_API SWI_RCODE SwiGetVoiceMessage(
1411  struct SWI_STRUCT_VoiceMessage *pVoiceMessage, swi_uint32 timeout);
1412 extern SWI_API SWI_RCODE SwiAcknowledgeMissedCall(
1413  struct SWI_STRUCT_MissedCall *pMissedCall, swi_uint32 timeout);
1414 extern SWI_API SWI_RCODE SwiSetCallOriginate(
1415  const struct SWI_STRUCT_CALL_Create* pCall, swi_uint32 timeout);
1416 extern SWI_API SWI_RCODE SwiSetDTMFSend(
1417  struct SWI_STRUCT_DTMFSend *pDTMFSend, swi_uint32 timeout);
1418 extern SWI_API SWI_RCODE SwiSetCallControlUMTS(
1419  const struct SWI_STRUCT_CALL_UMTS_Control* pCall, swi_uint32 timeout);
1420 extern SWI_API SWI_RCODE SwiSetContDtmf(
1421  struct SWI_STRUCT_ContDtmf *pDtmf, swi_uint32 timeout);
1422 extern SWI_API SWI_RCODE SwiSetSSRequest (
1423  struct SWI_STRUCT_SS_Request* sSSRequest, swi_uint32 timeout);
1424 extern SWI_API SWI_RCODE SwiAbortRequest (
1425  struct SWI_STRUCT_SS_Abort* sSSAbort, swi_uint32 timeout);
1426 extern SWI_API SWI_RCODE SwiStartSSPassReg (
1427  struct SWI_STRUCT_SS_PasswordReg* sSSPassReg, swi_uint32 timeout);
1428 extern SWI_API SWI_RCODE SwiSetSSPassword (
1429  struct SWI_STRUCT_SS_PasswordStatus* sSSPassStatus, swi_uint32 timeout);
1430 extern SWI_API SWI_RCODE SwiSetUserdefinedUserBusy(swi_uint32 timeout);
1431 
1432 #ifdef __cplusplus
1433 } /* extern "C" { */
1434 #endif
1435 
1436 #endif /* __SWIAPI_GSM_VOICE */
1437 
1438 /*
1439  * $Log: SwiApiGsmVoice.h,v $
1440  */
Linux SDK V1.4.0.5
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved