juce::AudioProcessorValueTreeStateParameterAttributes Class Reference

Advanced properties of an AudioProcessorValueTreeState::Parameter. More...

#include <juce_AudioProcessorValueTreeState.h>

Collaboration diagram for juce::AudioProcessorValueTreeStateParameterAttributes:

Public Member Functions
const auto &	getAudioParameterFloatAttributes () const
const auto &	getBoolean () const
const auto &	getDiscrete () const
auto	withAutomatable (bool x) const
auto	withBoolean (bool x) const
	Pass 'true' if this parameter only has two valid states.
auto	withCategory (Category x) const
auto	withDiscrete (bool x) const
	Pass 'true' if this parameter has discrete steps, or 'false' if the parameter is continuous.
auto	withInverted (bool x) const
auto	withLabel (String x) const
auto	withMeta (bool x) const
auto	withStringFromValueFunction (StringFromValue x) const
auto	withValueFromStringFunction (ValueFromString x) const

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

Private Attributes
AudioParameterFloatAttributes	attributes
bool	boolean = false
bool	discrete = 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

@tags{Audio}

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

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

inline

Returns

all attributes that might also apply to an AudioParameterFloat

References attributes.

getBoolean()

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

inline

Returns

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

References boolean.

getDiscrete()

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

inline

Returns

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

References discrete.

withAutomatable()

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

inline

See also

RangedAudioParameterAttributes::withAutomatable()

References attributes, juce::RangedAudioParameterAttributes< Derived, Value >::withAutomatable(), and juce::withMember().

withBoolean()

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.

References boolean, and juce::withMember().

withCategory()

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

inline

See also

RangedAudioParameterAttributes::withCategory()

References attributes, juce::RangedAudioParameterAttributes< Derived, Value >::withCategory(), and juce::withMember().

withDiscrete()

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.

References discrete, and juce::withMember().

withInverted()

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

inline

See also

RangedAudioParameterAttributes::withInverted()

References attributes, juce::RangedAudioParameterAttributes< Derived, Value >::withInverted(), and juce::withMember().

withLabel()

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

inline

See also

RangedAudioParameterAttributes::withLabel()

References attributes, juce::RangedAudioParameterAttributes< Derived, Value >::withLabel(), and juce::withMember().

withMeta()

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

inline

See also

RangedAudioParameterAttributes::withMeta()

References attributes, juce::withMember(), and juce::RangedAudioParameterAttributes< Derived, Value >::withMeta().

withStringFromValueFunction()

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

inline

See also

RangedAudioParameterAttributes::withStringFromValueFunction()

References attributes, juce::withMember(), and juce::RangedAudioParameterAttributes< Derived, Value >::withStringFromValueFunction().

withValueFromStringFunction()

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

inline

See also

RangedAudioParameterAttributes::withValueFromStringFunction()

References attributes, juce::withMember(), and juce::RangedAudioParameterAttributes< Derived, Value >::withValueFromStringFunction().

Member Data Documentation

attributes

AudioParameterFloatAttributes juce::AudioProcessorValueTreeStateParameterAttributes::attributes

private

Referenced by getAudioParameterFloatAttributes(), withAutomatable(), withCategory(), withInverted(), withLabel(), withMeta(), withStringFromValueFunction(), and withValueFromStringFunction().

boolean

bool juce::AudioProcessorValueTreeStateParameterAttributes::boolean = false

private

Referenced by getBoolean(), and withBoolean().

discrete

bool juce::AudioProcessorValueTreeStateParameterAttributes::discrete = false

private

Referenced by getDiscrete(), and withDiscrete().

---

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

• juce_AudioProcessorValueTreeState.h