RangedAudioParameter Class Reference

This abstract base class is used by some AudioProcessorParameter helper classes. More...

#include <juce_RangedAudioParameter.h>

Inheritance diagram for RangedAudioParameter:

Public Member Functions
virtual const NormalisableRange< float > &	getNormalisableRange () const =0
	Returns the range of values that the parameter can take.
int	getNumSteps () const override
	Returns the number of steps for this parameter based on the normalisable range's interval.
float	convertTo0to1 (float v) const noexcept
	Normalises and snaps a value based on the normalisable range.
float	convertFrom0to1 (float v) const noexcept
	Denormalises and snaps a value based on the normalisable range.
	AudioProcessorParameterWithID (const ParameterID &parameterID, const String &parameterName, const AudioProcessorParameterWithIDAttributes &attributes={})
	The creation of this object requires providing a name and ID which will be constant for its lifetime.
	AudioProcessorParameterWithID (const ParameterID &parameterID, const String &parameterName, const String &parameterLabel, Category parameterCategory=AudioProcessorParameter::genericParameter)
	The creation of this object requires providing a name and ID which will be constant for its lifetime.
Public Member Functions inherited from AudioProcessorParameterWithID
	AudioProcessorParameterWithID (const ParameterID &parameterID, const String &parameterName, const AudioProcessorParameterWithIDAttributes &attributes={})
	The creation of this object requires providing a name and ID which will be constant for its lifetime.
	AudioProcessorParameterWithID (const ParameterID &parameterID, const String &parameterName, const String &parameterLabel, Category parameterCategory=AudioProcessorParameter::genericParameter)
	The creation of this object requires providing a name and ID which will be constant for its lifetime.
String	getName (int) const override
	Returns the name to display for this parameter, which should be made to fit within the given string length.
String	getLabel () const override
	Some parameters may be able to return a label string for their units.
Category	getCategory () const override
	Returns the parameter's category.
String	getParameterID () const override
	Returns an ID that is unique to this parameter.
bool	isMetaParameter () const override
	Should return true if this parameter is a "meta" parameter.
bool	isAutomatable () const override
	Returns true if the host can automate this parameter.
bool	isOrientationInverted () const override
	This can be overridden to tell the host that this parameter operates in the reverse direction.
Public Member Functions inherited from HostedAudioProcessorParameter
	AudioProcessorParameter () noexcept=default
	AudioProcessorParameter (int versionHint)
	The version hint supplied to this constructor is used in Audio Unit plugins to aid ordering parameter identifiers when JUCE_FORCE_USE_LEGACY_PARAM_IDS is not enabled.
Public Member Functions inherited from AudioProcessorParameter
	AudioProcessorParameter () noexcept=default
	AudioProcessorParameter (int versionHint)
	The version hint supplied to this constructor is used in Audio Unit plugins to aid ordering parameter identifiers when JUCE_FORCE_USE_LEGACY_PARAM_IDS is not enabled.
virtual	~AudioProcessorParameter ()
	Destructor.
virtual float	getValue () const =0
	Called by the host to find out the value of this parameter.
virtual void	setValue (float newValue)=0
	The host will call this method to change the value of a parameter.
void	setValueNotifyingHost (float newValue)
	A processor should call this when it needs to change one of its parameters.
void	beginChangeGesture ()
	Sends a signal to the host to tell it that the user is about to start changing this parameter.
void	endChangeGesture ()
	Tells the host that the user has finished changing this parameter.
virtual float	getDefaultValue () const =0
	This should return the default value for this parameter.
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.
virtual bool	isBoolean () const
	Returns whether the parameter represents a boolean switch, typically with "On" and "Off" states.
virtual String	getText (float normalisedValue, int) const
	Returns a textual version of the supplied normalised parameter value.
virtual float	getValueForText (const String &text) const =0
	Should parse a string and return the appropriate value for it.
int	getParameterIndex () const noexcept
	Returns the index of this parameter in its parent processor's parameter list.
virtual String	getCurrentValueAsText () const
	Returns the current value of the parameter as a String.
virtual StringArray	getAllValueStrings () const
	Returns the set of strings which represent the possible states a parameter can be in.
int	getVersionHint () const
void	addListener (Listener *newListener)
	Registers a listener to receive events when the parameter's state changes.
void	removeListener (Listener *listener)
	Removes a previously registered parameter listener.
void	sendValueChangedMessageToListeners (float newValue)

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.
const String	name
	Provides access to the parameter's name.
const String	label
	Provides access to the parameter's label.
const Category	category
	Provides access to the parameter's category.

Detailed Description

This abstract base class is used by some AudioProcessorParameter helper classes.

See also

AudioParameterFloat, AudioParameterInt, AudioParameterBool, AudioParameterChoice

Member Function Documentation

getNormalisableRange()

virtual const NormalisableRange< float > & RangedAudioParameter::getNormalisableRange ( ) const

pure virtual

Returns the range of values that the parameter can take.

Implemented in AudioParameterBool, AudioParameterChoice, AudioParameterFloat, and AudioParameterInt.

Referenced by AudioParameterInt::getRange().

getNumSteps()

int RangedAudioParameter::getNumSteps ( ) const

overridevirtual

Returns the number of steps for this parameter based on the normalisable range's interval.

If you are using lambda functions to define the normalisable range's snapping behaviour then you should override this function so that it returns the number of snapping points.

Reimplemented from AudioProcessorParameter.

convertTo0to1()

float RangedAudioParameter::convertTo0to1 ( float v ) const

noexcept

Normalises and snaps a value based on the normalisable range.

convertFrom0to1()

float RangedAudioParameter::convertFrom0to1 ( float v ) const

noexcept

Denormalises and snaps a value based on the normalisable range.

AudioProcessorParameterWithID() [1/2]

AudioProcessorParameterWithID::AudioProcessorParameterWithID	(	const ParameterID &	parameterID,
		const String &	parameterName,
		const AudioProcessorParameterWithIDAttributes &	attributes = {} )

The creation of this object requires providing a name and ID which will be constant for its lifetime.

Given that AudioProcessorParameterWithID is abstract, you'll probably call this constructor from a derived class constructor, e.g.

MyParameterType (String paramID, String name, String label, bool automatable)
    : AudioProcessorParameterWithID (paramID, name, AudioProcessorParameterWithIDAttributes().withLabel (label)
                                                                                             .withAutomatable (automatable))
{
}

Parameters

parameterID	Specifies the identifier, and optionally the parameter's version hint.
parameterName	The user-facing parameter name.
attributes	Other parameter properties.

AudioProcessorParameterWithID() [2/2]

AudioProcessorParameterWithID::AudioProcessorParameterWithID	(	const ParameterID &	parameterID,
		const String &	parameterName,
		const String &	parameterLabel,
		Category	parameterCategory = AudioProcessorParameter::genericParameter )

The creation of this object requires providing a name and ID which will be constant for its lifetime.

Parameters

parameterID	Used to uniquely identify the parameter
parameterName	The user-facing name of the parameter
parameterLabel	An optional label for the parameter's value
parameterCategory	The semantics of this parameter

---

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

• juce_RangedAudioParameter.h