Public Member Functions | Protected Member Functions | List of all members
AudioParameterInt Class Reference

Provides a class of AudioProcessorParameter that can be used as an integer value with a given range. More...

Inheritance diagram for AudioParameterInt:

Public Member Functions

 AudioParameterInt (const String &parameterID, const String &name, int minValue, int maxValue, int defaultValue, const String &label=String(), std::function< String(int value, int maximumStringLength)> stringFromInt=nullptr, std::function< int(const String &text)> intFromString=nullptr)
 Creates a AudioParameterInt with the specified parameters. More...
 
 ~AudioParameterInt ()
 Destructor. More...
 
int get () const noexcept
 Returns the parameter's current value as an integer. More...
 
 operator int () const noexcept
 Returns the parameter's current value as an integer. More...
 
AudioParameterIntoperator= (int newValue)
 Changes the parameter's current value to a new integer. More...
 
Range< int > getRange () const noexcept
 Returns the parameter's range. 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)
 

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
}
 
- 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...
 

Detailed Description

Provides a class of AudioProcessorParameter that can be used as an integer value with a given range.

See also
AudioParameterFloat, AudioParameterBool, AudioParameterChoice

Constructor & Destructor Documentation

◆ AudioParameterInt()

AudioParameterInt::AudioParameterInt ( const String parameterID,
const String name,
int  minValue,
int  maxValue,
int  defaultValue,
const String label = String(),
std::function< String(int value, int maximumStringLength)>  stringFromInt = nullptr,
std::function< int(const String &text)>  intFromString = nullptr 
)

Creates a AudioParameterInt with the specified parameters.

Parameters
parameterIDThe parameter ID to use
nameThe parameter name to use
minValueThe minimum parameter value
maxValueThe maximum parameter value
defaultValueThe default value
labelAn optional label for the parameter's value
stringFromIntAn optional lambda function that converts a int value to a string with a maximum length. This may be used by hosts to display the parameter's value.
intFromStringAn optional lambda function that parses a string and converts it into an int. Some hosts use this to allow users to type in parameter values.

◆ ~AudioParameterInt()

AudioParameterInt::~AudioParameterInt ( )

Destructor.

Member Function Documentation

◆ get()

int AudioParameterInt::get ( ) const
noexcept

Returns the parameter's current value as an integer.

References roundToInt().

◆ operator int()

AudioParameterInt::operator int ( ) const
noexcept

Returns the parameter's current value as an integer.

◆ operator=()

AudioParameterInt& AudioParameterInt::operator= ( int  newValue)

Changes the parameter's current value to a new integer.

The value passed in will be snapped to the permitted range before being used.

◆ getRange()

Range<int> AudioParameterInt::getRange ( ) const
noexcept

Returns the parameter's range.

◆ valueChanged()

virtual void AudioParameterInt::valueChanged ( int  newValue)
protectedvirtual

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


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