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
JUCE_NODISCARD auto	getAutomatable () const
JUCE_NODISCARD auto	getCategory () const
	The semantics of this parameter. More...
JUCE_NODISCARD auto	getInverted () const
JUCE_NODISCARD auto	getLabel () const
	An optional label for the parameter's value. More...
JUCE_NODISCARD auto	getMeta () const
JUCE_NODISCARD auto	withAutomatable (bool x) const
JUCE_NODISCARD auto	withCategory (Category x) const
	The semantics of this parameter. More...
JUCE_NODISCARD auto	withInverted (bool x) const
JUCE_NODISCARD auto	withLabel (String x) const
	An optional label for the parameter's value. More...
JUCE_NODISCARD 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.

Member Typedef Documentation

Category

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

This

using juce::AudioProcessorParameterWithIDAttributes::This = AudioProcessorParameterWithIDAttributes

private

Member Function Documentation

getAutomatable()

JUCE_NODISCARD auto juce::AudioProcessorParameterWithIDAttributes::getAutomatable ( ) const

inline

See also

AudioProcessorParameter::isAutomatable()

References automatable.

getCategory()

JUCE_NODISCARD auto juce::AudioProcessorParameterWithIDAttributes::getCategory ( ) const

inline

The semantics of this parameter.

References category.

getInverted()

JUCE_NODISCARD auto juce::AudioProcessorParameterWithIDAttributes::getInverted ( ) const

inline

See also

AudioProcessorParameter::isOrientationInverted()

References inverted.

getLabel()

JUCE_NODISCARD auto juce::AudioProcessorParameterWithIDAttributes::getLabel ( ) const

inline

An optional label for the parameter's value.

References label.

getMeta()

JUCE_NODISCARD auto juce::AudioProcessorParameterWithIDAttributes::getMeta ( ) const

inline

See also

AudioProcessorParameter::isMetaParameter()

References meta.

withAutomatable()

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

inline

See also

AudioProcessorParameter::isAutomatable()

References automatable, juce::withMember(), and juce::gl::x.

Referenced by juce::RangedAudioParameterAttributes< AudioParameterChoiceAttributes, int >::withAutomatable().

withCategory()

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

inline

The semantics of this parameter.

References category, juce::withMember(), and juce::gl::x.

Referenced by juce::RangedAudioParameterAttributes< AudioParameterChoiceAttributes, int >::withCategory().

withInverted()

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

inline

See also

AudioProcessorParameter::isOrientationInverted()

References inverted, juce::withMember(), and juce::gl::x.

Referenced by juce::RangedAudioParameterAttributes< AudioParameterChoiceAttributes, int >::withInverted().

withLabel()

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

inline

An optional label for the parameter's value.

References label, juce::withMember(), and juce::gl::x.

Referenced by juce::RangedAudioParameterAttributes< AudioParameterChoiceAttributes, int >::withLabel().

withMeta()

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

inline

See also

AudioProcessorParameter::isMetaParameter()

References meta, juce::withMember(), and juce::gl::x.

Referenced by juce::RangedAudioParameterAttributes< AudioParameterChoiceAttributes, int >::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