|
LinuxSDK
V1.4.0.5
|
This file contains definitions, enumerations, structures and forward declarations for SwiApiGsmVoice.c file. More...
Go to the source code of this file.
Macros | |
| #define | LENGTH_MaxPhone 20 |
| #define | LENGTH_CallerNameVoice (80 * UTF8_MAX_CHAR_SIZE) + 1 |
| #define | MAX_CALLS 7 |
| #define | LENGTH_ForwardNumber 38 |
| #define | LENGTH_SSString 40 |
| #define | LENGTH_SSPassword 4 |
| #define | LENGTH_ForwardInfo 18 |
| #define | MAX_FWD_INFO_ENTRIES 8 |
| #define | MAX_INFO_DATA 70 |
| #define | MAX_BS_LIST 70 |
| #define | LENGTH_RawData 229 |
This file contains definitions, enumerations, structures and forward declarations for SwiApiGsmVoice.c file.
Copyright (c) 2011 Sierra Wireless, Inc. All rights reserved
| #define LENGTH_CallerNameVoice (80 * UTF8_MAX_CHAR_SIZE) + 1 |
| #define LENGTH_ForwardInfo 18 |
| #define LENGTH_ForwardNumber 38 |
| #define LENGTH_MaxPhone 20 |
| #define LENGTH_RawData 229 |
| #define LENGTH_SSPassword 4 |
| #define LENGTH_SSString 40 |
| #define MAX_BS_LIST 70 |
| #define MAX_CALLS 7 |
| #define MAX_FWD_INFO_ENTRIES 8 |
| #define MAX_INFO_DATA 70 |
| enum SWI_TYPE_AudioGen |
Enumeration of audio profiles
| enum SWI_TYPE_AudioResult |
Enumeration of audio volume levels
This enumeration contains all the call progress states.
| enum SWI_TYPE_CallValid |
This enumeration contains all the call error states.
This enumeration contains all possible call states.
| enum SWI_TYPE_SS_CallBar |
This enumeration contains all the Supplementary Service Error Code
This enumeration contains all the Supplementary Service Reject Codes
This enumeration contains all the Supplementary Service Service Code
| enum SWI_TYPE_ToneLength |
This enumeration contains the actions that can be performed on a call.
| SWI_API SWI_RCODE SwiAbortRequest | ( | struct SWI_STRUCT_SS_Abort * | sSSAbort, |
| swi_uint32 | timeout | ||
| ) |
User initiated supplementary service operations can take up to 20 seconds to complete. This object provides the user with the cancel operation functionality
The first field of the set request and response packets is the current version of the packet format. These fields are guaranteed to never change position or size in their packet. The version indicates how the packet should be interpreted. The current version of both the set request and response packet is 1
| sSSAbort[IN],: | information about the SS Abort request to be sent |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiAcknowledgeMissedCall | ( | struct SWI_STRUCT_MissedCall * | pMissedCall, |
| swi_uint32 | timeout | ||
| ) |
This function is used to acknowledge missed calls. This causes the
missed count to be reset.
A request is sent to the modem. The modem's response indicates
that the request has been processed.
The caller must specify the amount of time to wait for the modem
to respond to the request.
| pMissedCall[OUT],: | missed calls |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiGetAudioProfile | ( | struct SWI_STRUCT_AudioProfile * | pAudioProfile, |
| swi_uint32 | timeout | ||
| ) |
This function is used to get the currently used audio profile
| pAudioProfile[OUT],: | current audio profile currently used |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiGetCLIRSetting | ( | struct SWI_STRUCT_CLIR_Setting * | pCLIR, |
| swi_uint32 | timeout | ||
| ) |
This function is used to fetch the caller line identity restriction
(CLIR) setting from the modem. A request is sent to the modem.
The modem will respond with the current CLIR setting.
The caller must specify the amount of time to wait for the modem
to respond to the request.
| pCLIR[OUT],: | the current CLIR setting |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiGetGsmSpeakerVolume | ( | struct SWI_STRUCT_GSM_SpeakerVolume * | sSpeakerVolume, |
| swi_uint32 | timeout | ||
| ) |
This function is used to retrieve the speaker volume. The speaker volume setting is stored on the modem.
The value returned is the percentage of full volume. This function should be used every time the host application is started to restore the previous setting.
| [OUT] | sSpeakerVolume: Speaker volume |
| [IN] | timeout: Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiGetMicMute | ( | struct SWI_STRUCT_MicMute * | pMicMute, |
| swi_uint32 | timeout | ||
| ) |
This function is used to fetch the current mute status of the microphone.
A request is sent to the modem. The modem's response contains the modem's mute setting.
Use this function every time the application is started to determine the state of the microphone's mute setting.
| pMicMute | [OUT]: Microphone Mute setting: 0 - Mic is not muted 1 - Mic is mute |
| timeout | [IN]: Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiGetNVToneStore | ( | struct SWI_STRUCT_NVToneStore * | pToneLength, |
| swi_uint32 | timeout | ||
| ) |
This function is used to retrieve DTMF tone parameters from the modem. The tone parameters are used when playing DTMF tones. A request is sent to the modem. The modem's response contains the tone parameters stored in the modem. The caller must specify the amount of time to wait for the modem to respond to the request.
| pToneLength[OUT],: | information about the DTMF tones |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiGetSpeakerMute | ( | struct SWI_STRUCT_GSM_SpeakerMute * | pSpeakerMute, |
| swi_uint32 | timeout | ||
| ) |
This function is used to retrieve the speaker mute setting. The
speaker mute setting is stored on the modem.
A request is sent to the modem. The modem's response contains the
speaker mute setting.
The caller must specify the amount of time to wait for the modem
to respond to the request.
| pSpeakerMute[OUT],: | speaker mute setting |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiGetVoiceMessage | ( | struct SWI_STRUCT_VoiceMessage * | pVoiceMessage, |
| swi_uint32 | timeout | ||
| ) |
This function is used to retrieve voice mail waiting status.
This indicates if there is new voice mail.
A request is sent to the modem. The modem's response contains the
voice mail waiting status.
The caller must specify the amount of time to wait for the modem
to respond to the request.
| pVoiceMessage[OUT],: | voice mail waiting status |
| timeout[IN],: | response timeout value in milliseconds |
This function should not be called until the application receives the SWI_NOTIFY_SmsReady notification.
| SWI_API SWI_RCODE SwiSetAudioProfile | ( | struct SWI_STRUCT_AudioProfile * | pAudioProfile, |
| swi_uint32 | timeout | ||
| ) |
This function is used to configure the currently used audio profile
| pAudioProfile[IN],: | current audio profile currently used |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetCallControlUMTS | ( | const struct SWI_STRUCT_CALL_UMTS_Control * | pCall, |
| swi_uint32 | timeout | ||
| ) |
This function is used to answer calls and manage multiple calls. Use this function to: answer an incoming call, put a call on hold, activate a call (take it off hold), link calls to create a multi-party call, swap an active call and on hold call and disconnect a call.
A request is sent to the modem indicating the call id and the action to take. The modem will respond to the request indicating that the request is being processed. The SWI_NOTIFY_CallProgress and SWI_NOTIFY_CallStatus notifications will reflect the status of the current calls.
The caller must specify the amount of time to wait for the modem to respond to the request.
| pCall[IN],: | information needed to create the call |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetCallOriginate | ( | const struct SWI_STRUCT_CALL_Create * | pCall, |
| swi_uint32 | timeout | ||
| ) |
This function is used to initiate an outgoing voice call. A request containing the phone number is sent to the modem. The modem will respond to the request indicating that the request is being processed. The SWI_NOTIFY_CallProgress and SWI_NOTIFY_CallStatus notifications will reflect the status of the created call.
The caller must specify the amount of time to wait for the modem to respond to the request.
| pCall[IN],: | information needed to create the call |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetCLIRSetting | ( | const struct SWI_STRUCT_CLIR_Setting * | pCLIR, |
| swi_uint32 | timeout | ||
| ) |
This function is used to modify the caller line identity
restriction (CLIR) setting on the modem. A request is sent to the
modem specifying the a CLIR setting. The modem will respond to the
request indicating that the setting has been changed.
The caller must specify the amount of time to wait for the modem
to respond to the request.
| pCLIR[IN],: | CLIR setting |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetContDtmf | ( | struct SWI_STRUCT_ContDtmf * | pDtmf, |
| swi_uint32 | timeout | ||
| ) |
This function is used to play a continuous DTMF tone to the earpiece and over-the-air. A request is sent to the modem. The modem's response indicates that the request has been processed. The caller must specify the amount of time to wait for the modem to respond to the request.
| pDtmf[IN],: | information about the DTMF tone to be sent |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetDTMFSend | ( | struct SWI_STRUCT_DTMFSend * | pDTMFSend, |
| swi_uint32 | timeout | ||
| ) |
This function is used to send overdial numbers during calls. This sends the digits as well as setting the duration of the DTMF tone and the duration of the interval between tones. It also enables/disables earpiece feedback (which determines whether the tone is audible).
A request is sent to the modem. The modem's response indicates that the request has been processed.
The caller must specify the amount of time to wait for the modem to respond to the request.
| pDTMFSend[IN],: | information about the DTMF tones to be sent |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetGsmSpeakerVolume | ( | struct SWI_STRUCT_GSM_SpeakerVolume * | sSpeakerVolume, |
| swi_uint32 | timeout | ||
| ) |
This function is used to set the speaker volume. The speaker volume is stored on the modem.
The value used in this function is the percentage of full volume. This is stored in NVRAM. The host application may present a few volume levels that are mapped to specific percentage levels. For example, the application might have six volume levels where: 1 = 17%, 2 = 33%, 3 = 50%, 4 = 66%, 5 = 83%, and 6 = 100%.
| [IN] | sSpeakerVolume: Speaker volume |
| [IN] | timeout: Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiSetMicMute | ( | struct SWI_STRUCT_MicMute * | pMicMute, |
| swi_uint32 | timeout | ||
| ) |
This function is used to mute the microphone. The microphone mute setting is stored on the modem.
A request is sent to the modem. The modem's response indicates that the request has been processed.
This function does not affect the microphone volume setting, it only enables or disables the muting effect. Settings made with this function are lost when the modem resets. The setting is not lost when switching between calls. The application should ensure that the microphone is on when the user switches between calls.
| pMicMute | [IN]: Microphone Mute setting: 0 - Mic is not muted 1 - Mic is muted |
| timeout | [IN]: Response timeout value in milliseconds. |
| SWI_API SWI_RCODE SwiSetNVToneStore | ( | struct SWI_STRUCT_NVToneStore * | pToneLength, |
| swi_uint32 | timeout | ||
| ) |
This function is used to set the DTMF tone parameters in the modem.
The parameters are stored on the modem.
A request is sent to the modem. The modem's response indicates that
the request has been processed.
The caller must specify the amount of time to wait for the modem
to respond to the request.
| pToneLength[IN],: | information about the DTMF tones |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetSpeakerMute | ( | struct SWI_STRUCT_GSM_SpeakerMute * | pSpeakerMute, |
| swi_uint32 | timeout | ||
| ) |
This function is used to mute the speaker.
The speaker mute setting is stored on the modem.
A request is sent to the modem. The modem's response indicates that
the request has been processed.
The caller must specify the amount of time to wait for the modem
to respond to the request.
| pSpeakerMute[IN],: | speaker mute setting |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetSSPassword | ( | struct SWI_STRUCT_SS_PasswordStatus * | sSSPassStatus, |
| swi_uint32 | timeout | ||
| ) |
The CNS_SS_PWD_STS notification can be received as a result of a CNS_SS_PWD_REG get request or can be network initiated
A CNS_SS_PWD_STS set request should be sent in response to a CNS_SS_PWD_STS notification if the transaction status is "Enter Password", "Enter New Password", "Enter New Password AGain", "Bad Password Try Again" or "Bad Password Format Try Again. IF the notification indicates "Bad Password Try Again" or "Bad PAssword Format Try Again" then the user should be notified.
The first field of the set request/response and notification packets is the current version of the packet format. These fields are guaranteed to never change position or size in their packet. The version indicates how the packet should be interpreted. The current version of the set request, response and notification packets is 1
| sSSPassStatus[IN],: | information about the SS password |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetSSRequest | ( | struct SWI_STRUCT_SS_Request * | sSSRequest, |
| swi_uint32 | timeout | ||
| ) |
This function provides the main interface for user initiated supplementary service operations. There are 5 different request types: erase, activate, deactivate, interrogate and register.
If no basic service group information is present in this request, it is assumed that the requested operation should affect all supplementary services.
The international number flag, length of forwarding number, forwarding number and no reply information field are needed only when requested to register information for call forwarding.
To enable call waiting simply send a activate request with the call waiting supplemenetary service code
The first field of the set request and response packets is the current version of the packet. The version indicate how the packet should be interpreted. The current version of both the set request and response packets is 1.
| sSSRequest[IN],: | information about the SS request to be sent |
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiSetUserdefinedUserBusy | ( | swi_uint32 | timeout | ) |
This function is used to set UDUB to automatically send an incoming call to voicemail or return the busy signal.
A request is sent to the modem. The modem's response indicates that the request has been processed.
The caller must specify the amount of time to wait for the modem to respond to the request.
| timeout[IN],: | response timeout value in milliseconds |
| SWI_API SWI_RCODE SwiStartSSPassReg | ( | struct SWI_STRUCT_SS_PasswordReg * | sSSPassReg, |
| swi_uint32 | timeout | ||
| ) |
The host can initiate the changing of a supplementary service password by sending a CNS_SS_PWD_REG set request. The card will return a transaction handle to the host in the set response.
The set request initiates a network password registration procedure. The network will prompt the host of the old password, the new password twice using the transaction handle and the CNS_SS_PWD_STS object notification. The host will return the passwords to the network using the CNS_SS_PWD_STS set request
The first field of the set request and response packet is the current version of the packet format. These fields are guaranteed to never change position or size in their packet. The version indicates how the packet should be interpreted. The current version of both the set request and response packets is 1.
| sSSPassReg[IN],: | information about the SS password registration |
| timeout[IN],: | response timeout value in milliseconds |