Public Types | |
using | Category = AudioProcessorParameter::Category |
using | StringFromValue = std::function< String(Value, int)> |
using | ValueFromString = std::function< Value(const String &)> |
Public Member Functions | |
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. | |
auto | withLabel (String x) const |
See AudioProcessorParameterWithIDAttributes::withLabel() | |
auto | withCategory (Category x) const |
See AudioProcessorParameterWithIDAttributes::withCategory() | |
auto | withMeta (bool x) const |
See AudioProcessorParameter::isMetaParameter() | |
auto | withAutomatable (bool x) const |
See AudioProcessorParameter::isAutomatable() | |
auto | withInverted (bool x) const |
See AudioProcessorParameter::isOrientationInverted() | |
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. | |
const auto & | getAudioProcessorParameterWithIDAttributes () const |
Gets attributes that would also apply to an AudioProcessorParameterWithID. | |
Holds common attributes of audio parameters.
CRTP is used here because we want the Attributes types for each parameter (Float, Bool, Choice, Int) to be distinct and extensible in the future. i.e. the identifiers AudioParameterFloatAttributes and RangedAudioParameterAttributes<float> should not be interchangable because we might need to add float-specific attributes in the future. Users should not refer directly to RangedAudioParameterAttributes.
using RangedAudioParameterAttributes< Derived, Value >::Category = AudioProcessorParameter::Category |
using RangedAudioParameterAttributes< Derived, Value >::StringFromValue = std::function<String (Value, int)> |
using RangedAudioParameterAttributes< Derived, Value >::ValueFromString = std::function<Value (const String&)> |
auto RangedAudioParameterAttributes< Derived, Value >::withStringFromValueFunction | ( | StringFromValue | x | ) | const |
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.
References withMember().
Referenced by AudioProcessorValueTreeStateParameterAttributes::withStringFromValueFunction().
auto RangedAudioParameterAttributes< Derived, Value >::withValueFromStringFunction | ( | ValueFromString | x | ) | const |
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.
References withMember().
Referenced by AudioProcessorValueTreeStateParameterAttributes::withValueFromStringFunction().
auto RangedAudioParameterAttributes< Derived, Value >::withLabel | ( | String | x | ) | const |
auto RangedAudioParameterAttributes< Derived, Value >::withCategory | ( | Category | x | ) | const |
auto RangedAudioParameterAttributes< Derived, Value >::withMeta | ( | bool | x | ) | const |
auto RangedAudioParameterAttributes< Derived, Value >::withAutomatable | ( | bool | x | ) | const |
auto RangedAudioParameterAttributes< Derived, Value >::withInverted | ( | bool | x | ) | const |
const auto & RangedAudioParameterAttributes< Derived, Value >::getStringFromValueFunction | ( | ) | const |
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.
const auto & RangedAudioParameterAttributes< Derived, Value >::getValueFromStringFunction | ( | ) | const |
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.
const auto & RangedAudioParameterAttributes< Derived, Value >::getAudioProcessorParameterWithIDAttributes | ( | ) | const |
Gets attributes that would also apply to an AudioProcessorParameterWithID.