juce::ParameterID Class Reference

Combines a parameter ID and a version hint. More...

#include <juce_AudioProcessorParameterWithID.h>

Collaboration diagram for juce::ParameterID:

Public Member Functions
	ParameterID ()=default
template<typename StringLike , typename = DisableIfSameOrDerived<ParameterID, StringLike>>
	ParameterID (StringLike &&identifier, int versionHint=0)
	Constructs an instance. More...
auto	getParamID () const
auto	getVersionHint () const

Private Attributes
String	paramID
int	version = 0

Detailed Description

Combines a parameter ID and a version hint.

Constructor & Destructor Documentation

ParameterID() [1/2]

juce::ParameterID::ParameterID ( )

default

ParameterID() [2/2]

template<typename StringLike , typename = DisableIfSameOrDerived<ParameterID, StringLike>>

juce::ParameterID::ParameterID ( StringLike &&  identifier, int  versionHint = 0  )

inline

Constructs an instance.

Note that this constructor implicitly converts from Strings and string-like types.

Parameters

identifier	A string that uniquely identifies a single parameter
versionHint	Influences parameter ordering in Audio Unit plugins. Used to provide backwards compatibility of Audio Unit plugins in Logic and GarageBand.

See also

AudioProcessorParameter(int)

Member Function Documentation

getParamID()

auto juce::ParameterID::getParamID ( ) const

inline

See also

AudioProcessorParameterWithID::paramID

References paramID.

getVersionHint()

auto juce::ParameterID::getVersionHint ( ) const

inline

See also

AudioProcessorParameter(int)

References version.

Member Data Documentation

paramID

String juce::ParameterID::paramID

private

Referenced by getParamID().

version

int juce::ParameterID::version = 0

private

Referenced by getVersionHint().

---

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

• juce_AudioProcessorParameterWithID.h