AudioDeviceInputNode Class

Definition

Represents a node in an audio graph node that inputs audio data into the graph from an audio device such as a microphone or external audio interface.

public ref class AudioDeviceInputNode sealed : IClosable
public ref class AudioDeviceInputNode 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 AudioDeviceInputNode 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 AudioDeviceInputNode 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 AudioDeviceInputNode : 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 AudioDeviceInputNode : System.IDisposable, IAudioInputNode2
Public NotInheritable Class AudioDeviceInputNode
Implements IDisposable
Public NotInheritable Class AudioDeviceInputNode
Implements IAudioInputNode2, IDisposable
Inheritance
Object IInspectable AudioDeviceInputNode
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.CreateDeviceInputNodeAsync and then accessing the CreateAudioDeviceInputNodeResult.DeviceInputNode property.

Version history

Windows version SDK version Value added
1607 14393 Emitter

Properties

ConsumeInput

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

Device

Gets information about the audio device.

EffectDefinitions

Gets the list of effect definitions for the audio device input 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 AudioDeviceInputNode audio is emitted when spatial audio processing is used.

EncodingProperties

Gets the encoding properties for the audio device input node.

OutgoingConnections

Gets the list of outgoing connections from the audio device input node to other nodes in the audio graph.

OutgoingGain

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

Methods

AddOutgoingConnection(IAudioNode)

Adds an outgoing connection to the audio device input node.

AddOutgoingConnection(IAudioNode, Double)

Adds an outgoing connection with gain to the audio device input node.

Close()

Closes the audio device input 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 device input node to the specified node.

Reset()

Resets the audio device input node.

Start()

Starts the audio device input node.

Stop()

Stops the audio device input node.

Applies to

See also