AudioFileOutputNode AudioFileOutputNode AudioFileOutputNode AudioFileOutputNode Class

Definition

Represents an audio file output node.

public : sealed class AudioFileOutputNode : IClosable, IAudioFileOutputNode, IAudioNodepublic sealed class AudioFileOutputNode : IDisposable, IAudioFileOutputNode, IAudioNodePublic NotInheritable Class AudioFileOutputNode Implements IDisposable, IAudioFileOutputNode, IAudioNode// You can use this class in JavaScript.
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 AudioGraph::CreateFileOutputNodeAsync and then accessing the CreateFileOutputNodeResult::FileOutputNode property.

Properties

ConsumeInput ConsumeInput ConsumeInput ConsumeInput

Gets or sets a value indicating if the audio file output 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 file output node consumes input, and false otherwise.

EffectDefinitions EffectDefinitions EffectDefinitions EffectDefinitions

Gets the list of effect definitions for the audio file output 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

EncodingProperties EncodingProperties EncodingProperties EncodingProperties

Gets the encoding properties for the audio file output node.

public : AudioEncodingProperties EncodingProperties { get; }public AudioEncodingProperties EncodingProperties { get; }Public ReadOnly Property EncodingProperties As AudioEncodingProperties// You can use this property in JavaScript.

File File File File

Gets the file associated with the audio file output node.

public : IStorageFile File { get; }public IStorageFile File { get; }Public ReadOnly Property File As IStorageFile// You can use this property in JavaScript.
Value
IStorageFile IStorageFile IStorageFile IStorageFile

A StorageFile object representing the file.

FileEncodingProfile FileEncodingProfile FileEncodingProfile FileEncodingProfile

Gets the file encoding profile supported by the audio file output node.

public : MediaEncodingProfile FileEncodingProfile { get; }public MediaEncodingProfile FileEncodingProfile { get; }Public ReadOnly Property FileEncodingProfile As MediaEncodingProfile// You can use this property in JavaScript.

OutgoingGain OutgoingGain OutgoingGain OutgoingGain

Gets or sets the outgoing gain for the audio file output 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

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

Closes the audio file output 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.
Parameters
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.
Parameters
definition
IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition IAudioEffectDefinition

The effect definition of the effects to enable.

FinalizeAsync() FinalizeAsync() FinalizeAsync() FinalizeAsync()

Finalizes the asynchronous operation of the audio file output node.

public : IAsyncOperation<TranscodeFailureReason> FinalizeAsync()public IAsyncOperation<TranscodeFailureReason> FinalizeAsync()Public Function FinalizeAsync() As IAsyncOperation( Of TranscodeFailureReason )// You can use this method in JavaScript.
Returns

Remarks

You must call the AudioFileOutputNode.Stop method to stop the node before calling FinalizeAsync or an exception will be thrown.

Upon completion of FinalizeAsync, this node transitions itself into the closed state. Further calls into this node will result in a RO_E_CLOSED exception.

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

Resets the audio file output 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 file output 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 file output 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.