FrameInputNodeQuantumStartedEventArgs FrameInputNodeQuantumStartedEventArgs FrameInputNodeQuantumStartedEventArgs FrameInputNodeQuantumStartedEventArgs Class

Definition

Provides data for the AudioFrameInputNode::QuantumStarted event. This event is raised when the audio graph containing the audio frame input node is ready to begin processing a new quantum of data.

public : sealed class FrameInputNodeQuantumStartedEventArgs : IFrameInputNodeQuantumStartedEventArgspublic sealed class FrameInputNodeQuantumStartedEventArgs : IFrameInputNodeQuantumStartedEventArgsPublic NotInheritable Class FrameInputNodeQuantumStartedEventArgs Implements IFrameInputNodeQuantumStartedEventArgs// 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 handling the AudioFrameInputNode.QuantumStarted event.

Properties

RequiredSamples RequiredSamples RequiredSamples RequiredSamples

Gets the number of samples that the audio graph requires to fill the quantum with data.

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

The number of samples that the audio graph requires to fill the quantum with data.

Remarks

Pass an AudioFrame into the AddFrame method to provide the required audio samples. It is recommended that you only submit the number of samples requested by the audio graph. Submitting extra samples can result in latency in the audio graph.

If the amount of data currently in the node is more than enough to fill one quantum, RequiredSamples will be 0.