IBasicAudioEffect IBasicAudioEffect IBasicAudioEffect IBasicAudioEffect Interface

Definition

The interface you implement to create a custom audio effect.

public : interface IBasicAudioEffectpublic interface IBasicAudioEffectPublic Interface IBasicAudioEffect// You can use this interface in JavaScript.
Inheritance
IBasicAudioEffectIBasicAudioEffectIBasicAudioEffectIBasicAudioEffect
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Inherited Members

Inherited methods

Properties

SupportedEncodingProperties SupportedEncodingProperties SupportedEncodingProperties SupportedEncodingProperties

Gets the encoding properties supported by the custom audio effect.

public : IVectorView<AudioEncodingProperties> SupportedEncodingProperties { get; }public IReadOnlyList<AudioEncodingProperties> SupportedEncodingProperties { get; }Public ReadOnly Property SupportedEncodingProperties As IReadOnlyList<AudioEncodingProperties>// You can use this property in JavaScript.
Value
IVectorView<AudioEncodingProperties> IReadOnlyList<AudioEncodingProperties> IReadOnlyList<AudioEncodingProperties> IReadOnlyList<AudioEncodingProperties>

A list of supported encoding properties.

UseInputFrameForOutput UseInputFrameForOutput UseInputFrameForOutput UseInputFrameForOutput

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

public : PlatForm::Boolean UseInputFrameForOutput { get; }public bool UseInputFrameForOutput { get; }Public ReadOnly Property UseInputFrameForOutput As bool// You can use this property in JavaScript.
Value
PlatForm::Boolean bool bool bool

True if the input frame is used for output; otherwise, false.

Methods

Close(MediaEffectClosedReason) Close(MediaEffectClosedReason) Close(MediaEffectClosedReason) Close(MediaEffectClosedReason)

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

public : void Close(MediaEffectClosedReason reason)public void Close(MediaEffectClosedReason reason)Public Function Close(reason As MediaEffectClosedReason) As void// You can use this method in JavaScript.
Parameters

DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames()

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

public : void DiscardQueuedFrames()public void DiscardQueuedFrames()Public Function DiscardQueuedFrames() As void// You can use this method in JavaScript.

ProcessFrame(ProcessAudioFrameContext) ProcessFrame(ProcessAudioFrameContext) ProcessFrame(ProcessAudioFrameContext) ProcessFrame(ProcessAudioFrameContext)

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

public : void ProcessFrame(ProcessAudioFrameContext context)public void ProcessFrame(ProcessAudioFrameContext context)Public Function ProcessFrame(context As ProcessAudioFrameContext) As void// You can use this method in JavaScript.
Parameters
context
ProcessAudioFrameContext ProcessAudioFrameContext ProcessAudioFrameContext ProcessAudioFrameContext

The context object that provides the input and output frames for the process operation.

SetEncodingProperties(AudioEncodingProperties) SetEncodingProperties(AudioEncodingProperties) SetEncodingProperties(AudioEncodingProperties) SetEncodingProperties(AudioEncodingProperties)

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

public : void SetEncodingProperties(AudioEncodingProperties encodingProperties)public void SetEncodingProperties(AudioEncodingProperties encodingProperties)Public Function SetEncodingProperties(encodingProperties As AudioEncodingProperties) As void// You can use this method in JavaScript.
Parameters

See Also