The SetIncomingDtmfDigitLossTimeout API procedure is used to specify when the media engine is able to detect lost DTMF digits. The IncomingDtmfDigitLossTimeoutMs parameter value specified by this API procedure sets the maximum time the media engine will tolerate no longer detecting an ON state for a currently ON DTMF digit. This time out value gets assessed as soon as the media engine detects either an incoming in-band or RFC2833 DTMF digit at a phone line. If the media engine does not continually receive further indications from a phone line's RTP receiver logic that the DTMF digit is still ON, the media engine will time out the digit and send the application a DTMF OFF event. This allows the media engine to gracefully handle DTMF OFF indications due to network errors or network cable being unplugged in the middle of receiving DTMF information.

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


public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetIncomingDtmfDigitLossTimeout(
	uint IncomingDtmfDigitLossTimeoutMs
Visual Basic (Declaration)
Public Function SetIncomingDtmfDigitLossTimeout ( _
	IncomingDtmfDigitLossTimeoutMs As UInteger _
Visual C++
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetIncomingDtmfDigitLossTimeout(
	unsigned int IncomingDtmfDigitLossTimeoutMs
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetIncomingDtmfDigitLossTimeout(
	UInt32 IncomingDtmfDigitLossTimeoutMs


Type: System..::.UInt32
The incoming DTMF digit loss time out in milliseconds.

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
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)

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)

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)



See Also