JUCE
|
Provides a class of AudioProcessorParameter that can be used to select an indexed, named choice from a list. More...
#include <juce_AudioParameterChoice.h>
Public Member Functions | |
AudioParameterChoice (const String ¶meterID, const String ¶meterName, const StringArray &choices, int defaultItemIndex, const String ¶meterLabel=String(), std::function< String(int index, int maximumStringLength)> stringFromIndex=nullptr, std::function< int(const String &text)> indexFromString=nullptr) | |
Creates a AudioParameterChoice with the specified parameters. | |
~AudioParameterChoice () override | |
Destructor. | |
int | getIndex () const noexcept |
Returns the current index of the selected item. | |
operator int () const noexcept | |
Returns the current index of the selected item. | |
String | getCurrentChoiceName () const noexcept |
Returns the name of the currently selected item. | |
operator String () const noexcept | |
Returns the name of the currently selected item. | |
AudioParameterChoice & | operator= (int newValue) |
Changes the selected item to a new index. | |
const NormalisableRange< float > & | getNormalisableRange () const override |
Returns the range of values that the parameter can take. | |
![]() | |
RangedAudioParameter (const String ¶meterID, const String ¶meterName, const String ¶meterLabel={}, Category parameterCategory=AudioProcessorParameter::genericParameter) | |
The creation of this object requires providing a name and ID which will be constant for its lifetime. | |
int | getNumSteps () const override |
Returns the number of steps for this parameter based on the normalisable range's interval. | |
float | convertTo0to1 (float v) const noexcept |
Normalises and snaps a value based on the normalisable range. | |
float | convertFrom0to1 (float v) const noexcept |
Denormalises and snaps a value based on the normalisable range. | |
![]() | |
AudioProcessorParameterWithID (const String ¶meterID, const String ¶meterName, const String ¶meterLabel={}, Category parameterCategory=AudioProcessorParameter::genericParameter) | |
The creation of this object requires providing a name and ID which will be constant for its lifetime. | |
~AudioProcessorParameterWithID () override | |
Destructor. | |
String | getName (int) const override |
Returns the name to display for this parameter, which should be made to fit within the given string length. | |
String | getLabel () const override |
Some parameters may be able to return a label string for their units. | |
Category | getCategory () const override |
Returns the parameter's category. | |
String | getParameterID () const override |
Returns an ID that is unique to this parameter. | |
![]() | |
AudioProcessorParameter () noexcept | |
virtual | ~AudioProcessorParameter () |
Destructor. | |
void | setValueNotifyingHost (float newValue) |
A processor should call this when it needs to change one of its parameters. | |
void | beginChangeGesture () |
Sends a signal to the host to tell it that the user is about to start changing this parameter. | |
void | endChangeGesture () |
Tells the host that the user has finished changing this parameter. | |
virtual bool | isBoolean () const |
Returns whether the parameter represents a boolean switch, typically with "On" and "Off" states. | |
virtual bool | isOrientationInverted () const |
This can be overridden to tell the host that this parameter operates in the reverse direction. | |
virtual bool | isAutomatable () const |
Returns true if the host can automate this parameter. | |
virtual bool | isMetaParameter () const |
Should return true if this parameter is a "meta" parameter. | |
int | getParameterIndex () const noexcept |
Returns the index of this parameter in its parent processor's parameter list. | |
virtual String | getCurrentValueAsText () const |
Returns the current value of the parameter as a String. | |
virtual StringArray | getAllValueStrings () const |
Returns the set of strings which represent the possible states a parameter can be in. | |
void | addListener (Listener *newListener) |
Registers a listener to receive events when the parameter's state changes. | |
void | removeListener (Listener *listener) |
Removes a previously registered parameter listener. | |
void | sendValueChangedMessageToListeners (float newValue) |
Public Attributes | |
const StringArray | choices |
Provides access to the list of choices that this parameter is working with. | |
![]() | |
const String | paramID |
Provides access to the parameter's ID string. | |
const String | name |
Provides access to the parameter's name. | |
const String | label |
Provides access to the parameter's label. | |
const Category | category |
Provides access to the parameter's category. | |
Protected Member Functions | |
virtual void | valueChanged (int newValue) |
Override this method if you are interested in receiving callbacks when the parameter value changes. | |
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 } |
Provides a class of AudioProcessorParameter that can be used to select an indexed, named choice from a list.
AudioParameterChoice::AudioParameterChoice | ( | const String & | parameterID, |
const String & | parameterName, | ||
const StringArray & | choices, | ||
int | defaultItemIndex, | ||
const String & | parameterLabel = String(), | ||
std::function< String(int index, int maximumStringLength)> | stringFromIndex = nullptr, | ||
std::function< int(const String &text)> | indexFromString = nullptr ) |
Creates a AudioParameterChoice with the specified parameters.
parameterID | The parameter ID to use |
parameterName | The parameter name to use |
choices | The set of choices to use |
defaultItemIndex | The index of the default choice |
parameterLabel | An optional label for the parameter's value |
stringFromIndex | An optional lambda function that converts a choice index to a string with a maximum length. This may be used by hosts to display the parameter's value. |
indexFromString | An optional lambda function that parses a string and converts it into a choice index. Some hosts use this to allow users to type in parameter values. |
References choices.
Referenced by operator=(), and valueChanged().
|
override |
Destructor.
|
noexcept |
Returns the current index of the selected item.
References roundToInt().
Referenced by getCurrentChoiceName(), and operator int().
|
noexcept |
Returns the current index of the selected item.
References getIndex().
|
noexcept |
Returns the name of the currently selected item.
References choices, and getIndex().
Referenced by operator String().
|
noexcept |
Returns the name of the currently selected item.
References getCurrentChoiceName().
AudioParameterChoice & AudioParameterChoice::operator= | ( | int | newValue | ) |
Changes the selected item to a new index.
References AudioParameterChoice().
|
overridevirtual |
Returns the range of values that the parameter can take.
Implements RangedAudioParameter.
|
protectedvirtual |
Override this method if you are interested in receiving callbacks when the parameter value changes.
References AudioParameterChoice().
const StringArray AudioParameterChoice::choices |
Provides access to the list of choices that this parameter is working with.
Referenced by AudioParameterChoice(), and getCurrentChoiceName().