AudioFileInputNode AudioFileInputNode AudioFileInputNode AudioFileInputNode AudioFileInputNode Class

Definition

Namespace:
Windows.Media.Audio Windows.Media.Audio Windows.Media.Audio Windows.Media.Audio Windows.Media.Audio
Assemblies:
Windows.Media.Audio.dll, Windows.dll
Edit

Represents a node in an audio graph node that inputs audio data into the graph from an audio file.

public : sealed class AudioFileInputNode : IClosable, IAudioInputNode, IAudioInputNode2, IAudioNode
struct winrt::Windows::Media::Audio::AudioFileInputNode : IClosable, IAudioInputNode, IAudioInputNode2, IAudioNode
public sealed class AudioFileInputNode : IDisposable, IAudioInputNode, IAudioInputNode2, IAudioNode
Public NotInheritable Class AudioFileInputNode Implements IDisposable, IAudioInputNode, IAudioInputNode2, IAudioNode
// This class does not provide a public constructor.
Attributes
ContractVersionAttribute DualApiPartitionAttribute MarshalingBehaviorAttribute ThreadingAttribute

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 AudioGraph.CreateFileInputNodeAsync and then accessing the CreateFileInputNodeResult.FileInputNode property.

The MediaSourceAudioInputNode is another way of inputing audio data from a file into a graph. The MediaSource class also allows you to use other sources of audio, such as a network stream.

Version history

Windows version SDK version Value added
1607 14393 Emitter

Properties

ConsumeInput ConsumeInput ConsumeInput ConsumeInput ConsumeInput

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

Gets the duration for the audio input file.
EffectDefinitions EffectDefinitions EffectDefinitions EffectDefinitions EffectDefinitions

Gets the list of effect definitions for the audio file 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 AudioFileInputNode audio is emitted when spatial audio processing is used.
EncodingProperties EncodingProperties EncodingProperties EncodingProperties EncodingProperties

Gets the encoding properties for the audio file input node.
EndTime EndTime EndTime EndTime EndTime

Gets or sets the end time for the audio file input node, which determines when playback of the media content ends.
LoopCount LoopCount LoopCount LoopCount LoopCount

Gets or sets the loop count of the audio file input node.
OutgoingConnections OutgoingConnections OutgoingConnections OutgoingConnections OutgoingConnections

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

Gets or sets the outgoing gain for the audio file input node.
PlaybackSpeedFactor PlaybackSpeedFactor PlaybackSpeedFactor PlaybackSpeedFactor PlaybackSpeedFactor

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

Gets the playback position of the audio file input node.
SourceFile SourceFile SourceFile SourceFile SourceFile

Gets the source audio file for the audio file input node.
StartTime StartTime StartTime StartTime StartTime

Gets or sets the start time for the audio file input node.

Methods

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

Adds an outgoing connection to the audio file 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 file input node.
Close() Close() Close() Close() Close()

Closes the audio file 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.
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 file input node to the specified node.
Reset() Reset() Reset() Reset() Reset()

Resets the audio file input node.
Seek(TimeSpan) Seek(TimeSpan) Seek(TimeSpan) Seek(TimeSpan) Seek(TimeSpan)

Moves the playback position of the node to the specified time within the audio input file.
Start() Start() Start() Start() Start()

Starts the audio file input node.
Stop() Stop() Stop() Stop() Stop()

Stops the audio file input node.

Events

FileCompleted FileCompleted FileCompleted FileCompleted FileCompleted

Occurs when the playback position reaches the end of the audio file or the position specified with the EndTime property.

See also