JUCE
|
This abstract base class is used by some AudioProcessorParameter helper classes. More...
Public Member Functions | |
AudioProcessorParameterWithID (const String ¶meterID, const String &name, const String &label=String(), Category category=AudioProcessorParameter::genericParameter) | |
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... | |
virtual float | getValue () const =0 |
Called by the host to find out the value of this parameter. More... | |
virtual void | setValue (float newValue)=0 |
The host will call this method to change the value of a parameter. 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 float | getDefaultValue () const =0 |
This should return the default value for this parameter. More... | |
virtual int | getNumSteps () const |
Returns the number of steps that this parameter's range should be quantised into. More... | |
virtual bool | isDiscrete () const |
Returns whether the parameter uses discrete values, based on the result of getNumSteps, or allows the host to select values continuously. More... | |
virtual String | getText (float value, int) const |
Returns a textual version of the supplied parameter value. More... | |
virtual float | getValueForText (const String &text) const =0 |
Should parse a string and return the appropriate value for it. More... | |
virtual bool | isOrientationInverted () const |
This can be overridden to tell the host that this parameter operates in the reverse direction. More... | |
virtual bool | isAutomatable () const |
Returns true if the host can automate this parameter. More... | |
virtual bool | isMetaParameter () const |
Should return true if this parameter is a "meta" parameter. More... | |
int | getParameterIndex () const noexcept |
Returns the index of this parameter in its parent processor's parameter list. More... | |
Public Attributes | |
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... | |
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 } |
This abstract base class is used by some AudioProcessorParameter helper classes.
juce::AudioProcessorParameterWithID::AudioProcessorParameterWithID | ( | const String & | parameterID, |
const String & | name, | ||
const String & | label = String() , |
||
Category | category = AudioProcessorParameter::genericParameter |
||
) |
Creation of this object requires providing a name and ID which will be constant for its lifetime.
juce::AudioProcessorParameterWithID::~AudioProcessorParameterWithID | ( | ) |
Destructor.
const String juce::AudioProcessorParameterWithID::paramID |
Provides access to the parameter's ID string.
const String juce::AudioProcessorParameterWithID::name |
Provides access to the parameter's name.
const String juce::AudioProcessorParameterWithID::label |
Provides access to the parameter's label.
const Category juce::AudioProcessorParameterWithID::category |
Provides access to the parameter's category.