The GetNoiseThreshold procedure allows the application software to obtain the current signal threshold that is used for all RTP transmitter DSP computations. The value returned by this procedure is shared among all phone lines the telephony engine supports. It will be in the range of values as returned by the GetMinNoiseThreshold(UInt32%) and GetMaxNoiseThreshold(UInt32%) API procedures.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNoiseThreshold(
	ref uint NoiseThreshold
)
Visual Basic (Declaration)
Public Function GetNoiseThreshold ( _
	ByRef NoiseThreshold As UInteger _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNoiseThreshold(
	unsigned int% NoiseThreshold
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE GetNoiseThreshold(
	/** @ref */UInt32 NoiseThreshold
)

Parameters

NoiseThreshold
Type: System..::.UInt32 %
A reference to a variable that will receive the current value of the noise threshold used by the RTP transmitter.

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)

SipBadParameter
One of the telephony API procedures was called by application software and was passed a pointer to an invalid memory address. Normally this error will occur when application software passes NULL pointer values to the telephony API. For managed code applications, you should never see this error unless your process space has exhausted memory.

(API return value)

Remarks

None.

See Also