AudioDeviceInputNode
AudioDeviceInputNode
AudioDeviceInputNode
AudioDeviceInputNode
Class
Definition
Represents an audio device input node.
public : sealed class AudioDeviceInputNode : IClosable, IAudioDeviceInputNode, IAudioInputNode, IAudioInputNode2, IAudioNodepublic sealed class AudioDeviceInputNode : IDisposable, IAudioDeviceInputNode, IAudioInputNode, IAudioInputNode2, IAudioNodePublic NotInheritable Class AudioDeviceInputNode Implements IDisposable, IAudioDeviceInputNode, IAudioInputNode, IAudioInputNode2, IAudioNode// You can use this class in JavaScript.
- Attributes
| 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::CreateDeviceInputNodeAsync and then accessing the CreateAudioDeviceInputNodeResult::DeviceInputNode property.
Properties
ConsumeInput ConsumeInput ConsumeInput ConsumeInput
Gets or sets a value indicating if the audio device input 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 input 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.
A DeviceInformation object representing the device.
EffectDefinitions EffectDefinitions EffectDefinitions EffectDefinitions
Gets the list of effect definitions for the audio device input 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
Emitter Emitter Emitter 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.
public : AudioNodeEmitter Emitter { get; }public AudioNodeEmitter Emitter { get; }Public ReadOnly Property Emitter As AudioNodeEmitter// You can use this property in JavaScript.
The spatial audio emitter associated with the AudioDeviceInputNode.
| Device family |
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced v3)
|
Remarks
Create an AudioDeviceInputNode with an AudioNodeEmitter by calling the overload of CreateDeviceInputNodeAsync that accepts an emitter as an argument.
EncodingProperties EncodingProperties EncodingProperties EncodingProperties
Gets the encoding properties for the audio device input node.
public : AudioEncodingProperties EncodingProperties { get; }public AudioEncodingProperties EncodingProperties { get; }Public ReadOnly Property EncodingProperties As AudioEncodingProperties// You can use this property in JavaScript.
- Value
- AudioEncodingProperties AudioEncodingProperties AudioEncodingProperties AudioEncodingProperties
The encoding properties for the node.
OutgoingConnections OutgoingConnections OutgoingConnections OutgoingConnections
Gets the list of outgoing connections from the audio device input node to other nodes in the audio graph.
public : IVectorView<AudioGraphConnection> OutgoingConnections { get; }public IReadOnlyList<AudioGraphConnection> OutgoingConnections { get; }Public ReadOnly Property OutgoingConnections As IReadOnlyList<AudioGraphConnection>// You can use this property in JavaScript.
- Value
- IVectorView<AudioGraphConnection> IReadOnlyList<AudioGraphConnection> IReadOnlyList<AudioGraphConnection> IReadOnlyList<AudioGraphConnection>
A collection of AudioGraphConnection objects representing the supported connections.
OutgoingGain OutgoingGain OutgoingGain OutgoingGain
Gets or sets the outgoing gain for the audio device input 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
AddOutgoingConnection(IAudioNode) AddOutgoingConnection(IAudioNode) AddOutgoingConnection(IAudioNode) AddOutgoingConnection(IAudioNode)
Adds an outgoing connection to the audio device input node.
public : void AddOutgoingConnection(IAudioNode destination)public void AddOutgoingConnection(IAudioNode destination)Public Function AddOutgoingConnection(destination As IAudioNode) As void// You can use this method in JavaScript.
- destination
- IAudioNode IAudioNode IAudioNode IAudioNode
The destination node for the connection.
- See Also
AddOutgoingConnection(IAudioNode, Double) AddOutgoingConnection(IAudioNode, Double) AddOutgoingConnection(IAudioNode, Double) AddOutgoingConnection(IAudioNode, Double)
Adds an outgoing connection with gain to the audio device input node.
public : void AddOutgoingConnection(IAudioNode destination, double gain)public void AddOutgoingConnection(IAudioNode destination, Double gain)Public Function AddOutgoingConnection(destination As IAudioNode, gain As Double) As void// You can use this method in JavaScript.
- destination
- IAudioNode IAudioNode IAudioNode IAudioNode
The destination node for the connection.
- gain
- double Double Double Double
A value indicating the gain associated with the connection.
- See Also
Close() Close() Close() Close()
Closes the audio device input 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.
- 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.
- definition
- IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition
The effect definition of the effects to enable.
RemoveOutgoingConnection(IAudioNode) RemoveOutgoingConnection(IAudioNode) RemoveOutgoingConnection(IAudioNode) RemoveOutgoingConnection(IAudioNode)
Removes the outgoing connection for the audio device input node.
public : void RemoveOutgoingConnection(IAudioNode destination)public void RemoveOutgoingConnection(IAudioNode destination)Public Function RemoveOutgoingConnection(destination As IAudioNode) As void// You can use this method in JavaScript.
- destination
- IAudioNode IAudioNode IAudioNode IAudioNode
The destination for the outgoing connection.
Reset() Reset() Reset() Reset()
Resets the audio device input 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 input 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 input 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.