JUCE
|
A parameter class that maintains backwards compatibility with deprecated AudioProcessorValueTreeState functionality. More...
Public Member Functions | |
Parameter (const String ¶meterID, const String ¶meterName, const String &labelText, NormalisableRange< float > valueRange, float defaultValue, std::function< String(float)> valueToTextFunction, std::function< float(const String &)> textToValueFunction, bool isMetaParameter=false, bool isAutomatableParameter=true, bool isDiscrete=false, AudioProcessorParameter::Category category=AudioProcessorParameter::genericParameter, bool isBoolean=false) | |
float | getDefaultValue () const override |
This should return the default value for this parameter. More... | |
int | getNumSteps () const override |
Returns the number of steps that this parameter's range should be quantised into. More... | |
bool | isMetaParameter () const override |
Should return true if this parameter is a "meta" parameter. More... | |
bool | isAutomatable () const override |
Returns true if the host can automate this parameter. More... | |
bool | isDiscrete () const override |
Returns whether the parameter uses discrete values, based on the result of getNumSteps, or allows the host to select values continuously. More... | |
bool | isBoolean () const override |
Returns whether the parameter represents a boolean switch, typically with "On" and "Off" states. More... | |
![]() | |
AudioParameterFloat (const String ¶meterID, const String &name, NormalisableRange< float > normalisableRange, float defaultValue, const String &label=String(), Category category=AudioProcessorParameter::genericParameter, std::function< String(float value, int maximumStringLength)> stringFromValue=nullptr, std::function< float(const String &text)> valueFromString=nullptr) | |
Creates a AudioParameterFloat with the specified parameters. More... | |
AudioParameterFloat (String parameterID, String name, float minValue, float maxValue, float defaultValue) | |
Creates a AudioParameterFloat with an ID, name, and range. More... | |
~AudioParameterFloat () | |
Destructor. More... | |
float | get () const noexcept |
Returns the parameter's current value. More... | |
operator float () const noexcept | |
Returns the parameter's current value. More... | |
AudioParameterFloat & | operator= (float newValue) |
Changes the parameter's current value. More... | |
const NormalisableRange< float > & | getNormalisableRange () const override |
Returns the range of values that the parameter can take. More... | |
![]() | |
RangedAudioParameter (const String ¶meterID, const String &name, const String &label={}, Category category=AudioProcessorParameter::genericParameter) | |
The creation of this object requires providing a name and ID which will be constant for its lifetime. More... | |
int | getNumSteps () const override |
Returns the number of steps for this parameter based on the normalisable range's interval. More... | |
float | convertTo0to1 (float v) const noexcept |
Normalises and snaps a value based on the normalisable range. More... | |
float | convertFrom0to1 (float v) const noexcept |
Denormalises and snaps a value based on the normalisable range. More... | |
![]() | |
AudioProcessorParameterWithID (const String ¶meterID, const String &name, const String &label=String(), Category category=AudioProcessorParameter::genericParameter) | |
The creation of this object requires providing a name and ID which will be constant for its lifetime. More... | |
~AudioProcessorParameterWithID () | |
Destructor. More... | |
![]() | |
AudioProcessorParameter () noexcept | |
virtual | ~AudioProcessorParameter () |
Destructor. More... | |
void | setValueNotifyingHost (float newValue) |
A processor should call this when it needs to change one of its parameters. More... | |
void | beginChangeGesture () |
Sends a signal to the host to tell it that the user is about to start changing this parameter. More... | |
void | endChangeGesture () |
Tells the host that the user has finished changing this parameter. More... | |
virtual bool | isOrientationInverted () const |
This can be overridden to tell the host that this parameter operates in the reverse direction. More... | |
int | getParameterIndex () const noexcept |
Returns the index of this parameter in its parent processor's parameter list. More... | |
virtual String | getCurrentValueAsText () const |
Returns the current value of the parameter as a String. More... | |
virtual StringArray | getAllValueStrings () const |
Returns the set of strings which represent the possible states a parameter can be in. More... | |
void | addListener (Listener *newListener) |
Registers a listener to receive events when the parameter's state changes. More... | |
void | removeListener (Listener *listener) |
Removes a previously registered parameter listener. More... | |
void | sendValueChangedMessageToListeners (float newValue) |
Additional Inherited Members | |
![]() | |
enum | Category { genericParameter = (0 << 16) | 0, inputGain = (1 << 16) | 0, outputGain = (1 << 16) | 1, inputMeter = (2 << 16) | 0, outputMeter = (2 << 16) | 1, compressorLimiterGainReductionMeter = (2 << 16) | 2, expanderGateGainReductionMeter = (2 << 16) | 3, analysisMeter = (2 << 16) | 4, otherMeter = (2 << 16) | 5 } |
![]() | |
NormalisableRange< float > | range |
Provides access to the parameter's range. More... | |
![]() | |
const String | paramID |
Provides access to the parameter's ID string. More... | |
const String | name |
Provides access to the parameter's name. More... | |
const String | label |
Provides access to the parameter's label. More... | |
const Category | category |
Provides access to the parameter's category. More... | |
![]() | |
virtual void | valueChanged (float newValue) |
Override this method if you are interested in receiving callbacks when the parameter value changes. More... | |
A parameter class that maintains backwards compatibility with deprecated AudioProcessorValueTreeState functionality.
Previous calls to
can be replaced with
However, a much better approach is to use the AudioProcessorValueTreeState constructor directly
AudioProcessorValueTreeState::Parameter::Parameter | ( | const String & | parameterID, |
const String & | parameterName, | ||
const String & | labelText, | ||
NormalisableRange< float > | valueRange, | ||
float | defaultValue, | ||
std::function< String(float)> | valueToTextFunction, | ||
std::function< float(const String &)> | textToValueFunction, | ||
bool | isMetaParameter = false , |
||
bool | isAutomatableParameter = true , |
||
bool | isDiscrete = false , |
||
AudioProcessorParameter::Category | category = AudioProcessorParameter::genericParameter , |
||
bool | isBoolean = false |
||
) |
|
overridevirtual |
This should return the default value for this parameter.
Reimplemented from AudioParameterFloat.
|
overridevirtual |
Returns the number of steps that this parameter's range should be quantised into.
If you want a continuous range of values, don't override this method, and allow the default implementation to return AudioProcessor::getDefaultNumParameterSteps().
If your parameter is boolean, then you may want to make this return 2.
The value that is returned may or may not be used, depending on the host. If you want the host to display stepped automation values, rather than a continuous interpolation between successive values, you should override isDiscrete to return true.
Reimplemented from AudioParameterFloat.
|
overridevirtual |
Should return true if this parameter is a "meta" parameter.
A meta-parameter is a parameter that changes other params. It is used by some hosts (e.g. AudioUnit hosts). By default this returns false.
Reimplemented from AudioProcessorParameter.
|
overridevirtual |
Returns true if the host can automate this parameter.
By default, this returns true.
Reimplemented from AudioProcessorParameter.
|
overridevirtual |
Returns whether the parameter uses discrete values, based on the result of getNumSteps, or allows the host to select values continuously.
This information may or may not be used, depending on the host. If you want the host to display stepped automation values, rather than a continuous interpolation between successive values, override this method to return true.
Reimplemented from AudioProcessorParameter.
|
overridevirtual |
Returns whether the parameter represents a boolean switch, typically with "On" and "Off" states.
This information may or may not be used, depending on the host. If you want the host to display a switch, rather than a two item dropdown menu, override this method to return true. You also need to override isDiscrete() to return true
and getNumSteps() to return 2
.
Reimplemented from AudioProcessorParameter.