Inheritance diagram for juce::LegacyAudioParameter:

Public Member Functions
	LegacyAudioParameter (AudioProcessor &audioProcessorToUse, int audioParameterIndex)

float	getValue () const override
	Called by the host to find out the value of this parameter.

void	setValue (float newValue) override
	The host will call this method to change the value of a parameter.

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

String	getName (int maxLen) 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.

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

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.

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

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

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

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

Category	getCategory () const override
	Returns the parameter's category.

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

String	getParameterID () const override
	Returns an ID that is unique to this parameter.

float	getValueForText (const String &) const override
	Should parse a string and return the appropriate value for it.

String	getText (float, int) const override
	Returns a textual version of the supplied normalised parameter value.

Public Member Functions inherited from juce::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 juce::AudioProcessorParameter
	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.

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.

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

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)

Static Public Member Functions
static bool	isLegacy (AudioProcessorParameter *param) noexcept

static int	getParamIndex (AudioProcessor &processor, AudioProcessorParameter *param) noexcept

static String	getParamID (const AudioProcessorParameter *param, bool forceLegacyParamIDs) noexcept

Additional Inherited Members
Public Types inherited from juce::AudioProcessorParameter
enum	Category { genericParameter , inputGain , outputGain , inputMeter , outputMeter , compressorLimiterGainReductionMeter , expanderGateGainReductionMeter , analysisMeter , otherMeter }

Detailed Description

Definition at line 32 of file juce_LegacyAudioParameter.cpp.

Constructor & Destructor Documentation

◆ LegacyAudioParameter()

juce::LegacyAudioParameter::LegacyAudioParameter	(	AudioProcessor &	audioProcessorToUse,
		int	audioParameterIndex
	)

Definition at line 35 of file juce_LegacyAudioParameter.cpp.

Member Function Documentation

◆ getCategory()

Category juce::LegacyAudioParameter::getCategory ( ) const

overridevirtual

Returns the parameter's category.

Reimplemented from juce::AudioProcessorParameter.

Definition at line 55 of file juce_LegacyAudioParameter.cpp.

◆ getCurrentValueAsText()

String juce::LegacyAudioParameter::getCurrentValueAsText ( ) const

overridevirtual

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 specialised textual representation 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.

Reimplemented from juce::AudioProcessorParameter.

Definition at line 56 of file juce_LegacyAudioParameter.cpp.

◆ getDefaultValue()

float juce::LegacyAudioParameter::getDefaultValue ( ) const

overridevirtual

This should return the default value for this parameter.

Implements juce::AudioProcessorParameter.

Definition at line 46 of file juce_LegacyAudioParameter.cpp.

◆ getLabel()

String juce::LegacyAudioParameter::getLabel ( ) const

overridevirtual

Some parameters may be able to return a label string for their units.

For example "Hz" or "%".

Implements juce::AudioProcessorParameter.

Definition at line 48 of file juce_LegacyAudioParameter.cpp.

◆ getName()

String juce::LegacyAudioParameter::getName ( int maximumStringLength ) const

overridevirtual

Returns the name to display for this parameter, which should be made to fit within the given string length.

Implements juce::AudioProcessorParameter.

Definition at line 47 of file juce_LegacyAudioParameter.cpp.

◆ getNumSteps()

int juce::LegacyAudioParameter::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::AudioProcessorParameter.

Definition at line 49 of file juce_LegacyAudioParameter.cpp.

◆ getParameterID()

String juce::LegacyAudioParameter::getParameterID ( ) const

overridevirtual

Returns an ID that is unique to this parameter.

Parameter indices are unstable across plugin versions, which means that the parameter found at a particular index in one version of a plugin might move to a different index in the subsequent version.

Unlike the parameter index, the ID returned by this function should be somewhat stable (depending on the format of the plugin), so it is more suitable for storing/recalling automation data.

Implements juce::HostedAudioProcessorParameter.

Definition at line 57 of file juce_LegacyAudioParameter.cpp.

◆ getParamID()

static String juce::LegacyAudioParameter::getParamID	(	const AudioProcessorParameter *	param,
		bool	forceLegacyParamIDs
	)

staticnoexcept

Definition at line 101 of file juce_LegacyAudioParameter.cpp.

◆ getParamIndex()

static int juce::LegacyAudioParameter::getParamIndex	(	AudioProcessor &	processor,
		AudioProcessorParameter *	param
	)

staticnoexcept

Definition at line 80 of file juce_LegacyAudioParameter.cpp.

◆ getText()

String juce::LegacyAudioParameter::getText	(	float	normalisedValue,
		int
	)		const

overridevirtual

Returns a textual version of the supplied normalised parameter value.

The default implementation just returns the floating point value as a string, but this could do anything you need for a custom type of value.

Reimplemented from juce::AudioProcessorParameter.

Definition at line 67 of file juce_LegacyAudioParameter.cpp.

◆ getValue()

float juce::LegacyAudioParameter::getValue ( ) const

overridevirtual

Called by the host to find out the value of this parameter.

Hosts will expect the value returned to be between 0 and 1.0.

This could be called quite frequently, so try to make your code efficient. It's also likely to be called by non-UI threads, so the code in here should be thread-aware.

Implements juce::AudioProcessorParameter.

Definition at line 44 of file juce_LegacyAudioParameter.cpp.

◆ getValueForText()

float juce::LegacyAudioParameter::getValueForText ( const String & text ) const

overridevirtual

Should parse a string and return the appropriate value for it.

Implements juce::AudioProcessorParameter.

Definition at line 60 of file juce_LegacyAudioParameter.cpp.

◆ isAutomatable()

bool juce::LegacyAudioParameter::isAutomatable ( ) const

overridevirtual

Returns true if the host can automate this parameter.

By default, this returns true.

Reimplemented from juce::AudioProcessorParameter.

Definition at line 53 of file juce_LegacyAudioParameter.cpp.

◆ isBoolean()

bool juce::LegacyAudioParameter::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.

Definition at line 51 of file juce_LegacyAudioParameter.cpp.

◆ isDiscrete()

bool juce::LegacyAudioParameter::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.

Definition at line 50 of file juce_LegacyAudioParameter.cpp.

◆ isLegacy()

static bool juce::LegacyAudioParameter::isLegacy ( AudioProcessorParameter * param )

staticnoexcept

Definition at line 75 of file juce_LegacyAudioParameter.cpp.

◆ isMetaParameter()

bool juce::LegacyAudioParameter::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.

Definition at line 54 of file juce_LegacyAudioParameter.cpp.

◆ isOrientationInverted()

bool juce::LegacyAudioParameter::isOrientationInverted ( ) const

overridevirtual

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

Reimplemented from juce::AudioProcessorParameter.

Definition at line 52 of file juce_LegacyAudioParameter.cpp.

◆ setValue()

void juce::LegacyAudioParameter::setValue ( float newValue )

overridevirtual

The host will call this method to change the value of a parameter.

The host may call this at any time, including during the audio processing callback, so your implementation has to process this very efficiently and avoid any kind of locking.

If you want to set the value of a parameter internally, e.g. from your editor component, then don't call this directly - instead, use the setValueNotifyingHost() method, which will also send a message to the host telling it about the change. If the message isn't sent, the host won't be able to automate your parameters properly.

The value passed will be between 0 and 1.0.

Implements juce::AudioProcessorParameter.

Definition at line 45 of file juce_LegacyAudioParameter.cpp.

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

juce_audio_processors/format_types/juce_LegacyAudioParameter.cpp

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ LegacyAudioParameter()

Member Function Documentation

◆ getCategory()

◆ getCurrentValueAsText()

◆ getDefaultValue()

◆ getLabel()

◆ getName()

◆ getNumSteps()

◆ getParameterID()

◆ getParamID()

◆ getParamIndex()

◆ getText()

◆ getValue()

◆ getValueForText()

◆ isAutomatable()

◆ isBoolean()

◆ isDiscrete()

◆ isLegacy()

◆ isMetaParameter()

◆ isOrientationInverted()

◆ setValue()