Provides a class of AudioProcessorParameter that can be used as a boolean value. More...

Inheritance diagram for AudioParameterBool:

Public Member Functions
	AudioParameterBool (const String &parameterID, const String &name, bool defaultValue, const String &label=String())
	Creates a AudioParameterBool with an ID and name. 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...

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

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
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 a boolean value.

See also: AudioParameterFloat, AudioParameterInt, AudioParameterChoice

Constructor & Destructor Documentation

◆ AudioParameterBool()

AudioParameterBool::AudioParameterBool	(	const String &	parameterID,
		const String &	name,
		bool	defaultValue,
		const String &	label = `String()`
	)

Creates a AudioParameterBool with an ID and name.

On creation, its value is set to the default value.

◆ ~AudioParameterBool()

AudioParameterBool::~AudioParameterBool ( )

Destructor.

Member Function Documentation

◆ get()

bool AudioParameterBool::get ( ) const

noexcept

Returns the parameter's current boolean value.

◆ operator bool()

AudioParameterBool::operator bool ( ) const

noexcept

Returns the parameter's current boolean value.

References AudioProcessorParameter::getDefaultValue(), AudioProcessorParameter::getNumSteps(), AudioProcessorParameter::getText(), AudioProcessorParameter::getValue(), AudioProcessorParameter::getValueForText(), AudioProcessorParameter::isDiscrete(), JUCE_DECLARE_NON_COPYABLE_WITH_LEAK_DETECTOR, and AudioProcessorParameter::setValue().

◆ operator=()

AudioParameterBool& AudioParameterBool::operator= ( bool newValue )

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

◆ valueChanged()

virtual void AudioParameterBool::valueChanged ( bool 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:

juce_AudioParameterBool.h

Public Member Functions

Protected Member Functions

Additional Inherited Members