From dfa94c8425ad815c144e18a12f34c8daa02eff68 Mon Sep 17 00:00:00 2001 From: Tom Poole Date: Tue, 16 Jan 2018 12:10:04 +0000 Subject: [PATCH] Added some documentation to the AudioProcessorValueTreeState class --- .../utilities/juce_AudioProcessorValueTreeState.h | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h index 501d8f4a7e..cf1983d3cd 100644 --- a/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h +++ b/modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h @@ -137,6 +137,10 @@ public: from a different thread (getStateInformation is a good example). This method flushes all pending audio parameter value updates and returns a copy of the state in a thread safe way. + + Note: This method uses locks to synchronise thread access, so whilst it is + thread-safe, it is not realtime-safe. Do not call this method from within + your audio processing code! */ ValueTree copyState(); @@ -146,6 +150,10 @@ public: message thread, but there may be cases when you may want to modify the state from a different thread (setStateInformation is a good example). This method allows you to replace the state in a thread safe way. + + Note: This method uses locks to synchronise thread access, so whilst it is + thread-safe, it is not realtime-safe. Do not call this method from within + your audio processing code! */ void replaceState (const ValueTree& newState);