IBasicAudioEffect Interface

Definition

The interface you implement to create a custom audio effect.

public interface class IBasicAudioEffect : IMediaExtension
struct IBasicAudioEffect : IMediaExtension
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Guid(2349214803, 27584, 18616, 169, 154, 75, 65, 85, 15, 19, 89)]
public interface IBasicAudioEffect : IMediaExtension
Public Interface IBasicAudioEffect
Implements IMediaExtension
Attributes
Implements

Windows 10 requirements

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

Properties

SupportedEncodingProperties

Gets the encoding properties supported by the custom audio effect.

UseInputFrameForOutput

Gets a value that indicates whether the input frame is used for the output of the audio effect.

Methods

Close(MediaEffectClosedReason)

Called when the audio effect should close and clean up allocated resources.

DiscardQueuedFrames()

Called to allow audio effect implementations optionally discard any stored state related to samples that have already been received.

ProcessFrame(ProcessAudioFrameContext)

Called when samples are available for processing by a custom audio effect.

SetEncodingProperties(AudioEncodingProperties)

Called to set the encoding properties of a custom audio effect.

SetProperties(IPropertySet)

Sets the configuration properties that were supplied when the media parser or codec was registered.

(Inherited from IMediaExtension)

Applies to

See also