juce::AudioProcessorParameterWithIDAttributes Class Reference

An instance of this class may be passed to the constructor of an AudioProcessorParameterWithID to set optional characteristics of that parameter. More...

#include <juce_AudioProcessorParameterWithID.h>

Collaboration diagram for juce::AudioProcessorParameterWithIDAttributes:

Public Types
using	Category = AudioProcessorParameter::Category

Public Member Functions
auto	getAutomatable () const
auto	getCategory () const
	The semantics of this parameter.
auto	getInverted () const
auto	getLabel () const
	An optional label for the parameter's value.
auto	getMeta () const
auto	withAutomatable (bool x) const
auto	withCategory (Category x) const
	The semantics of this parameter.
auto	withInverted (bool x) const
auto	withLabel (String x) const
	An optional label for the parameter's value.
auto	withMeta (bool x) const

Private Types
using	This = AudioProcessorParameterWithIDAttributes

Private Attributes
bool	automatable = true
Category	category = AudioProcessorParameter::genericParameter
bool	inverted = false
String	label
bool	meta = false

Detailed Description

An instance of this class may be passed to the constructor of an AudioProcessorParameterWithID to set optional characteristics of that parameter.

@tags{Audio}

Member Typedef Documentation

Category

using juce::AudioProcessorParameterWithIDAttributes::Category = AudioProcessorParameter::Category

This

using juce::AudioProcessorParameterWithIDAttributes::This = AudioProcessorParameterWithIDAttributes

private

Member Function Documentation

getAutomatable()

auto juce::AudioProcessorParameterWithIDAttributes::getAutomatable ( ) const

inline

See also

AudioProcessorParameter::isAutomatable()

References automatable.

getCategory()

auto juce::AudioProcessorParameterWithIDAttributes::getCategory ( ) const

inline

The semantics of this parameter.

References category.

getInverted()

auto juce::AudioProcessorParameterWithIDAttributes::getInverted ( ) const

inline

See also

AudioProcessorParameter::isOrientationInverted()

References inverted.

getLabel()

auto juce::AudioProcessorParameterWithIDAttributes::getLabel ( ) const

inline

An optional label for the parameter's value.

References label.

getMeta()

auto juce::AudioProcessorParameterWithIDAttributes::getMeta ( ) const

inline

See also

AudioProcessorParameter::isMetaParameter()

References meta.

withAutomatable()

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

inline

See also

AudioProcessorParameter::isAutomatable()

References automatable, and juce::withMember().

Referenced by juce::RangedAudioParameterAttributes< Derived, Value >::withAutomatable().

withCategory()

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

inline

The semantics of this parameter.

References category, and juce::withMember().

Referenced by juce::RangedAudioParameterAttributes< Derived, Value >::withCategory().

withInverted()

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

inline

See also

AudioProcessorParameter::isOrientationInverted()

References inverted, and juce::withMember().

Referenced by juce::RangedAudioParameterAttributes< Derived, Value >::withInverted().

withLabel()

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

inline

An optional label for the parameter's value.

References label, and juce::withMember().

Referenced by juce::RangedAudioParameterAttributes< Derived, Value >::withLabel().

withMeta()

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

inline

See also

AudioProcessorParameter::isMetaParameter()

References meta, and juce::withMember().

Referenced by juce::RangedAudioParameterAttributes< Derived, Value >::withMeta().

Member Data Documentation

automatable

bool juce::AudioProcessorParameterWithIDAttributes::automatable = true

private

Referenced by getAutomatable(), and withAutomatable().

category

Category juce::AudioProcessorParameterWithIDAttributes::category = AudioProcessorParameter::genericParameter

private

Referenced by getCategory(), and withCategory().

inverted

bool juce::AudioProcessorParameterWithIDAttributes::inverted = false

private

Referenced by getInverted(), and withInverted().

label

String juce::AudioProcessorParameterWithIDAttributes::label

private

Referenced by getLabel(), and withLabel().

meta

bool juce::AudioProcessorParameterWithIDAttributes::meta = false

private

Referenced by getMeta(), and withMeta().

---

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

• juce_AudioProcessorParameterWithID.h