Share via

IUccAudioVideoSession.AcousticEchoCancellationEnabled Property

  • Article

This content is no longer actively maintained. It is provided as is, for anyone who may still be using these technologies, with no warranties or claims of accuracy with regard to the most recent product version or service release.

Gets and sets the current value for the flag to enable acoustic echo cancellation.

Namespace: Microsoft.Office.Interop.UccApi
Assembly: Microsoft.Office.Interop.UccApi (in microsoft.office.interop.uccapi.dll)

Syntax

'Declaration
Property AcousticEchoCancellationEnabled As Boolean

bool AcousticEchoCancellationEnabled { get; set; }

property bool AcousticEchoCancellationEnabled {
    bool get ();
    void set (bool value);
}

/** @property */
boolean get_AcousticEchoCancellationEnabled ()

/** @property */
void set_AcousticEchoCancellationEnabled (boolean value)

function get AcousticEchoCancellationEnabled () : boolean

function set AcousticEchoCancellationEnabled (value : boolean)

Property Value

A value of the VARIANT_BOOL* (bool, for a .NET application) type.

Remarks

Acoustic echo cancellation is enabled if this flag is TRUE. It is disabled if this flag is FALSE.

Win32 COM/C++ Syntax

HRESULT get_AcousticEchoCancellationEnabled
(
   VARIANT_BOOL* pvbEnableAEC
);
HRESULT put_AcousticEchoCancellationEnabled
(
   VARIANT_BOOL pvbEnableAEC
);

Note

In a Win32 application, the return value of a method or property is always an HRESULT value indicating the status of the call to the interface member. Any result of the operation is returned as a parameter marked with the [out, retval] attribute. In contrast, in a .NET application the HRESULT value indicating an error condition is returned as a COM exception and the [out, retval] parameter becomes the return value. For the UCC API-defined HRESULT values, see Trace and Handle Errors in Unified Communications Client API.

Thread Safety

All public static (Shared in Visual Basic) members of this type are thread-safe. Instance members are not guaranteed to be thread-safe.

Platforms

Development Platforms

Windows XP Professional with Service Pack 2 (SP2), Windows Server 2000 with Service Pack 4, Windows Server 2003, Windows Vista Ultimate Edition, Windows Vista Business Edition, Windows Vista Enterprise Edition

Target Platforms

See Also

Reference

IUccAudioVideoSession Interface
IUccAudioVideoSession Members
Microsoft.Office.Interop.UccApi Namespace