AudioDeviceOutputNode Class

Definition

Represents a node in an audio graph node that outputs audio data from the graph to an audio device such as a speaker or external audio interface.

public ref class AudioDeviceOutputNode sealed : IClosable
public ref class AudioDeviceOutputNode sealed : IClosable, IAudioNodeWithListener
/// [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 AudioDeviceOutputNode final : 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 AudioDeviceOutputNode final : IClosable, IAudioNodeWithListener
[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 AudioDeviceOutputNode : System.IDisposable
[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 AudioDeviceOutputNode : System.IDisposable, IAudioNodeWithListener
Public NotInheritable Class AudioDeviceOutputNode
Implements IDisposable
Public NotInheritable Class AudioDeviceOutputNode
Implements IAudioNodeWithListener, IDisposable
Inheritance
Object IInspectable AudioDeviceOutputNode
Attributes
Implements

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 AudioGraph.CreateDeviceOutputNodeAsync and then accessing the CreateAudioDeviceOutputNodeResult.DeviceOutputNode property.

Version history

Windows version SDK version Value added
1607 14393 Listener

Properties

ConsumeInput

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

Device

Gets information about the audio device.

EffectDefinitions

Gets the list of effect definitions for the audio device 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 device output node.

Listener

Gets or sets the AudioNodeListener that describes the position and other characteristics of the listener from which the AudioDeviceOutputNode audio is heard when spatial audio processing is used.

OutgoingGain

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

Methods

Close()

Closes the audio device 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.

Reset()

Resets the audio device output node.

Start()

Starts the audio device output node.

Stop()

Stops the audio device output node.

Applies to

See also