Loading...
Searching...
No Matches
juce::LegacyAudioParameter Class Referencefinal

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

- juce_audio_processors_headless/format_types/juce_LegacyAudioParameter.h

Inheritance diagram for juce::LegacyAudioParameter:

## Public Member Functions

| LegacyAudioParameter (AudioProcessorParameter::Listener &listener, 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 () 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.
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.
void | setParameterIndex (int) noexcept
virtual StringArray | getAllValueStrings () const
| Returns the set of strings which represent the possible states a parameter can be in.
int | getVersionHint () const
void | setOwner (Listener *listener) noexcept
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 &proc, AudioProcessorParameter *param) noexcept
static String | getParamID (const AudioProcessorParameter *param, bool forceLegacyParamIDs) noexcept
Static Public Member Functions inherited from juce::AudioProcessorParameter
static int | getDefaultNumParameterSteps () noexcept
| Returns the default number of steps for a parameter.

## 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 }

## Constructors and Destructors

## LegacyAudioParameter()

juce::LegacyAudioParameter::LegacyAudioParameter | ( | AudioProcessorParameter::Listener & | listener,
|  | AudioProcessor & | audioProcessorToUse,
|  | int | audioParameterIndex )

inline

References juce::AudioProcessorParameter::getParameterIndex(), jassert, juce::AudioProcessorParameter::setOwner(), and juce::AudioProcessorParameter::setParameterIndex().

Referenced by getParamID(), getParamIndex(), and isLegacy().

## Member Functions

## getValue()

float juce::LegacyAudioParameter::getValue | ( |  | ) | const

inline override virtual

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.

References juce::AudioProcessorParameter::getParameterIndex().

## setValue()

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

inline override virtual

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.

References juce::AudioProcessorParameter::getParameterIndex().

## getDefaultValue()

float juce::LegacyAudioParameter::getDefaultValue | ( |  | ) | const

inline override virtual

This should return the default value for this parameter.

Implements juce::AudioProcessorParameter.

References juce::AudioProcessorParameter::getParameterIndex().

## getName()

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

inline override virtual

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

Implements juce::AudioProcessorParameter.

References juce::AudioProcessorParameter::getParameterIndex().

## getLabel()

String juce::LegacyAudioParameter::getLabel | ( |  | ) | const

inline override virtual

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

For example "Hz" or "%".

Implements juce::AudioProcessorParameter.

References juce::AudioProcessorParameter::getParameterIndex().

## getNumSteps()

int juce::LegacyAudioParameter::getNumSteps | ( |  | ) | const

inline override virtual

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

References juce::AudioProcessorParameter::getParameterIndex().

## isDiscrete()

bool juce::LegacyAudioParameter::isDiscrete | ( |  | ) | const

inline override virtual

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.

References juce::AudioProcessorParameter::getParameterIndex().

## isBoolean()

bool juce::LegacyAudioParameter::isBoolean | ( |  | ) | const

inline override virtual

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.

## isOrientationInverted()

bool juce::LegacyAudioParameter::isOrientationInverted | ( |  | ) | const

inline override virtual

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.

References juce::AudioProcessorParameter::getParameterIndex().

## isAutomatable()

bool juce::LegacyAudioParameter::isAutomatable | ( |  | ) | const

inline override virtual

Returns true if the host can automate this parameter.

By default, this returns true.

Reimplemented from juce::AudioProcessorParameter.

References juce::AudioProcessorParameter::getParameterIndex().

## isMetaParameter()

bool juce::LegacyAudioParameter::isMetaParameter | ( |  | ) | const

inline override virtual

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.

References juce::AudioProcessorParameter::getParameterIndex().

## getCategory()

Category juce::LegacyAudioParameter::getCategory | ( |  | ) | const

inline override virtual

Returns the parameter's category.

Reimplemented from juce::AudioProcessorParameter.

References juce::AudioProcessorParameter::getParameterIndex().

## getCurrentValueAsText()

String juce::LegacyAudioParameter::getCurrentValueAsText | ( |  | ) | const

inline override virtual

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.

References juce::AudioProcessorParameter::getParameterIndex().

## getParameterID()

String juce::LegacyAudioParameter::getParameterID | ( |  | ) | const

inline override virtual

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.

References juce::AudioProcessorParameter::getParameterIndex().

## getValueForText()

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

inline override virtual

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

Implements juce::AudioProcessorParameter.

References jassertfalse.

## getText()

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

inline override virtual

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.

References jassertfalse.

## isLegacy()

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

inline static noexcept

References juce::HostedAudioProcessorParameter::AudioProcessorParameter(), and LegacyAudioParameter().

## getParamIndex()

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

inline static noexcept

References juce::HostedAudioProcessorParameter::AudioProcessorParameter(), jassert, juce::legacy, and LegacyAudioParameter().

## getParamID()

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

inline static noexcept

References juce::HostedAudioProcessorParameter::AudioProcessorParameter(), juce::legacy, and LegacyAudioParameter().

### Purchase

Get JUCE

### Discover

What's New in JUCE Features

### Learn

Documentaion Tutorials Made with JUCE Resources

### Support

JUCE Forum Newsletter Archive

### About

Contact Us JUCE Legal JUCE Licensing FAQ

### Events

Audio Developer Conference
© Raw Material Software Limited