AudioSubmixNode Class

Definition

Represents an audio submix node that mixes the output of one or more nodes into single output that can be connected to output nodes or other submix nodes.

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

Version history

Windows version SDK version Value added
1607 14393 Emitter

Properties

ConsumeInput

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

EffectDefinitions

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

Emitter

Gets the AudioNodeEmitter that describes the position and other physical characteristics of the emitter from which the AudioSubmixNode output audio is emitted when spatial audio processing is used.

EncodingProperties

Gets the encoding properties for the audio device submix node.

OutgoingConnections

Gets outgoing connections from the audio submix node to other nodes in the audio graph.

OutgoingGain

Gets or sets the outgoing gain for the audio submix node.

Methods

AddOutgoingConnection(IAudioNode)

Adds an outgoing connection to the audio submix node.

AddOutgoingConnection(IAudioNode, Double)

Adds an outgoing connection with gain to the audio submix node.

Close()

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

RemoveOutgoingConnection(IAudioNode)

Removes the outgoing connection from the audio submix node to the specified node.

Reset()

Resets the audio submix node.

Start()

Starts the audio submix node.

Stop()

Stops the audio submix node.

Applies to

See also