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

A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto a given NormalisableRange. More...

Inheritance diagram for AudioParameterFloat:

Public Member Functions

 AudioParameterFloat (const String &parameterID, 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...
 
AudioParameterFloatoperator= (float newValue)
 Changes the parameter's current value. More...
 
- Public Member Functions inherited from 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. More...
 
 ~AudioProcessorParameterWithID ()
 Destructor. 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 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 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

NormalisableRange< float > range
 Provides access to the parameter's range. 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 (float 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

A subclass of AudioProcessorParameter that provides an easy way to create a parameter which maps onto a given NormalisableRange.

See also
AudioParameterInt, AudioParameterBool, AudioParameterChoice

Constructor & Destructor Documentation

◆ AudioParameterFloat() [1/2]

AudioParameterFloat::AudioParameterFloat ( const String parameterID,
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.

Parameters
parameterIDThe parameter ID to use
nameThe parameter name to use
normalisableRangeThe NormalisableRange to use
defaultValueThe non-normalised default value
labelAn optional label for the parameter's value
categoryAn optional parameter category
stringFromValueAn optional lambda function that converts a non-normalised value to a string with a maximum length. This may be used by hosts to display the parameter's value.
valueFromStringAn optional lambda function that parses a string and converts it into a non-normalised value. Some hosts use this to allow users to type in parameter values.

◆ AudioParameterFloat() [2/2]

AudioParameterFloat::AudioParameterFloat ( String  parameterID,
String  name,
float  minValue,
float  maxValue,
float  defaultValue 
)

Creates a AudioParameterFloat with an ID, name, and range.

On creation, its value is set to the default value. For control over skew factors, you can use the other constructor and provide a NormalisableRange.

◆ ~AudioParameterFloat()

AudioParameterFloat::~AudioParameterFloat ( )

Destructor.

Member Function Documentation

◆ get()

float AudioParameterFloat::get ( ) const
noexcept

Returns the parameter's current value.

◆ operator float()

AudioParameterFloat::operator float ( ) const
noexcept

Returns the parameter's current value.

◆ operator=()

AudioParameterFloat& AudioParameterFloat::operator= ( float  newValue)

Changes the parameter's current value.

◆ valueChanged()

virtual void AudioParameterFloat::valueChanged ( float  newValue)
protectedvirtual

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

Member Data Documentation

◆ range

NormalisableRange<float> AudioParameterFloat::range

Provides access to the parameter's range.


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