JUCE
|
Provides a class of AudioProcessorParameter that can be used to select an indexed, named choice from a list. More...
Public Member Functions | |
AudioParameterChoice (const String ¶meterID, const String &name, const StringArray &choices, int defaultItemIndex, const String &label=String()) | |
Creates a AudioParameterChoice with an ID, name, and list of items. More... | |
~AudioParameterChoice () | |
Destructor. More... | |
int | getIndex () const noexcept |
Returns the current index of the selected item. More... | |
operator int () const noexcept | |
Returns the current index of the selected item. More... | |
String | getCurrentChoiceName () const noexcept |
Returns the name of the currently selected item. More... | |
operator String () const noexcept | |
Returns the name of the currently selected item. More... | |
AudioParameterChoice & | operator= (int newValue) |
Changes the selected item to a new index. More... | |
![]() | |
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... | |
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... | |
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 StringArray | choices |
Provides access to the list of choices that this parameter is working with. 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... | |
Protected Member Functions | |
virtual void | valueChanged (int newValue) |
Override this method if you are interested in receiving callbacks when the parameter value changes. 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 } |
Provides a class of AudioProcessorParameter that can be used to select an indexed, named choice from a list.
juce::AudioParameterChoice::AudioParameterChoice | ( | const String & | parameterID, |
const String & | name, | ||
const StringArray & | choices, | ||
int | defaultItemIndex, | ||
const String & | label = String() |
||
) |
Creates a AudioParameterChoice with an ID, name, and list of items.
On creation, its value is set to the default index.
juce::AudioParameterChoice::~AudioParameterChoice | ( | ) |
Destructor.
|
noexcept |
Returns the current index of the selected item.
References juce::roundToInt().
|
noexcept |
Returns the current index of the selected item.
|
noexcept |
Returns the name of the currently selected item.
|
noexcept |
Returns the name of the currently selected item.
AudioParameterChoice& juce::AudioParameterChoice::operator= | ( | int | newValue | ) |
Changes the selected item to a new index.
|
protectedvirtual |
Override this method if you are interested in receiving callbacks when the parameter value changes.
const StringArray juce::AudioParameterChoice::choices |
Provides access to the list of choices that this parameter is working with.