The SetDtmfPlaybackAmplitude API procedure is used to set the volume of all DTMF tones played back on local multimedia hardware.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetDtmfPlaybackAmplitude(
	int PlaybackAmplitude
)
Visual Basic (Declaration)
Public Function SetDtmfPlaybackAmplitude ( _
	PlaybackAmplitude As Integer _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetDtmfPlaybackAmplitude(
	int PlaybackAmplitude
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetDtmfPlaybackAmplitude(
	int PlaybackAmplitude
)

Parameters

PlaybackAmplitude
Type: System..::.Int32
The DTMF playback amplitude.

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)

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