AudioFrameInputNode Class

Definition

Namespace:

Windows.Media.Audio

Represents a node in an audio graph node that inputs audio data into the graph from app-implemented code that generates audio samples programmatically.

public ref class AudioFrameInputNode 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 AudioFrameInputNode 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 AudioFrameInputNode : System.IDisposable, IAudioInputNode2

Public NotInheritable Class AudioFrameInputNode
Implements IAudioInputNode2, IDisposable

Inheritance

Object Platform::Object IInspectable AudioFrameInputNode

Attributes

ContractVersionAttribute MarshalingBehaviorAttribute ThreadingAttribute

Implements

IClosable IDisposable IAudioInputNode IAudioNode IAudioInputNode2

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

Version history

Windows version	SDK version	Value added
1607	14393	Emitter

Properties

ConsumeInput	Gets or sets a value indicating if the audio frame input node consumes input.
EffectDefinitions	Gets the list of effect definitions for the audio frame 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 AudioFrameInputNode audio is emitted when spatial audio processing is used.
EncodingProperties	Gets the encoding properties for the audio frame input node.
OutgoingConnections	Gets the list of outgoing connections from the audio frame input node to other nodes in the audio graph.
OutgoingGain	Gets or sets the outgoing gain for the audio frame input node.
PlaybackSpeedFactor	Gets or sets the playback speed factor for the audio frame input node.
QueuedSampleCount	Gets the queued sample count for the audio frame input node.

Methods

AddFrame(AudioFrame)	Adds an audio frame to the audio frame input node.
AddOutgoingConnection(IAudioNode)	Adds an outgoing connection to the audio frame input node.
AddOutgoingConnection(IAudioNode, Double)	Adds an outgoing connection with gain to the audio frame input node.
Close()	Closes the audio frame input node and disposes of associated resources.
DisableEffectsByDefinition(IAudioEffectDefinition)	Disables all effects in the EffectDefinitions list with the specified effect definition.
DiscardQueuedFrames()	Removes queued frames from the audio frame input node.
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 frame input node to the specified node.
Reset()	Resets the audio frame input node.
Start()	Starts the audio frame input node.
Stop()	Stops the audio frame input node.

Events

AudioFrameCompleted	Notifies of a completed audio frame that has been submitted to the graph with a call to AddFrame.
QuantumStarted	Raised when the audio graph is ready to begin processing a new quantum of data.

See also

• IAudioInputNode
• IAudioNode
• IClosable