CaptureAcousticEchoCancellationEffect Class

Language:

Represents a Microsoft DirectSound capture effects object used to set and retrieve parameters on a capture buffer that supports acoustic echo cancellation. This object requires Microsoft Windows XP or later.

Definition

Visual Basic Public Class CaptureAcousticEchoCancellationEffect
Inherits MarshalByRefObject
Implements IDisposable

C# public class CaptureAcousticEchoCancellationEffect : MarshalByRefObject, IDisposable

C++ public ref class CaptureAcousticEchoCancellationEffect : MarshalByRefObject, IDisposable

JScript public class CaptureAcousticEchoCancellationEffect extends MarshalByRefObject implements IDisposable

Visual Basic	Public Class CaptureAcousticEchoCancellationEffect Inherits MarshalByRefObject Implements IDisposable
C#	public class CaptureAcousticEchoCancellationEffect : MarshalByRefObject, IDisposable
C++	public ref class CaptureAcousticEchoCancellationEffect : MarshalByRefObject, IDisposable
JScript	public class CaptureAcousticEchoCancellationEffect extends MarshalByRefObject implements IDisposable

Members Table

The following table lists the members exposed by the object. Click a tab on the left to choose the type of member you want to view.

Events

Event Description

Disposing Occurs when the Dispose method is called or when the CaptureAcousticEchoCancellationEffect object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Methods

Method Description

Dispose Immediately releases the unmanaged resources used by the CaptureAcousticEchoCancellationEffect object.

Equals Returns a value that indicates whether the current instance is equal to a specified object.

Finalize Allows the CaptureAcousticEchoCancellationEffect object to free resources before it is destroyed by the garbage collector.

GetHashCode Returns the hash code for the current instance.

GetObjectByValue This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.

op_Equality Compares the current instance of a class to another instance to determine whether they are the same.

op_Inequality Compares the current instance of a class to another instance to determine whether they are different.

raise_Disposing Raises the CaptureAcousticEchoCancellationEffect.Disposing event when called from within a derived class.

Reset Resets the effect to its initial state.

Properties

Property Description

AllParameters Retrieves or sets capture acoustic echo cancellation parameters of a CaptureBuffer object.

Disposed Gets a value that indicates whether the object is disposed.

Status Retrieves the status of the capture acoustic echo cancellation effect.

Event	Description
Disposing	Occurs when the Dispose method is called or when the CaptureAcousticEchoCancellationEffect object is finalized and collected by the garbage collector of the Microsoft .NET common language runtime.

Method	Description
Dispose	Immediately releases the unmanaged resources used by the CaptureAcousticEchoCancellationEffect object.
Equals	Returns a value that indicates whether the current instance is equal to a specified object.
Finalize	Allows the CaptureAcousticEchoCancellationEffect object to free resources before it is destroyed by the garbage collector.
GetHashCode	Returns the hash code for the current instance.
GetObjectByValue	This member supports the infrastructure for Microsoft DirectX 9.0 for Managed Code and is not intended to be used directly from your code.
op_Equality	Compares the current instance of a class to another instance to determine whether they are the same.
op_Inequality	Compares the current instance of a class to another instance to determine whether they are different.
raise_Disposing	Raises the CaptureAcousticEchoCancellationEffect.Disposing event when called from within a derived class.
Reset	Resets the effect to its initial state.

Property	Description
AllParameters	Retrieves or sets capture acoustic echo cancellation parameters of a CaptureBuffer object.
Disposed	Gets a value that indicates whether the object is disposed.
Status	Retrieves the status of the capture acoustic echo cancellation effect.

Inheritance Hierarchy

Object
MarshalByRefObject
CaptureAcousticEchoCancellationEffect

Remarks

Obtain this object by calling the GetObjectInPath method of a CaptureBuffer object that is using the effect.

Class Information

Namespace Microsoft.DirectX.DirectSound

Assembly Microsoft.DirectX.DirectSound (microsoft.directx.directsound.dll)

Strong Name Microsoft.DirectX.DirectSound, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Namespace	Microsoft.DirectX.DirectSound
Assembly	Microsoft.DirectX.DirectSound (microsoft.directx.directsound.dll)
Strong Name	Microsoft.DirectX.DirectSound, Version=1.0.900.0, Culture=neutral, PublicKeyToken=d3231b57b74a1492

Feedback? Please provide us with your comments on this topic.
For more help, visit the DirectX Developer Center