JUCE
|
Provides a class of AudioProcessorParameter that can be used as a boolean value. More...
Public Member Functions | |
AudioParameterBool (const String ¶meterID, const String &name, bool defaultValue, const String &label=String(), std::function< String(bool value, int maximumStringLength)> stringFromBool=nullptr, std::function< bool(const String &text)> boolFromString=nullptr) | |
Creates a AudioParameterBool with the specified parameters. More... | |
~AudioParameterBool () | |
Destructor. More... | |
bool | get () const noexcept |
Returns the parameter's current boolean value. More... | |
operator bool () const noexcept | |
Returns the parameter's current boolean value. More... | |
AudioParameterBool & | operator= (bool newValue) |
Changes the parameter's current value to a new boolean. 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... | |
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 (bool 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 } |
![]() | |
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... | |
Provides a class of AudioProcessorParameter that can be used as a boolean value.
{Audio}
AudioParameterBool::AudioParameterBool | ( | const String & | parameterID, |
const String & | name, | ||
bool | defaultValue, | ||
const String & | label = String() , |
||
std::function< String(bool value, int maximumStringLength)> | stringFromBool = nullptr , |
||
std::function< bool(const String &text)> | boolFromString = nullptr |
||
) |
Creates a AudioParameterBool with the specified parameters.
parameterID | The parameter ID to use |
name | The parameter name to use |
defaultValue | The default value |
label | An optional label for the parameter's value |
stringFromBool | An optional lambda function that converts a bool value to a string with a maximum length. This may be used by hosts to display the parameter's value. |
boolFromString | An optional lambda function that parses a string and converts it into a bool value. Some hosts use this to allow users to type in parameter values. |
AudioParameterBool::~AudioParameterBool | ( | ) |
Destructor.
|
noexcept |
Returns the parameter's current boolean value.
|
noexcept |
Returns the parameter's current boolean value.
References AudioProcessorParameter::getDefaultValue(), AudioProcessorParameter::getNumSteps(), AudioProcessorParameter::getText(), AudioProcessorParameter::getValue(), AudioProcessorParameter::getValueForText(), AudioProcessorParameter::isBoolean(), AudioProcessorParameter::isDiscrete(), JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR, and AudioProcessorParameter::setValue().
AudioParameterBool& AudioParameterBool::operator= | ( | bool | newValue | ) |
Changes the parameter's current value to a new boolean.
|
protectedvirtual |
Override this method if you are interested in receiving callbacks when the parameter value changes.