The StopDtmfTone API procedure is used to terminate a currently playing DTMF tone. To start a DTMF tone, see the StartDtmfTone(Int32, UInt32, VoipMediaEngine..::.DTMF_TONE, UInt32, Boolean, Boolean, Boolean) API procedure.

Namespace:  LanScape
Assembly:  LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE StopDtmfTone(
	int PhoneLine,
	VoipMediaEngine..::.DTMF_TONE DtmfTone,
	bool Synchronous
)
Visual Basic (Declaration)
Public Function StopDtmfTone ( _
	PhoneLine As Integer, _
	DtmfTone As VoipMediaEngine..::.DTMF_TONE, _
	Synchronous As Boolean _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE StopDtmfTone(
	int PhoneLine, 
	VoipMediaEngine..::.DTMF_TONE DtmfTone, 
	bool Synchronous
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE StopDtmfTone(
	int PhoneLine,
	VoipMediaEngine..::.DTMF_TONE DtmfTone,
	boolean Synchronous
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to access. If you want to terminate DTMF on all phone lines, set this parameter to -1.
DtmfTone
Type: LanScape..::.VoipMediaEngine..::.DTMF_TONE
The DTMF tone to terminate.
Synchronous
Type: System..::.Boolean
Specifies whether the tone will be terminated synchronously or asynchrounously. If the tone is terminated synchronously, the StopDtmfTone API procedure will not return until the DTMF tone is completely turned OFF.

Return Value

If the function succeeds, the return value will be SipSuccess.

If the function fails, the return value will be one of the following values as specified by the VoipMediaEngine..::.TELEPHONY_RETURN_VALUE data type.

Return ValueDescription
SipCallFailure
This value is returned by telephony API procedures to indicate general API failure. This error value is used as a "catch all error". If you receive this error, check to make sure that all parameters specified in the API procedure call are correct. Particularly, verify that pointers to memory regions are valid. This error return value is only used if a mapping to another specific error value does not exist.

(API return value)

SipInvalidHandle
Application software specified an invalid telephony handle in one of the API procedures. This usually indicates memory corruption on the part of application software.

(API return value)

SipBadPhoneLine
Application software called a telephony API procedure and specified an invalid phone line. Phone lines are numbered starting from zero. This error is most commonly returned when attempting to access phone lines in excess of the max number of lines supported by the telephony engine.

(API return value)

SipInvalidDtmfTone
Application software attempted to start a DTMF tone by calling the StartDtmfTone(Int32, UInt32, VoipMediaEngine..::.DTMF_TONE, UInt32, Boolean, Boolean, Boolean) API procedure. The media engine determined that the DTMF tone specified is not a valid DTMF tone.

(API return value)

SipInternalDtmfSupportNotEnabled
Internal media engine in-band and RFC2833 DTMF support has not been enabled. See the DtmfEnabled startup parameter in the VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS structure for additional information.

(API return value)

SipMemoryError
The telephony engine attempted to allocate system memory but the allocation failed. Make sure the host system has enough virtual memory. Increasing the amount of virtual memory can remove these errors, however if critical telephony engine code has been swapped out to disk and is not resident in physical memory, you may experience degraded audio/video performance. If you want to remove this error and obtain the best possible audio/video performance, make sure the host system has enough physical memory. To resolve this error, you may also want to consider disabling certain features of the media engine such as conference calling. You can also reduce memory requirements if you reduce the maximum signal length of internal media engine signal paths by specifying a smaller number for the MaxMixerLinebuffers member of the VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS class that is passed to the StartSipTelephony(VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS) and ReStartSipTelephony(VoipMediaEngine..::.START_SIP_TELEPHONY_PARAMS) API procedures.

(API return value, PHONE_LINE_NOTIFICATION)

Remarks

None.

See Also