AudioFrameOutputNode Class

  • Reference

Definition

Namespace:
Windows.Media.Audio
Edit

Represents a node in an audio graph node that outputs audio data from the graph into app-implemented code.

public ref class AudioFrameOutputNode sealed : IClosable
/// [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.Both)]
class AudioFrameOutputNode final : IClosable
[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.Both)]
public sealed class AudioFrameOutputNode : System.IDisposable
Public NotInheritable Class AudioFrameOutputNode
Implements IDisposable
Inheritance
Object Platform::Object IInspectable AudioFrameOutputNode
Attributes
ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute
Implements
IClosable IDisposable IAudioNode

Windows requirements

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

Remarks

Get an instance of this class by calling CreateFrameOutputNode.

Properties

ConsumeInput

Gets or sets a value indicating if the audio frame output node consumes input.
EffectDefinitions

Gets the list of effect definitions for the audio frame output node. The effects in the list process audio data that flows through the node in the order in which they appear in the list.
EncodingProperties

Gets the encoding properties for the audio frame output node.
OutgoingGain

Gets or sets the outgoing gain for the audio frame output node.

Methods

Close()

Closes the audio frame output node and disposes of associated resources.
DisableEffectsByDefinition(IAudioEffectDefinition)

Disables all effects in the EffectDefinitions list with the specified effect definition.
Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
EnableEffectsByDefinition(IAudioEffectDefinition)

Enables all effects in the EffectDefinitions list with the specified effect definition.
GetFrame()

Gets an audio frame containing all of the data accumulated by this node since the previous call to GetFrame. If GetFrame has not yet been called, the audio frame will contain all of the data accumulated since the node was created.
Reset()

Resets the audio frame output node.
Start()

Starts the audio frame output node.
Stop()

Stops the audio frame output node.

Applies to

See also