Public Member Functions | Public Attributes | Protected Member Functions | List of all members
AudioParameterChoice Class Reference

Provides a class of AudioProcessorParameter that can be used to select an indexed, named choice from a list. More...

Inheritance diagram for AudioParameterChoice:

Public Member Functions

 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. More...
 
 ~AudioParameterChoice () override
 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...
 
AudioParameterChoiceoperator= (int newValue)
 Changes the selected item to a new index. More...
 
const NormalisableRange< float > & getNormalisableRange () const override
 Returns the range of values that the parameter can take. More...
 
- Public Member Functions inherited from RangedAudioParameter
 RangedAudioParameter (const String &parameterID, const String &parameterName, const String &parameterLabel={}, Category parameterCategory=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...
 
- Public Member Functions inherited from AudioProcessorParameterWithID
 AudioProcessorParameterWithID (const String &parameterID, const String &parameterName, const String &parameterLabel={}, Category parameterCategory=AudioProcessorParameter::genericParameter)
 The creation of this object requires providing a name and ID which will be constant for its lifetime. More...
 
 ~AudioProcessorParameterWithID () override
 Destructor. More...
 
String getName (int) const override
 Returns the name to display for this parameter, which should be made to fit within the given string length. More...
 
String getLabel () const override
 Some parameters may be able to return a label string for their units. More...
 
Category getCategory () const override
 Returns the parameter's category. More...
 
- Public Member Functions inherited from AudioProcessorParameter
 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 isBoolean () const
 Returns whether the parameter represents a boolean switch, typically with "On" and "Off" states. 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...
 
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)
 

Public Attributes

const StringArray choices
 Provides access to the list of choices that this parameter is working with. More...
 
- Public Attributes inherited from AudioProcessorParameterWithID
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

- Public Types inherited from AudioProcessorParameter
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
}
 

Detailed Description

Provides a class of AudioProcessorParameter that can be used to select an indexed, named choice from a list.

See also
AudioParameterFloat, AudioParameterInt, AudioParameterBool

Constructor & Destructor Documentation

◆ AudioParameterChoice()

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.

Parameters
parameterIDThe parameter ID to use
parameterNameThe parameter name to use
choicesThe set of choices to use
defaultItemIndexThe index of the default choice
parameterLabelAn optional label for the parameter's value
stringFromIndexAn 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.
indexFromStringAn 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.

◆ ~AudioParameterChoice()

AudioParameterChoice::~AudioParameterChoice ( )
override

Destructor.

Member Function Documentation

◆ getIndex()

int AudioParameterChoice::getIndex ( ) const
noexcept

Returns the current index of the selected item.

References roundToInt().

◆ operator int()

AudioParameterChoice::operator int ( ) const
noexcept

Returns the current index of the selected item.

◆ getCurrentChoiceName()

String AudioParameterChoice::getCurrentChoiceName ( ) const
noexcept

Returns the name of the currently selected item.

◆ operator String()

AudioParameterChoice::operator String ( ) const
noexcept

Returns the name of the currently selected item.

◆ operator=()

AudioParameterChoice& AudioParameterChoice::operator= ( int  newValue)

Changes the selected item to a new index.

◆ getNormalisableRange()

const NormalisableRange<float>& AudioParameterChoice::getNormalisableRange ( ) const
overridevirtual

Returns the range of values that the parameter can take.

Implements RangedAudioParameter.

◆ valueChanged()

virtual void AudioParameterChoice::valueChanged ( int  newValue)
protectedvirtual

Override this method if you are interested in receiving callbacks when the parameter value changes.

Member Data Documentation

◆ choices

const StringArray AudioParameterChoice::choices

Provides access to the list of choices that this parameter is working with.


The documentation for this class was generated from the following file: