The SetMuteReceivedPhoneLineAudio procedure can be used to mute received phone line audio. If phone
line audio is muted for a phone line, the received phone call audio will not be played back on local
multimedia hardware.
Namespace:
LanScapeNote: |
---|
Multimedia hardware support must be enabled in the media engine for received phone call audio to be played back and to be audible. |
Assembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetMuteReceivedPhoneLineAudio( int PhoneLine, bool EnableState ) |
Visual Basic (Declaration) |
---|
Public Function SetMuteReceivedPhoneLineAudio ( _ PhoneLine As Integer, _ EnableState As Boolean _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
Visual C++ |
---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetMuteReceivedPhoneLineAudio( int PhoneLine, bool EnableState ) |
J# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetMuteReceivedPhoneLineAudio( int PhoneLine, boolean EnableState ) |
Parameters
- PhoneLine
- Type: System..::.Int32
The zero based phone line that will have its mute setting modified.
- EnableState
- Type: System..::.Boolean
This value determines if the received phone call audio will be muted. Set this parameter to a non zero value to mute all received phone call audio. Set this parameter to zero to "un mute" received phone call audio.
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 Value | Description |
---|---|
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.