Share via

AudioEffect Class

Definition

Namespace:
Windows.Media.Effects
Edit

Represents an audio effect.

public ref class AudioEffect sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
class AudioEffect final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.MTA)]
public sealed class AudioEffect
Public NotInheritable Class AudioEffect
Inheritance
Object Platform::Object IInspectable AudioEffect
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Windows requirements

Device family
Windows 10 (introduced in 10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced in v1.0)

Remarks

The AudioCaptureEffectsManager and AudioRenderEffectsManager classes can be used to discover the audio processing chain on a device.

See the Audio effects discovery sample for an example of how to query and monitor audio effects on render and capture audio devices.

Properties

AcousticEchoCancellationConfiguration

Gets the AcousticEchoCancellationConfiguration associated with the audio effect.
AudioEffectType

Gets the type of the audio effect.
CanSetState

Gets a boolean value indicating whether the audio effect supports setting its internal state with a call to <Windows.Media.Effects.AudioEffect.SetState(Windows.Media.Effects.AudioEffectState)>.
State

Gets the current state of the audio effect.

Methods

SetState(AudioEffectState)

Sets the current state of the audio effect.

Applies to

See also