AudioFrameInputNode AudioFrameInputNode AudioFrameInputNode AudioFrameInputNode AudioFrameInputNode Class

Definition

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 : sealed class AudioFrameInputNode : IClosable, IAudioFrameInputNode, IAudioInputNode, IAudioInputNode2, IAudioNode
struct winrt::Windows::Media::Audio::AudioFrameInputNode : IClosable, IAudioFrameInputNode, IAudioInputNode, IAudioInputNode2, IAudioNode
public sealed class AudioFrameInputNode : IDisposable, IAudioFrameInputNode, IAudioInputNode, IAudioInputNode2, IAudioNode
Public NotInheritable Class AudioFrameInputNode Implements IDisposable, IAudioFrameInputNode, IAudioInputNode, IAudioInputNode2, IAudioNode
// This class does not provide a public constructor.
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 CreateFrameInputNode.

Properties

ConsumeInput ConsumeInput ConsumeInput ConsumeInput ConsumeInput

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

EffectDefinitions EffectDefinitions EffectDefinitions EffectDefinitions 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 Emitter Emitter Emitter 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 EncodingProperties EncodingProperties EncodingProperties EncodingProperties

Gets the encoding properties for the audio frame input node.

OutgoingConnections OutgoingConnections OutgoingConnections OutgoingConnections OutgoingConnections

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

OutgoingGain OutgoingGain OutgoingGain OutgoingGain OutgoingGain

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

PlaybackSpeedFactor PlaybackSpeedFactor PlaybackSpeedFactor PlaybackSpeedFactor PlaybackSpeedFactor

Gets or sets the playback speed factor for the audio frame input node.

QueuedSampleCount QueuedSampleCount QueuedSampleCount QueuedSampleCount QueuedSampleCount

Gets the queued sample count for the audio frame input node.

Methods

AddFrame(AudioFrame) AddFrame(AudioFrame) AddFrame(AudioFrame) AddFrame(AudioFrame) AddFrame(AudioFrame)

Adds an audio frame to the audio frame input node.

AddOutgoingConnection(IAudioNode) AddOutgoingConnection(IAudioNode) AddOutgoingConnection(IAudioNode) AddOutgoingConnection(IAudioNode) AddOutgoingConnection(IAudioNode)

Adds an outgoing connection to the audio frame input node.

AddOutgoingConnection(IAudioNode, Double) AddOutgoingConnection(IAudioNode, Double) AddOutgoingConnection(IAudioNode, Double) AddOutgoingConnection(IAudioNode, Double) AddOutgoingConnection(IAudioNode, Double)

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

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

Closes the audio frame input node and disposes of associated resources.

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

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

DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames() DiscardQueuedFrames()

Removes queued frames from the audio frame input node.

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

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

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

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

RemoveOutgoingConnection(IAudioNode) RemoveOutgoingConnection(IAudioNode) RemoveOutgoingConnection(IAudioNode) RemoveOutgoingConnection(IAudioNode) RemoveOutgoingConnection(IAudioNode)

Removes the outgoing connection from the audio frame input node to the specified node.

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

Resets the audio frame input node.

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

Starts the audio frame input node.

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

Stops the audio frame input node.

Events

AudioFrameCompleted AudioFrameCompleted AudioFrameCompleted AudioFrameCompleted AudioFrameCompleted

Notifies of a completed audio frame that has been submitted to the graph with a call to AddFrame.

QuantumStarted QuantumStarted QuantumStarted QuantumStarted QuantumStarted

Raised when the audio graph is ready to begin processing a new quantum of data.

See Also