AudioFileInputNode Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Represents a node in an audio graph node that inputs audio data into the graph from an audio file.
public ref class AudioFileInputNode sealed : IClosablepublic ref class AudioFileInputNode 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 AudioFileInputNode 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 AudioFileInputNode 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 AudioFileInputNode : 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 AudioFileInputNode : System.IDisposable, IAudioInputNode2Public NotInheritable Class AudioFileInputNode
Implements IDisposablePublic NotInheritable Class AudioFileInputNode
Implements IAudioInputNode2, IDisposable- Inheritance
- 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.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 |
Gets or sets a value indicating if the audio file input node consumes input. |
| Duration |
Gets the duration for the audio input file. |
| 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 |
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 |
Gets the encoding properties for the audio file input node. |
| EndTime |
Gets or sets the end time for the audio file input node, which determines when playback of the media content ends. |
| LoopCount |
Gets or sets the loop count of the audio file input node. |
| OutgoingConnections |
Gets the list of outgoing connections from the audio file input node to other nodes in the audio graph. |
| OutgoingGain |
Gets or sets the outgoing gain for the audio file input node. |
| PlaybackSpeedFactor |
Gets or sets the playback speed factor for the audio file input node. |
| Position |
Gets the playback position of the audio file input node. |
| SourceFile |
Gets the source audio file for the audio file input node. |
| StartTime |
Gets or sets the start time for the audio file input node. |
Methods
| AddOutgoingConnection(IAudioNode, Double) |
Adds an outgoing connection with gain to the audio file input node. |
| AddOutgoingConnection(IAudioNode) |
Adds an outgoing connection to the audio file input node. |
| Close() |
Closes the audio file 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 file input node to the specified node. |
| Reset() |
Resets the audio file input node. |
| Seek(TimeSpan) |
Moves the playback position of the node to the specified time within the audio input file. |
| Start() |
Starts the audio file input node. |
| Stop() |
Stops the audio file input node. |
Events
| FileCompleted |
Occurs when the playback position reaches the end of the audio file or the position specified with the EndTime property. |