LMMS
Loading...
Searching...
No Matches
juce::RangedAudioParameterAttributes< Derived, Value > Class Template Reference

#include <juce_RangedAudioParameter.h>

Public Types

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

Public Member Functions

JUCE_NODISCARD auto withStringFromValueFunction (StringFromValue x) const
JUCE_NODISCARD auto withValueFromStringFunction (ValueFromString x) const
JUCE_NODISCARD auto withLabel (String x) const
JUCE_NODISCARD auto withCategory (Category x) const
JUCE_NODISCARD auto withMeta (bool x) const
JUCE_NODISCARD auto withAutomatable (bool x) const
JUCE_NODISCARD auto withInverted (bool x) const
JUCE_NODISCARD const auto & getStringFromValueFunction () const
JUCE_NODISCARD const auto & getValueFromStringFunction () const
JUCE_NODISCARD const auto & getAudioProcessorParameterWithIDAttributes () const

Private Types

using This = RangedAudioParameterAttributes

Private Member Functions

auto & asDerived () const

Private Attributes

AudioProcessorParameterWithIDAttributes attributes
StringFromValue stringFromValue
ValueFromString valueFromString

Member Typedef Documentation

◆ Category

template<typename Derived, typename Value>
using juce::RangedAudioParameterAttributes< Derived, Value >::Category = AudioProcessorParameter::Category

◆ StringFromValue

template<typename Derived, typename Value>
using juce::RangedAudioParameterAttributes< Derived, Value >::StringFromValue = std::function<String (Value, int)>

◆ This

template<typename Derived, typename Value>
using juce::RangedAudioParameterAttributes< Derived, Value >::This = RangedAudioParameterAttributes
private

◆ ValueFromString

template<typename Derived, typename Value>
using juce::RangedAudioParameterAttributes< Derived, Value >::ValueFromString = std::function<Value (const String&)>

Member Function Documentation

◆ asDerived()

template<typename Derived, typename Value>
auto & juce::RangedAudioParameterAttributes< Derived, Value >::asDerived ( ) const
inlineprivate

◆ getAudioProcessorParameterWithIDAttributes()

template<typename Derived, typename Value>
JUCE_NODISCARD const auto & juce::RangedAudioParameterAttributes< Derived, Value >::getAudioProcessorParameterWithIDAttributes ( ) const
inline

Gets attributes that would also apply to an AudioProcessorParameterWithID

◆ getStringFromValueFunction()

template<typename Derived, typename Value>
JUCE_NODISCARD const auto & juce::RangedAudioParameterAttributes< Derived, Value >::getStringFromValueFunction ( ) const
inline

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

template<typename Derived, typename Value>
JUCE_NODISCARD const auto & juce::RangedAudioParameterAttributes< Derived, Value >::getValueFromStringFunction ( ) const
inline

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

template<typename Derived, typename Value>
JUCE_NODISCARD auto juce::RangedAudioParameterAttributes< Derived, Value >::withAutomatable ( bool x) const
inline

See AudioProcessorParameter::isAutomatable()

◆ withCategory()

template<typename Derived, typename Value>
JUCE_NODISCARD auto juce::RangedAudioParameterAttributes< Derived, Value >::withCategory ( Category x) const
inline

See AudioProcessorParameterWithIDAttributes::withCategory()

◆ withInverted()

template<typename Derived, typename Value>
JUCE_NODISCARD auto juce::RangedAudioParameterAttributes< Derived, Value >::withInverted ( bool x) const
inline

See AudioProcessorParameter::isOrientationInverted()

◆ withLabel()

template<typename Derived, typename Value>
JUCE_NODISCARD auto juce::RangedAudioParameterAttributes< Derived, Value >::withLabel ( String x) const
inline

See AudioProcessorParameterWithIDAttributes::withLabel()

◆ withMeta()

template<typename Derived, typename Value>
JUCE_NODISCARD auto juce::RangedAudioParameterAttributes< Derived, Value >::withMeta ( bool x) const
inline

See AudioProcessorParameter::isMetaParameter()

◆ withStringFromValueFunction()

template<typename Derived, typename Value>
JUCE_NODISCARD auto juce::RangedAudioParameterAttributes< Derived, Value >::withStringFromValueFunction ( StringFromValue x) const
inline

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

template<typename Derived, typename Value>
JUCE_NODISCARD auto juce::RangedAudioParameterAttributes< Derived, Value >::withValueFromStringFunction ( ValueFromString x) const
inline

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

template<typename Derived, typename Value>
AudioProcessorParameterWithIDAttributes juce::RangedAudioParameterAttributes< Derived, Value >::attributes
private

◆ stringFromValue

template<typename Derived, typename Value>
StringFromValue juce::RangedAudioParameterAttributes< Derived, Value >::stringFromValue
private

◆ valueFromString

template<typename Derived, typename Value>
ValueFromString juce::RangedAudioParameterAttributes< Derived, Value >::valueFromString
private

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