Loading...
Searching...
No Matches
Public Types | Public Member Functions | List of all members
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

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 autogetStringFromValueFunction () const
 An optional lambda function that converts a non-normalised value to a string with a maximum length.
 
const autogetValueFromStringFunction () const
 An optional lambda function that parses a string and converts it into a non-normalised value.
 
const autogetAudioProcessorParameterWithIDAttributes () const
 Gets attributes that would also apply to an AudioProcessorParameterWithID.
 

Member Typedef Documentation

◆ Category

◆ StringFromValue

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

◆ ValueFromString

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

Member Function Documentation

◆ withStringFromValueFunction()

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(), and x.

Referenced by AudioProcessorValueTreeStateParameterAttributes::withStringFromValueFunction().

◆ withValueFromStringFunction()

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(), and x.

Referenced by AudioProcessorValueTreeStateParameterAttributes::withValueFromStringFunction().

◆ withLabel()

◆ withCategory()

◆ withMeta()

◆ withAutomatable()

auto RangedAudioParameterAttributes< Derived, Value >::withAutomatable ( bool x) const

◆ withInverted()

auto RangedAudioParameterAttributes< Derived, Value >::withInverted ( bool x) const

◆ getStringFromValueFunction()

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.

◆ getValueFromStringFunction()

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.

◆ getAudioProcessorParameterWithIDAttributes()

const auto & RangedAudioParameterAttributes< Derived, Value >::getAudioProcessorParameterWithIDAttributes ( ) const

Gets attributes that would also apply to an AudioProcessorParameterWithID.


The documentation for this class was generated from the following file:
linkedin facebook pinterest youtube rss twitter instagram facebook-blank rss-blank linkedin-blank pinterest youtube twitter instagram