juce::AudioProcessorValueTreeStateParameterAttributes Class Reference

#include <juce_AudioProcessorValueTreeState.h>

Public Member Functions
JUCE_NODISCARD auto	withStringFromValueFunction (StringFromValue x) const
JUCE_NODISCARD auto	withValueFromStringFunction (ValueFromString x) const
JUCE_NODISCARD auto	withLabel (String x) const
JUCE_NODISCARD auto	withCategory (Category x) const
JUCE_NODISCARD auto	withMeta (bool x) const
JUCE_NODISCARD auto	withAutomatable (bool x) const
JUCE_NODISCARD auto	withInverted (bool x) const
JUCE_NODISCARD auto	withDiscrete (bool x) const
JUCE_NODISCARD auto	withBoolean (bool x) const
JUCE_NODISCARD const auto &	getAudioParameterFloatAttributes () const
JUCE_NODISCARD const auto &	getDiscrete () const
JUCE_NODISCARD const auto &	getBoolean () const

Private Types
using	This = AudioProcessorValueTreeStateParameterAttributes
using	StringFromValue = AudioParameterFloatAttributes::StringFromValue
using	ValueFromString = AudioParameterFloatAttributes::ValueFromString
using	Category = AudioParameterFloatAttributes::Category

Private Attributes
AudioParameterFloatAttributes	attributes
bool	discrete = false
bool	boolean = false

Detailed Description

Advanced properties of an AudioProcessorValueTreeState::Parameter.

The members here have the same meaning as the similarly-named member functions of AudioParameterFloatAttributes.

See also

AudioParameterFloatAttributes, RangedAudioParameterAttributes

Member Typedef Documentation

Category

using juce::AudioProcessorValueTreeStateParameterAttributes::Category = AudioParameterFloatAttributes::Category

private

StringFromValue

using juce::AudioProcessorValueTreeStateParameterAttributes::StringFromValue = AudioParameterFloatAttributes::StringFromValue

private

This

using juce::AudioProcessorValueTreeStateParameterAttributes::This = AudioProcessorValueTreeStateParameterAttributes

private

ValueFromString

using juce::AudioProcessorValueTreeStateParameterAttributes::ValueFromString = AudioParameterFloatAttributes::ValueFromString

private

Member Function Documentation

getAudioParameterFloatAttributes()

JUCE_NODISCARD const auto & juce::AudioProcessorValueTreeStateParameterAttributes::getAudioParameterFloatAttributes ( ) const

inline

Returns

all attributes that might also apply to an AudioParameterFloat

getBoolean()

JUCE_NODISCARD const auto & juce::AudioProcessorValueTreeStateParameterAttributes::getBoolean ( ) const

inline

Returns

'true' if this parameter only has two valid states.

getDiscrete()

JUCE_NODISCARD const auto & juce::AudioProcessorValueTreeStateParameterAttributes::getDiscrete ( ) const

inline

Returns

'true' if this parameter has discrete steps, or 'false' if the parameter is continuous.

withAutomatable()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withAutomatable ( bool x ) const

inline

See also

RangedAudioParameterAttributes::withAutomatable()

withBoolean()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withBoolean ( bool x ) const

inline

Pass 'true' if this parameter only has two valid states.

Using an AudioParameterBool might be a better choice than setting this flag.

withCategory()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withCategory ( Category x ) const

inline

See also

RangedAudioParameterAttributes::withCategory()

withDiscrete()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withDiscrete ( bool x ) const

inline

Pass 'true' if this parameter has discrete steps, or 'false' if the parameter is continuous.

Using an AudioParameterChoice or AudioParameterInt might be a better choice than setting this flag.

withInverted()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withInverted ( bool x ) const

inline

See also

RangedAudioParameterAttributes::withInverted()

withLabel()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withLabel ( String x ) const

inline

See also

RangedAudioParameterAttributes::withLabel()

withMeta()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withMeta ( bool x ) const

inline

See also

RangedAudioParameterAttributes::withMeta()

withStringFromValueFunction()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withStringFromValueFunction ( StringFromValue x ) const

inline

See also

RangedAudioParameterAttributes::withStringFromValueFunction()

withValueFromStringFunction()

JUCE_NODISCARD auto juce::AudioProcessorValueTreeStateParameterAttributes::withValueFromStringFunction ( ValueFromString x ) const

inline

See also

RangedAudioParameterAttributes::withValueFromStringFunction()

Member Data Documentation

attributes

AudioParameterFloatAttributes juce::AudioProcessorValueTreeStateParameterAttributes::attributes

private

boolean

bool juce::AudioProcessorValueTreeStateParameterAttributes::boolean = false

private

discrete

bool juce::AudioProcessorValueTreeStateParameterAttributes::discrete = false

private

---

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/utilities/juce_AudioProcessorValueTreeState.h