The SetPhoneLineVolume API procedure is called by application software to change the volume of transmitted and received voice data. Controllable Volume gain is in the range of 0% to 400%.

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

Syntax

C#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetPhoneLineVolume(
	int PhoneLine,
	int RxVolume,
	int TxVolume
)
Visual Basic (Declaration)
Public Function SetPhoneLineVolume ( _
	PhoneLine As Integer, _
	RxVolume As Integer, _
	TxVolume As Integer _
) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE
Visual C++
public:
VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetPhoneLineVolume(
	int PhoneLine, 
	int RxVolume, 
	int TxVolume
)
J#
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetPhoneLineVolume(
	int PhoneLine,
	int RxVolume,
	int TxVolume
)

Parameters

PhoneLine
Type: System..::.Int32
The zero based phone line index.
RxVolume
Type: System..::.Int32
Specifies the phone line receive volume. The value of this parameter can be in the range of 0 to MAX_VOLUME.
TxVolume
Type: System..::.Int32
Specifies the phone line transmit volume. The value of this parameter can be in the range of 0 to MAX_VOLUME.

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)

Remarks

None.

See Also