AudioDeviceOutputNode AudioDeviceOutputNode AudioDeviceOutputNode AudioDeviceOutputNode Class

Definition

Represents an audio device output node.

public : sealed class AudioDeviceOutputNode : IClosable, IAudioDeviceOutputNode, IAudioNode, IAudioNodeWithListenerpublic sealed class AudioDeviceOutputNode : IDisposable, IAudioDeviceOutputNode, IAudioNode, IAudioNodeWithListenerPublic NotInheritable Class AudioDeviceOutputNode Implements IDisposable, IAudioDeviceOutputNode, IAudioNode, IAudioNodeWithListener// You can use this class in JavaScript.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

Get an instance of this class by calling AudioGraph::CreateDeviceOutputNodeAsync and then accessing the CreateAudioDeviceOutputNodeResult::DeviceOutputNode property.

Properties

ConsumeInput ConsumeInput ConsumeInput ConsumeInput

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

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

True if the audio device output node consumes input, and false otherwise.

Device Device Device Device

Gets information about the audio device.

public : DeviceInformation Device { get; }public DeviceInformation Device { get; }Public ReadOnly Property Device As DeviceInformation// You can use this property in JavaScript.

EffectDefinitions EffectDefinitions EffectDefinitions EffectDefinitions

Gets the list of effect definitions for the audio device output node.

public : IVector<IAudioEffectDefinition> EffectDefinitions { get; }public IList<IAudioEffectDefinition> EffectDefinitions { get; }Public ReadOnly Property EffectDefinitions As IList<IAudioEffectDefinition>// You can use this property in JavaScript.
Value
IVector<IAudioEffectDefinition> IList<IAudioEffectDefinition> IList<IAudioEffectDefinition> IList<IAudioEffectDefinition>

The list of effect definitions for the node.

See Also

EncodingProperties EncodingProperties EncodingProperties EncodingProperties

Gets the encoding properties for the audio device output node.

public : AudioEncodingProperties EncodingProperties { get; }public AudioEncodingProperties EncodingProperties { get; }Public ReadOnly Property EncodingProperties As AudioEncodingProperties// You can use this property in JavaScript.

Listener Listener Listener 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.

public : AudioNodeListener Listener { get; set; }public AudioNodeListener Listener { get; set; }Public ReadWrite Property Listener As AudioNodeListener// You can use this property in JavaScript.
Value
AudioNodeListener AudioNodeListener AudioNodeListener AudioNodeListener

The spatial audio listener associated with the AudioDeviceInputNode.

Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

OutgoingGain OutgoingGain OutgoingGain OutgoingGain

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

public : double OutgoingGain { get; set; }public double OutgoingGain { get; set; }Public ReadWrite Property OutgoingGain As double// You can use this property in JavaScript.
Value
double double double double

The outgoing gain value.

Methods

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

Closes the audio device output node.

public : void Close()This member is not implemented in C#This member is not implemented in VB.Net// You can use this method in JavaScript.

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

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

public : void DisableEffectsByDefinition(IAudioEffectDefinition definition)public void DisableEffectsByDefinition(IAudioEffectDefinition definition)Public Function DisableEffectsByDefinition(definition As IAudioEffectDefinition) As void// You can use this method in JavaScript.
Parameters
definition
IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition

The effect definition of the effects to disable.

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

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

This member is not implemented in C++void Dispose()Sub Disposevoid Dispose()

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

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

public : void EnableEffectsByDefinition(IAudioEffectDefinition definition)public void EnableEffectsByDefinition(IAudioEffectDefinition definition)Public Function EnableEffectsByDefinition(definition As IAudioEffectDefinition) As void// You can use this method in JavaScript.
Parameters
definition
IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition

The effect definition of the effects to enable.

Reset() Reset() Reset() Reset()

Resets the audio device output node.

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

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

Starts the audio device output node.

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

Remarks

Audio graph nodes are created in the started state by default and will start processing audio when AudioGraph.Start is called. This method will restart processing for a node that was stopped with a call to Stop.

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

Stops the audio device output node.

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

Remarks

To stop all processing for all nodes of the graph, call AudioGraph.Stop.