The SetLocalAudioLoopback API procedure is used to enable and disable the loop back of locally recorded audio data to the media engine's local audio playback path. If loop back is enabled, recorded audio samples are sent directly to the internal telephony engine playback subsystem.
Namespace:
LanScapeLocal audio loopback is disabled by default.
Assembly: LMEVoipManaged (in LMEVoipManaged.dll) Version: 6.0.5226.26700
Syntax
C# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetLocalAudioLoopback( bool EnableState ) |
Visual Basic (Declaration) |
---|
Public Function SetLocalAudioLoopback ( _ EnableState As Boolean _ ) As VoipMediaEngine..::.TELEPHONY_RETURN_VALUE |
Visual C++ |
---|
public: VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetLocalAudioLoopback( bool EnableState ) |
J# |
---|
public VoipMediaEngine..::.TELEPHONY_RETURN_VALUE SetLocalAudioLoopback( boolean EnableState ) |
Parameters
- EnableState
- Type: System..::.Boolean
If TRUE, locally recorded audio is played back immediately. If FALSE, local audio loop back is disabled.
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) |
Remarks
None.