mirror/JUCE
1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
Code Activity

Updated the documentation AudioProcessorValueTreeState::Listener::parameterChanged() to clarify that retrieving the value of the parameter that has changed via the other AudioProcessorValueTreeState methods whilst within the callback is not guaranteed to return an up-to-date value

Browse source
This commit is contained in:
ed 2019-02-20 09:25:48 +00:00
parent 6bf6aa1761
commit 548838e139
1 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

14
modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h
View file

@ -279,8 +279,11 @@ public:
/** Returns a parameter by its ID string. */
RangedAudioParameter* getParameter (StringRef parameterID) const noexcept;
/** Returns a pointer to a floating point representation of a particular
parameter which a realtime process can read to find out its current value.
/** Returns a pointer to a floating point representation of a particular parameter which a realtime
process can read to find out its current value.
Note that calling this method from within AudioProcessorValueTreeState::Listener::parameterChanged()
is not guaranteed to return an up-to-date value for the parameter.
*/
float* getRawParameterValue (StringRef parameterID) const noexcept;
@ -292,7 +295,12 @@ public:
{
virtual ~Listener() = default;
/** This callback method is called by the AudioProcessorValueTreeState when a parameter changes. */
/** This callback method is called by the AudioProcessorValueTreeState when a parameter changes.
Within this call, retrieving the value of the parameter that has changed via the getRawParameterValue()
or getParameter() methods is not guaranteed to return the up-to-date value. If you need this you should
instead use the newValue parameter.
*/
virtual void parameterChanged (const String& parameterID, float newValue) = 0;
};