AudioFrameOutputNode AudioFrameOutputNode AudioFrameOutputNode AudioFrameOutputNode AudioFrameOutputNode Class


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

public : sealed class AudioFrameOutputNode : IClosable, IAudioNode
struct winrt::Windows::Media::Audio::AudioFrameOutputNode : IClosable, IAudioNode
public sealed class AudioFrameOutputNode : IDisposable, IAudioNode
Public NotInheritable Class AudioFrameOutputNode Implements IDisposable, IAudioNode
// This class does not provide a public constructor.

Windows 10 requirements

Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)


Get an instance of this class by calling CreateFrameOutputNode.


ConsumeInput ConsumeInput ConsumeInput ConsumeInput ConsumeInput

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

EffectDefinitions EffectDefinitions EffectDefinitions EffectDefinitions 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 EncodingProperties EncodingProperties EncodingProperties EncodingProperties

Gets the encoding properties for the audio frame output node.

OutgoingGain OutgoingGain OutgoingGain OutgoingGain OutgoingGain

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


Close() Close() Close() Close() Close()

Closes the audio frame output node and disposes of associated resources.

DisableEffectsByDefinition(IAudioEffectDefinition) DisableEffectsByDefinition(IAudioEffectDefinition) DisableEffectsByDefinition(IAudioEffectDefinition) DisableEffectsByDefinition(IAudioEffectDefinition) DisableEffectsByDefinition(IAudioEffectDefinition)

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

Dispose() Dispose() Dispose() Dispose() Dispose()

Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.

EnableEffectsByDefinition(IAudioEffectDefinition) EnableEffectsByDefinition(IAudioEffectDefinition) EnableEffectsByDefinition(IAudioEffectDefinition) EnableEffectsByDefinition(IAudioEffectDefinition) EnableEffectsByDefinition(IAudioEffectDefinition)

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

GetFrame() GetFrame() GetFrame() GetFrame() 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() Reset() Reset() Reset() Reset()

Resets the audio frame output node.

Start() Start() Start() Start() Start()

Starts the audio frame output node.

Stop() Stop() Stop() Stop() Stop()

Stops the audio frame output node.

See also