The GetFarEndDtmfInfo API procedure is used to determine the type of DTMF supported by the far end of a call.

For outgoing calls:

This API procedure can be called anytime after the media engine sends the SipOutgoingCallConnected event to the application.

For incoming calls:

This API procedure can be called anytime after the media engine sends the SipIncomingCallStart event to the application.

For most applications, this API procedure can simply be called when the call enters the SipInCall state. The application can then save the returned API data to a temporary location and refer to it as required for the duration of the call.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetFarEndDtmfInfo(
	int PhoneLine,
	VoipMediaEngine..::.DTMF_FAR_END_INFO FarEndDtmfInfo
)
Visual Basic (Declaration)
Public Function GetFarEndDtmfInfo ( _
	PhoneLine As Integer, _
	FarEndDtmfInfo As VoipMediaEngine..::.DTMF_FAR_END_INFO _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetFarEndDtmfInfo(
	int PhoneLine, 
	VoipMediaEngine..::.DTMF_FAR_END_INFO^ FarEndDtmfInfo
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetFarEndDtmfInfo(
	int PhoneLine,
	VoipMediaEngine..::.DTMF_FAR_END_INFO FarEndDtmfInfo
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line to access.
FarEndDtmfInfo
Type: LanScape..::.VoipMediaEngine..::.DTMF_FAR_END_INFO
Specifies the location of an application supplied VoipMediaEngine..::.DTMF_FAR_END_INFO class onject that will contain the return values.

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)

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)

Remarks

None.

See Also