A parameter class that maintains backwards compatibility with deprecated AudioProcessorValueTreeState functionality. More...

#include <juce_AudioProcessorValueTreeState.h>

Inheritance diagram for juce::AudioProcessorValueTreeState::Parameter:

[legend]

Collaboration diagram for juce::AudioProcessorValueTreeState::Parameter:

[legend]

Public Types
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 Member Functions
	Parameter (const String &parameterID, const String &parameterName, const String &labelText, NormalisableRange< float > valueRange, float defaultValue, std::function< String(float)> valueToTextFunction, std::function< float(const String &)> textToValueFunction, bool isMetaParameter=false, bool isAutomatableParameter=true, bool isDiscrete=false, AudioProcessorParameter::Category category=AudioProcessorParameter::genericParameter, bool isBoolean=false)

void	addListener (Listener *newListener)
	Registers a listener to receive events when the parameter's state changes. More...

void	beginChangeGesture ()
	Sends a signal to the host to tell it that the user is about to start changing this parameter. More...

float	convertFrom0to1 (float v) const noexcept
	Denormalises and snaps a value based on the normalisable range. More...

float	convertTo0to1 (float v) const noexcept
	Normalises and snaps a value based on the normalisable range. More...

void	endChangeGesture ()
	Tells the host that the user has finished changing this parameter. More...

float	get () const noexcept
	Returns the parameter's current value. More...

virtual StringArray	getAllValueStrings () const
	Returns the set of strings which represent the possible states a parameter can be in. More...

virtual String	getCurrentValueAsText () const
	Returns the current value of the parameter as a String. More...

float	getDefaultValue () const override
	This should return the default value for this parameter. More...

const NormalisableRange< float > &	getNormalisableRange () const override
	Returns the range of values that the parameter can take. More...

int	getNumSteps () const override
	Returns the number of steps that this parameter's range should be quantised into. More...

int	getParameterIndex () const noexcept
	Returns the index of this parameter in its parent processor's parameter list. More...

bool	isAutomatable () const override
	Returns true if the host can automate this parameter. More...

bool	isBoolean () const override
	Returns whether the parameter represents a boolean switch, typically with "On" and "Off" states. More...

bool	isDiscrete () const override
	Returns whether the parameter uses discrete values, based on the result of getNumSteps, or allows the host to select values continuously. More...

bool	isMetaParameter () const override
	Should return true if this parameter is a "meta" parameter. More...

virtual bool	isOrientationInverted () const
	This can be overridden to tell the host that this parameter operates in the reverse direction. More...

	operator float () const noexcept
	Returns the parameter's current value. More...

void	removeListener (Listener *listener)
	Removes a previously registered parameter listener. More...

void	sendValueChangedMessageToListeners (float newValue)

void	setValueNotifyingHost (float newValue)
	A processor should call this when it needs to change one of its parameters. More...

Public Attributes
const Category	category
	Provides access to the parameter's category. More...

const String	label
	Provides access to the parameter's label. More...

const String	name
	Provides access to the parameter's name. More...

const String	paramID
	Provides access to the parameter's ID string. More...

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

Private Attributes
const bool	automatable

const bool	boolean

const bool	discrete

const bool	metaParameter

const float	unsnappedDefault

Detailed Description

A parameter class that maintains backwards compatibility with deprecated AudioProcessorValueTreeState functionality.

Previous calls to

createAndAddParameter (paramID1, paramName1, ...);

can be replaced with

using Parameter = AudioProcessorValueTreeState::Parameter;

createAndAddParameter (std::make_unique<Parameter> (paramID1, paramName1, ...));

However, a much better approach is to use the AudioProcessorValueTreeState constructor directly

using Parameter = AudioProcessorValueTreeState::Parameter;
YourAudioProcessor()
    : apvts (*this, &undoManager, "PARAMETERS", { std::make_unique<Parameter> (paramID1, paramName1, ...),
                                                  std::make_unique<Parameter> (paramID2, paramName2, ...),
                                                  ... })

Member Enumeration Documentation

◆ Category

enum juce::AudioProcessorParameter::Category

inherited

Enumerator
genericParameter
inputGain	If your parameter is not a meter then you should use this category.
outputGain	Currently not used.
inputMeter	The following categories tell the host that this parameter is a meter level value and therefore read-only. Most hosts will display these type of parameters as a meter in the generic view of your plug-in. Pro-Tools will also show the meter in the mixer view.
outputMeter
compressorLimiterGainReductionMeter
expanderGateGainReductionMeter
analysisMeter
otherMeter

Constructor & Destructor Documentation

◆ Parameter()

juce::AudioProcessorValueTreeState::Parameter::Parameter	(	const String &	parameterID,
		const String &	parameterName,
		const String &	labelText,
		NormalisableRange< float >	valueRange,
		float	defaultValue,
		std::function< String(float)>	valueToTextFunction,
		std::function< float(const String &)>	textToValueFunction,
		bool	isMetaParameter = `false`,
		bool	isAutomatableParameter = `true`,
		bool	isDiscrete = `false`,
		AudioProcessorParameter::Category	category = `AudioProcessorParameter::genericParameter`,
		bool	isBoolean = `false`
	)

Member Function Documentation

◆ addListener()

void juce::AudioProcessorParameter::addListener ( Listener * newListener )

inherited

Registers a listener to receive events when the parameter's state changes.

If the listener is already registered, this will not register it again.

See also: removeListener

◆ beginChangeGesture()

void juce::AudioProcessorParameter::beginChangeGesture ( )

inherited

Sends a signal to the host to tell it that the user is about to start changing this parameter.

This allows the host to know when a parameter is actively being held by the user, and it may use this information to help it record automation. If you call this, it must be matched by a later call to endChangeGesture().

◆ convertFrom0to1()

float juce::RangedAudioParameter::convertFrom0to1 ( float v ) const

inlinenoexceptinherited

Denormalises and snaps a value based on the normalisable range.

References juce::jlimit().

◆ convertTo0to1()

float juce::RangedAudioParameter::convertTo0to1 ( float v ) const

inlinenoexceptinherited

Normalises and snaps a value based on the normalisable range.

◆ endChangeGesture()

void juce::AudioProcessorParameter::endChangeGesture ( )

inherited

Tells the host that the user has finished changing this parameter.

This allows the host to know when a parameter is actively being held by the user, and it may use this information to help it record automation. A call to this method must follow a call to beginChangeGesture().

◆ get()

float juce::AudioParameterFloat::get ( ) const

inlinenoexceptinherited

Returns the parameter's current value.

◆ getAllValueStrings()

virtual StringArray juce::AudioProcessorParameter::getAllValueStrings ( ) const

virtualinherited

Returns the set of strings which represent the possible states a parameter can be in.

If you are hosting a plug-in you can use the result of this function to populate a ComboBox listing the allowed values.

If you are implementing a plug-in then you do not need to override this.

◆ getCurrentValueAsText()

virtual String juce::AudioProcessorParameter::getCurrentValueAsText ( ) const

virtualinherited

Returns the current value of the parameter as a String.

This function can be called when you are hosting plug-ins to get a more specialsed textual represenation of the current value from the plug-in, for example "On" rather than "1.0".

If you are implementing a plug-in then you should ignore this function and instead override getText.

◆ getDefaultValue()

float juce::AudioProcessorValueTreeState::Parameter::getDefaultValue ( ) const

overridevirtual

This should return the default value for this parameter.

Reimplemented from juce::AudioParameterFloat.

◆ getNormalisableRange()

const NormalisableRange<float>& juce::AudioParameterFloat::getNormalisableRange ( ) const

inlineoverridevirtualinherited

Returns the range of values that the parameter can take.

Implements juce::RangedAudioParameter.

◆ getNumSteps()

int juce::AudioProcessorValueTreeState::Parameter::getNumSteps ( ) const

overridevirtual

Returns the number of steps that this parameter's range should be quantised into.

If you want a continuous range of values, don't override this method, and allow the default implementation to return AudioProcessor::getDefaultNumParameterSteps().

If your parameter is boolean, then you may want to make this return 2.

The value that is returned may or may not be used, depending on the host. If you want the host to display stepped automation values, rather than a continuous interpolation between successive values, you should override isDiscrete to return true.

See also: isDiscrete

Reimplemented from juce::AudioParameterFloat.

◆ getParameterIndex()

int juce::AudioProcessorParameter::getParameterIndex ( ) const

inlinenoexceptinherited

Returns the index of this parameter in its parent processor's parameter list.

◆ isAutomatable()

bool juce::AudioProcessorValueTreeState::Parameter::isAutomatable ( ) const

overridevirtual

Returns true if the host can automate this parameter.

By default, this returns true.

Reimplemented from juce::AudioProcessorParameter.

◆ isBoolean()

bool juce::AudioProcessorValueTreeState::Parameter::isBoolean ( ) const

overridevirtual

Returns whether the parameter represents a boolean switch, typically with "On" and "Off" states.

This information may or may not be used, depending on the host. If you want the host to display a switch, rather than a two item dropdown menu, override this method to return true. You also need to override isDiscrete() to return true and getNumSteps() to return 2.

See also: isDiscrete getNumSteps

Reimplemented from juce::AudioProcessorParameter.

◆ isDiscrete()

bool juce::AudioProcessorValueTreeState::Parameter::isDiscrete ( ) const

overridevirtual

Returns whether the parameter uses discrete values, based on the result of getNumSteps, or allows the host to select values continuously.

This information may or may not be used, depending on the host. If you want the host to display stepped automation values, rather than a continuous interpolation between successive values, override this method to return true.

See also: getNumSteps

Reimplemented from juce::AudioProcessorParameter.

◆ isMetaParameter()

bool juce::AudioProcessorValueTreeState::Parameter::isMetaParameter ( ) const

overridevirtual

Should return true if this parameter is a "meta" parameter.

A meta-parameter is a parameter that changes other params. It is used by some hosts (e.g. AudioUnit hosts). By default this returns false.

Reimplemented from juce::AudioProcessorParameter.

◆ isOrientationInverted()

virtual bool juce::AudioProcessorParameter::isOrientationInverted ( ) const

virtualinherited

This can be overridden to tell the host that this parameter operates in the reverse direction.

(Not all plugin formats or hosts will actually use this information).

◆ operator float()

juce::AudioParameterFloat::operator float ( ) const

inlinenoexceptinherited

Returns the parameter's current value.

◆ removeListener()

void juce::AudioProcessorParameter::removeListener ( Listener * listener )

inherited

Removes a previously registered parameter listener.

See also: addListener

◆ sendValueChangedMessageToListeners()

void juce::AudioProcessorParameter::sendValueChangedMessageToListeners ( float newValue )

inherited

◆ setValueNotifyingHost()

void juce::AudioProcessorParameter::setValueNotifyingHost ( float newValue )

inherited

A processor should call this when it needs to change one of its parameters.

This could happen when the editor or some other internal operation changes a parameter. This method will call the setValue() method to change the value, and will then send a message to the host telling it about the change.

Note that to make sure the host correctly handles automation, you should call the beginChangeGesture() and endChangeGesture() methods to tell the host when the user has started and stopped changing the parameter.

◆ valueChanged()

virtual void juce::AudioParameterFloat::valueChanged ( float newValue )

protectedvirtualinherited

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

Member Data Documentation

◆ automatable

const bool juce::AudioProcessorValueTreeState::Parameter::automatable

private

◆ boolean

const bool juce::AudioProcessorValueTreeState::Parameter::boolean

private

◆ category

const Category juce::AudioProcessorParameterWithID::category

inherited

Provides access to the parameter's category.

◆ discrete

const bool juce::AudioProcessorValueTreeState::Parameter::discrete

private

◆ label

const String juce::AudioProcessorParameterWithID::label

inherited

Provides access to the parameter's label.

◆ metaParameter

const bool juce::AudioProcessorValueTreeState::Parameter::metaParameter

private

◆ name

const String juce::AudioProcessorParameterWithID::name

inherited

Provides access to the parameter's name.

◆ paramID

const String juce::AudioProcessorParameterWithID::paramID

inherited

Provides access to the parameter's ID string.

◆ range

NormalisableRange<float> juce::AudioParameterFloat::range

inherited

Provides access to the parameter's range.

◆ unsnappedDefault

const float juce::AudioProcessorValueTreeState::Parameter::unsnappedDefault

private

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

juce_AudioProcessorValueTreeState.h

Public Types

Public Member Functions

Public Attributes

Protected Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Category

Constructor & Destructor Documentation

◆ Parameter()

Member Function Documentation

◆ addListener()

◆ beginChangeGesture()

◆ convertFrom0to1()

◆ convertTo0to1()

◆ endChangeGesture()

◆ get()

◆ getAllValueStrings()

◆ getCurrentValueAsText()

◆ getDefaultValue()

◆ getNormalisableRange()

◆ getNumSteps()

◆ getParameterIndex()

◆ isAutomatable()

◆ isBoolean()

◆ isDiscrete()

◆ isMetaParameter()

◆ isOrientationInverted()

◆ operator float()

◆ removeListener()

◆ sendValueChangedMessageToListeners()

◆ setValueNotifyingHost()

◆ valueChanged()

Member Data Documentation

◆ automatable

◆ boolean

◆ category

◆ discrete

◆ label

◆ metaParameter

◆ name

◆ paramID

◆ range

◆ unsnappedDefault