Browse Source

Added some documentation to the AudioProcessorValueTreeState class

tags/2021-05-28
Tom Poole 7 years ago
parent
commit
dfa94c8425
1 changed files with 8 additions and 0 deletions
  1. +8
    -0
      modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h

+ 8
- 0
modules/juce_audio_processors/utilities/juce_AudioProcessorValueTreeState.h View File

@@ -137,6 +137,10 @@ public:
from a different thread (getStateInformation is a good example). This method from a different thread (getStateInformation is a good example). This method
flushes all pending audio parameter value updates and returns a copy of the flushes all pending audio parameter value updates and returns a copy of the
state in a thread safe way. 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(); ValueTree copyState();
@@ -146,6 +150,10 @@ public:
message thread, but there may be cases when you may want to modify the state 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 from a different thread (setStateInformation is a good example). This method
allows you to replace the state in a thread safe way. 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); void replaceState (const ValueTree& newState);


Loading…
Cancel
Save