mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-02-06 04:00:08 +00:00
Code Activity

Update comment on estimatedSamplesPerBlock parameter used in the prepareToPlay method

Browse source
This commit is contained in:
hogliux 2016-04-21 09:04:09 +01:00
parent 00dd576b21
commit 9da130c45e
1 changed files with 7 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

12
modules/juce_audio_processors/processors/juce_AudioProcessor.h
View file

@ -73,15 +73,17 @@ public:
or query the busArrangement member variable to find out the number of
channels your processBlock callback must process.
The estimatedSamplesPerBlock value is a HINT about the typical number of
samples that will be processed for each callback, but isn't any kind
of guarantee. The actual block sizes that the host uses may be different
each time the callback happens, and may be more or less than this value.
The maximumExpectedSamplesPerBlock value is a strong hint about the maximum
number of samples that will be provided in each block. You may want to use
this value to resize internal buffers. You should program defensively in
case a buggy host exceeds this value. The actual block sizes that the host
uses may be different each time the callback happens: completely variable
block sizes can be expected from some hosts.
@see busArrangement, getTotalNumInputChannels, getTotalNumOutputChannels
*/
virtual void prepareToPlay (double sampleRate,
int estimatedSamplesPerBlock) = 0;
int maximumExpectedSamplesPerBlock) = 0;
/** Called after playback has stopped, to let the filter free up any resources it
no longer needs.