SWI CDMA specific Voice related APIs. More...

#include "SwiApiCdmaVoice.h"
#include "SwiIntPkCdmaVoice.h"
#include "ap/apidefs.h"

Functions
SWI_API SWI_RCODE	SwiGetAnswerState (swi_uint16 *AnswerMode, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetAnswerState (swi_uint16 AnswerMode)

SWI_API SWI_RCODE	SwiGetCallerID (swi_charp szCallerID, swi_uint32 iLength, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetCallAnswerCmd ()

SWI_API SWI_RCODE	SwiSetCallFlashCmd (swi_uint16 SOValue, const swi_charp pszCallNumber, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetHeadsetState (swi_uint16 *headsetState, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetCdmaSpeakerVolume (swi_uint16 *pSpeakerVolume, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetCdmaSpeakerVolume (swi_uint16 SpeakerVolume, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetSpeakerMuteStatus (swi_uint16 *pSpeakerMuteStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetSpeakerMuteStatus (swi_uint16 SpeakerMuteStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetToneLevel (swi_uint16 *pToneLevel, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetToneLevel (swi_uint16 ToneLevel, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetDTMFMuteStatus (swi_uint16 *pDTMFMuteStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetDTMFMuteStatus (swi_uint16 DTMFMuteStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetMICMuteStatus (swi_uint16 *pMICMuteStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetMICMuteStatus (swi_uint16 MICMuteStatus, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetDTMFKey (swi_uint16 DTMFKey, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiGetDTMFDuration (swi_uint16 pDTMFKeyOn, swi_uint16 pDTMFBurstDigitOn, swi_uint16 *pDTMFBurstInterdigitOff, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetDTMFDuration (swi_uint16 DTMFKeyOn, swi_uint16 DTMFBurstDigitOn, swi_uint16 DTMFBurstInterdigitOff, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetKeyPressed (swi_uint16 phoneKey)

SWI_API SWI_RCODE	SwiSetKeyReleased ()

SWI_API SWI_RCODE	SwiPstGetMinuteCallBeep (swi_uint16 *callBeep, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiPstSetMinuteCallBeep (swi_uint16 callBeep, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiSetDDTMPref (swi_uint16 iDDTMPref, swi_uint32 timeout)

SWI_API SWI_RCODE	SwiClearVoicemail (swi_uint32 timeout)

Detailed Description

SWI CDMA specific Voice related APIs.

Function Documentation

SWI_API SWI_RCODE SwiClearVoicemail ( swi_uint32 timeout )

This function is used to delete voicemail SMS on the modem.

Parameters

timeout[IN] Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetAnswerState	(	swi_uint16 *	AnswerMode,
		swi_uint32	timeout
	)

This function reports the mode the modem will use to answer the next incoming call.

Parameters

AnswerMode[OUT]	The destination in which the mode is returned. See SWI_TYPE_AnswerState.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetCallerID	(	swi_charp	szCallerID,
		swi_uint32	iLength,
		swi_uint32	timeout
	)

This function returns the standard caller ID for the current incoming call (if supported by the service provider)

Parameters

szCallerID[OUT]	The destination in which the callerID string is returned.
iLength[IN]	The maximum size of the output string (pointed to by szCallerID)
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetCdmaSpeakerVolume	(	swi_uint16 *	pSpeakerVolume,
		swi_uint32	timeout
	)

This function reports the volume level of the speaker (headset output).

Parameters

pSpeakerVolume[OUT]	The destination in which the volume level is returned: 0 = muted (see remarks) 1 = quietest 6 = loudest
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetDTMFDuration	(	swi_uint16 *	pDTMFKeyOn,
		swi_uint16 *	pDTMFBurstDigitOn,
		swi_uint16 *	pDTMFBurstInterdigitOff,
		swi_uint32	timeout
	)

This function reports the settings for the duration of DTMF tone generation for both single key events and multi-key strings.

Parameters

pDTMFKeyOn[OUT]	On duration for single key events. 100-3000 ms.
pDTMFBurstDigitOn[OUT]	On duration for multi-key strings. 95-350 ms.
pDTMFBurstInterdigitOff[OUT]	Off duration between keys in multi-key strings.60-200 ms.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The values for tone durations are set with SwiSetDTMFDuration.

SWI_API SWI_RCODE SwiGetDTMFMuteStatus	(	swi_uint16 *	pDTMFMuteStatus,
		swi_uint32	timeout
	)

This function reports the status of the DTMF tone mute setting.

Parameters

pDTMFMuteStatus[OUT]	The destination in which the mute state is returned: 0 = DTMF level enabled 1 = muted
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

This mute status is distinct from both the tone level of zero (muted), and the state of the speaker mute. The volume level set with SwiSetToneLevel is retained regardless of the setting of the mute status.

The mute state is controlled with SwiSetDTMFMuteStatus. When muted, tones are not sent to the speaker. When not muted, tones may still not be heard if the speaker mute is on.

The mute setting is not retained across resets and power cycles. The modem does retain the setting of DTMF mute during the session (across multiple calls).

SWI_API SWI_RCODE SwiGetHeadsetState	(	swi_uint16 *	headsetState,
		swi_uint32	timeout
	)

This function reports whether or not the headset is attached.

Parameters

headsetState[OUT]	The destination in which the state is returned: 0 = unplugged (removed) 1 = attached (inserted)
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetMICMuteStatus	(	swi_uint16 *	pMICMuteStatus,
		swi_uint32	timeout
	)

This function reports the status of the microphone (headset input) mute setting.

Parameters

pMICMuteStatus[OUT]	The destination in which the mute state is returned: 0 = MIC enabled 1 = muted
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The mute state is controlled with SwiSetMICMuteStatus.

         The mute setting is automatically disabled (MIC
         enabled) when a call is disconnected.

SWI_API SWI_RCODE SwiGetSpeakerMuteStatus	(	swi_uint16 *	pSpeakerMuteStatus,
		swi_uint32	timeout
	)

This function reports the status of the speaker mute setting.

Parameters

pSpeakerMuteStatus[OUT]	The destination in which the mute state is returned: 0 = speaker on 1 = muted (speaker off)
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiGetToneLevel	(	swi_uint16 *	pToneLevel,
		swi_uint32	timeout
	)

This function reports the volume level of DTMF tones sent to the speaker (headset output).

Parameters

pToneLevel[OUT]	The destination in which the tone level is returned:
timeout[IN]	Function timeout in milliseconds. 0 = muted (see remarks) 1 = quietest 6 = loudest

Returns: See SwiRcodes.h

The level can be set using SwiSetToneLevel. The level setting is retained across resets and power cycles.

There are separate tone (SwiGetDTMFMuteStatus) and speaker (SwiGetSpeakerMuteStatus) mute settings that do not alter the level reported here.

If the speaker mute is on, DTMF tones are not heard regardless of the tone level or DTMF mute status.

If the tone level reported is 0, no DTMF tones are heard on the speaker regardless of the settings of the mute states.

SWI_API SWI_RCODE SwiPstGetMinuteCallBeep	(	swi_uint16 *	callBeep,
		swi_uint32	timeout
	)

This function reports the state of the setting for generating an audible beep shortly before the one minute intervals of a voice call.

Parameters

callBeep[OUT]	The destination in which the beep setting is returned: 0 = disabled 1 = enabled
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The value is set using SwiPstSetMinuteCallBeep.

SWI_API SWI_RCODE SwiPstSetMinuteCallBeep	(	swi_uint16	callBeep,
		swi_uint32	timeout
	)

This function enables or disables the playing of a beep tone just before the one minute intervals of a voice call.

Parameters

callBeep[IN]	The beep setting to use: 0 = disabled 1 = enabled
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The setting can be read using SwiPstGetMinuteCallBeep.

SWI_API SWI_RCODE SwiSetAnswerState ( swi_uint16 AnswerMode )

This function sets the mode the modem will use to answer the next incoming call.

Parameters

AnswerMode[IN] The mode setting to make. See SWI_TYPE_AnswerState.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetCallAnswerCmd ( )

This function is is used to answer an incoming call.

Returns: See SwiRcodes.h SWI_RCODE_OK The function executed normally. This does not mean that the call was successfully answered. Use call notifications for the status of the call connection. See also SwiGetCallConnectionState.

Don�t call this unless you have detected an incoming call request (ring) via SWI_NOTIFY_CallIncoming.

The mode the modem will use to answer the call is set by SwiSetAnswerState that must have been set prior to receiving the incoming call notification.

SWI_API SWI_RCODE SwiSetCallFlashCmd	(	swi_uint16	SOValue,
		const swi_charp	pszCallNumber,
		swi_uint32	timeout
	)

This function sends a flash with information to the base station.

Parameters

SOValue[IN]	Service option to request from base station. See SWI_TYPE_FlashContext.
pszCallNumber[IN]	Phone number or feature code; can be null if a call number is not required.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetCdmaSpeakerVolume	(	swi_uint16	SpeakerVolume,
		swi_uint32	timeout
	)

This function sets the volume level of the speaker (headset output).

Parameters

SpeakerVolume[IN]	The volume level to set: 0 = mute (see remarks) 1 = quietest 6 = loudest
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetDDTMPref	(	swi_uint16	iDDTMPref,
		swi_uint32	timeout
	)

This function sets the DDTM Pref setting.

Parameters

iDDTMPref[IN]	HDR Hybrid Pref setting 0 = OFF 1 = ON 2 = No Change
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetDTMFDuration	(	swi_uint16	DTMFKeyOn,
		swi_uint16	DTMFBurstDigitOn,
		swi_uint16	DTMFBurstInterdigitOff,
		swi_uint32	timeout
	)

This function sets the durations for DTMF tone generation.

Parameters

DTMFKeyOn[IN]	On duration for single key events. 100-3000 ms.
DTMFBurstDigitOn[IN]	On duration for multi-key strings. 95-350 ms.
DTMFBurstInterdigitOff[IN]	Off duration between keys in multi-key strings.60-200 ms.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The settings can be read using SwiGetDTMFDuration.

SWI_API SWI_RCODE SwiSetDTMFKey	(	swi_uint16	DTMFKey,
		swi_uint32	timeout
	)

This function generates a single DTMF key tone.

Parameters

DTMFKey[IN]	The enumerated type for the key tone to generate. NOTE: Only the first 12 entries in the data type are valid for this function: #, *, 0-9. See SWI_TYPE_PhoneKey.
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The duration of the tone is determined by SwiSetDTMFDuration.

SWI_API SWI_RCODE SwiSetDTMFMuteStatus	(	swi_uint16	DTMFMuteStatus,
		swi_uint32	timeout
	)

This function sets the mute status of DTMF tones.

Parameters

DTMFMuteStatus[IN]	The mute state to set: 0 = DTMF level enabled 1 = muted
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

This mute status is distinct from a volume level of zero (muted). The volume level set with SwiSetToneLevel is retained regardless of the setting of the mute status.

The mute state can be read with SwiGetDTMFMuteStatus.

The mute setting is not retained across resets and power cycles. The modem does retain the setting of DTMF mute during the session (across multiple calls).

SWI_API SWI_RCODE SwiSetKeyPressed ( swi_uint16 phoneKey )

This function causes the modem to play audible DTMF key tones to the speaker (headset output).

Parameters

phoneKey[IN] The enumerated type for the key tone to generate. See documentation. NOTE: Only the first 12 entries in the data type are valid for this function: #, *, 0-9. See SWI_TYPE_PhoneKey.

Returns: See SwiRcodes.h

The tone is sent to the headset but not over the air. This is a human feedback for button pressing on a software keypad. The tone continues to sound until SwiSetKeyReleased is called.

SWI_API SWI_RCODE SwiSetKeyReleased ( )

This function stops a DTMF key tone playback in the headset that was initiated with SwiSetKeyPressed.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetMICMuteStatus	(	swi_uint16	MICMuteStatus,
		swi_uint32	timeout
	)

This function sets the mute status of the microphone (headset input).

Parameters

MICMuteStatus[IN]	The mute state to set: 0 = MIC enabled 1 = muted
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The mute state can be read with SwiGetMICMuteStatus.

         The mute setting is automatically disabled (MIC
         enabled) when a call is disconnected.

SWI_API SWI_RCODE SwiSetSpeakerMuteStatus	(	swi_uint16	SpeakerMuteStatus,
		swi_uint32	timeout
	)

This function sets the mute status of the speaker (headset output).

Parameters

SpeakerMuteStatus[IN]	The mute state to set: 0 = speaker on 1 = mute (speaker off)
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

SWI_API SWI_RCODE SwiSetToneLevel	(	swi_uint16	ToneLevel,
		swi_uint32	timeout
	)

This function sets the volume level of DTMF tones sent to the speaker (headset output).

Parameters

ToneLevel[IN]	The volume level to set: 0 = mute (see remarks) 1 = quietest 6 = loudest
timeout[IN]	Function timeout in milliseconds.

Returns: See SwiRcodes.h

The level setting is retained across resets and power cycles.

         A normal practice is to step the volume up or down, one step 
         at a time. The current tone level setting can be read using 
         SwiGetToneLevel.
         There are separate tone (SwiSetDTMFMuteStatus) and speaker 
         (SwiGetSpeakerMuteStatus) mute settings that do not alter 
         the level reported here.

         If the speaker mute is on, DTMF tones are not heard 
         regardless of the tone level or DTMF mute status.

         Use the DTMF mute state to enable or disable
         DTMF tones on the speaker.

Functions

Detailed Description

Function Documentation