FrameInputNodeQuantumStartedEventArgs.RequiredSamples Property
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.
Gets the number of samples that the audio graph requires to fill the quantum with data.
public:
property int RequiredSamples { int get(); };int RequiredSamples();public int RequiredSamples { get; }var int32 = frameInputNodeQuantumStartedEventArgs.requiredSamples;Public ReadOnly Property RequiredSamples As IntegerProperty Value
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.
Note that the count returned by this property represents the required number of audio frames to fill the quantum. The number of samples required depends on the number of channels in the audio encoding settings. For example, for 2-channel audio the required number of samples is actually twice the value returned by this property.