juce::LegacyAudioParameter Class Reference

Inheritance diagram for juce::LegacyAudioParameter:

Public Member Functions
	LegacyAudioParameter (AudioProcessor &audioProcessorToUse, int audioParameterIndex)
float	getValue () const override
void	setValue (float newValue) override
float	getDefaultValue () const override
String	getName (int maxLen) const override
String	getLabel () const override
int	getNumSteps () const override
bool	isDiscrete () const override
bool	isBoolean () const override
bool	isOrientationInverted () const override
bool	isAutomatable () const override
bool	isMetaParameter () const override
Category	getCategory () const override
String	getCurrentValueAsText () const override
String	getParamID () const
float	getValueForText (const String &) const override
String	getText (float, int) const override
Public Member Functions inherited from juce::AudioProcessorParameter
	AudioProcessorParameter () noexcept=default
	AudioProcessorParameter (int versionHint)
virtual	~AudioProcessorParameter ()
void	setValueNotifyingHost (float newValue)
void	beginChangeGesture ()
void	endChangeGesture ()
int	getParameterIndex () const noexcept
virtual StringArray	getAllValueStrings () const
int	getVersionHint () const
void	addListener (Listener *newListener)
void	removeListener (Listener *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 = (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 }

Constructor & Destructor Documentation

LegacyAudioParameter()

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

inline

Member Function Documentation

getCategory()

Category juce::LegacyAudioParameter::getCategory ( ) const

inlineoverridevirtual

Returns the parameter's category.

Reimplemented from juce::AudioProcessorParameter.

getCurrentValueAsText()

String juce::LegacyAudioParameter::getCurrentValueAsText ( ) const

inlineoverridevirtual

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.

getDefaultValue()

float juce::LegacyAudioParameter::getDefaultValue ( ) const

inlineoverridevirtual

This should return the default value for this parameter.

Implements juce::AudioProcessorParameter.

getLabel()

String juce::LegacyAudioParameter::getLabel ( ) const

inlineoverridevirtual

Some parameters may be able to return a label string for their units. For example "Hz" or "%".

Implements juce::AudioProcessorParameter.

getName()

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

inlineoverridevirtual

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

Implements juce::AudioProcessorParameter.

getNumSteps()

int juce::LegacyAudioParameter::getNumSteps ( ) const

inlineoverridevirtual

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.

getParamID() [1/2]

String juce::LegacyAudioParameter::getParamID ( ) const

inline

getParamID() [2/2]

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

inlinestaticnoexcept

getParamIndex()

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

inlinestaticnoexcept

getText()

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

inlineoverridevirtual

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.

getValue()

float juce::LegacyAudioParameter::getValue ( ) const

inlineoverridevirtual

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.

getValueForText()

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

inlineoverridevirtual

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

Implements juce::AudioProcessorParameter.

isAutomatable()

bool juce::LegacyAudioParameter::isAutomatable ( ) const

inlineoverridevirtual

Returns true if the host can automate this parameter. By default, this returns true.

Reimplemented from juce::AudioProcessorParameter.

isBoolean()

bool juce::LegacyAudioParameter::isBoolean ( ) const

inlineoverridevirtual

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::LegacyAudioParameter::isDiscrete ( ) const

inlineoverridevirtual

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.

isLegacy()

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

inlinestaticnoexcept

isMetaParameter()

bool juce::LegacyAudioParameter::isMetaParameter ( ) const

inlineoverridevirtual

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

bool juce::LegacyAudioParameter::isOrientationInverted ( ) const

inlineoverridevirtual

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.

setValue()

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

inlineoverridevirtual

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.

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/modules/juce_audio_processors/format_types/juce_LegacyAudioParameter.cpp