juce::AudioParameterBoolAttributes Class Reference

Properties of an AudioParameterBool. More...

#include <juce_AudioParameterBool.h>

Inheritance diagram for juce::AudioParameterBoolAttributes:

Collaboration diagram for juce::AudioParameterBoolAttributes:

Public Types
using	Category = AudioProcessorParameter::Category
using	StringFromValue = std::function< String(bool, int)>
using	ValueFromString = std::function< bool(const String &)>

Public Member Functions
const auto &	getAudioProcessorParameterWithIDAttributes () const
	Gets attributes that would also apply to an AudioProcessorParameterWithID.
const auto &	getStringFromValueFunction () const
	An optional lambda function that converts a non-normalised value to a string with a maximum length.
const auto &	getValueFromStringFunction () const
	An optional lambda function that parses a string and converts it into a non-normalised value.
auto	withAutomatable (bool x) const
	See AudioProcessorParameter::isAutomatable()
auto	withCategory (Category x) const
	See AudioProcessorParameterWithIDAttributes::withCategory()
auto	withInverted (bool x) const
	See AudioProcessorParameter::isOrientationInverted()
auto	withLabel (String x) const
	See AudioProcessorParameterWithIDAttributes::withLabel()
auto	withMeta (bool x) const
	See AudioProcessorParameter::isMetaParameter()
auto	withStringFromValueFunction (StringFromValue x) const
	An optional lambda function that converts a non-normalised value to a string with a maximum length.
auto	withValueFromStringFunction (ValueFromString x) const
	An optional lambda function that parses a string and converts it into a non-normalised value.

Private Types
using	This = RangedAudioParameterAttributes

Private Member Functions
auto &	asDerived () const

Private Attributes
AudioProcessorParameterWithIDAttributes	attributes
StringFromValue	stringFromValue
ValueFromString	valueFromString

Detailed Description

Properties of an AudioParameterBool.

See also

AudioParameterBool(), RangedAudioParameterAttributes()

@tags{Audio}

Member Typedef Documentation

Category

using juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::Category = AudioProcessorParameter::Category

inherited

StringFromValue

using juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::StringFromValue = std::function<String (bool , int)>

inherited

This

using juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::This = RangedAudioParameterAttributes

privateinherited

ValueFromString

using juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::ValueFromString = std::function<bool (const String&)>

inherited

Member Function Documentation

asDerived()

auto & juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::asDerived ( ) const

inlineprivateinherited

getAudioProcessorParameterWithIDAttributes()

const auto & juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::getAudioProcessorParameterWithIDAttributes ( ) const

inlineinherited

Gets attributes that would also apply to an AudioProcessorParameterWithID.

getStringFromValueFunction()

const auto & juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::getStringFromValueFunction ( ) const

inlineinherited

An optional lambda function that converts a non-normalised value to a string with a maximum length.

This may be used by hosts to display the parameter's value.

getValueFromStringFunction()

const auto & juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::getValueFromStringFunction ( ) const

inlineinherited

An optional lambda function that parses a string and converts it into a non-normalised value.

Some hosts use this to allow users to type in parameter values.

withAutomatable()

auto juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::withAutomatable ( bool  x ) const

inlineinherited

See AudioProcessorParameter::isAutomatable()

withCategory()

auto juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::withCategory ( Category  x ) const

inlineinherited

See AudioProcessorParameterWithIDAttributes::withCategory()

withInverted()

auto juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::withInverted ( bool  x ) const

inlineinherited

See AudioProcessorParameter::isOrientationInverted()

withLabel()

auto juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::withLabel ( String  x ) const

inlineinherited

See AudioProcessorParameterWithIDAttributes::withLabel()

withMeta()

auto juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::withMeta ( bool  x ) const

inlineinherited

See AudioProcessorParameter::isMetaParameter()

withStringFromValueFunction()

auto juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::withStringFromValueFunction ( StringFromValue  x ) const

inlineinherited

An optional lambda function that converts a non-normalised value to a string with a maximum length.

This may be used by hosts to display the parameter's value.

withValueFromStringFunction()

auto juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::withValueFromStringFunction ( ValueFromString  x ) const

inlineinherited

An optional lambda function that parses a string and converts it into a non-normalised value.

Some hosts use this to allow users to type in parameter values.

Member Data Documentation

attributes

AudioProcessorParameterWithIDAttributes juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::attributes

privateinherited

stringFromValue

StringFromValue juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::stringFromValue

privateinherited

valueFromString

ValueFromString juce::RangedAudioParameterAttributes< AudioParameterBoolAttributes , bool >::valueFromString

privateinherited

---

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

• juce_AudioParameterBool.h