Mema
Memory Matrix — multi-channel audio matrix monitor and router
Loading...
Searching...
No Matches
Mema::PluginParameterInfo Struct Reference

Metadata describing a single plugin parameter exposed for remote control. More...

#include <MemaPluginParameterInfo.h>

Public Member Functions

bool operator== (const PluginParameterInfo &other) const
 
bool operator!= (const PluginParameterInfo &other) const
 
bool operator< (const PluginParameterInfo &other) const
 
bool operator> (const PluginParameterInfo &other) const
 
bool operator<= (const PluginParameterInfo &other) const
 
bool operator>= (const PluginParameterInfo &other) const
 
juce::String toString () const
 
bool initializeFromString (const juce::String &parameterString)
 
bool initializeFromAudioProcessorParameter (juce::AudioProcessorParameter &processorParameter)
 

Static Public Member Functions

static PluginParameterInfo fromString (const juce::String &parameterString)
 
static PluginParameterInfo fromAudioProcessorParameter (juce::AudioProcessorParameter &processorParameter)
 
static std::vector< PluginParameterInfoparametersToInfos (juce::Array< juce::AudioProcessorParameter * > processorParameters)
 

Public Attributes

int index = 0
 Zero-based parameter index within the plugin.
 
juce::String id = "0"
 Unique string identifier of the parameter.
 
juce::String name = ""
 Human-readable parameter name.
 
float defaultValue = 0.0f
 Factory default value (normalised 0..1).
 
float currentValue = 0.0f
 Current parameter value (normalised 0..1).
 
juce::String label = ""
 Unit label (e.g. "dB", "Hz").
 
bool isAutomatable = false
 Whether the host can automate this parameter.
 
bool isRemoteControllable = true
 Whether this parameter is exposed for remote control.
 
juce::AudioProcessorParameter::Category category = juce::AudioProcessorParameter::Category::genericParameter
 JUCE parameter category.
 
float minValue = 0.0f
 Minimum value in the parameter's native range.
 
float maxValue = 1.0f
 Maximum value in the parameter's native range.
 
float stepSize = 0.0f
 Step interval for discrete parameters (0 = continuous).
 
bool isDiscrete = false
 True if the parameter has a finite set of steps.
 
ParameterControlType type = ParameterControlType::Continuous
 Control widget type (slider, combo, toggle).
 
int stepCount = 0
 Number of discrete steps (0 if continuous).
 
std::vector< std::string > stepNames
 Display names for each discrete step.
 

Detailed Description

Metadata describing a single plugin parameter exposed for remote control.

Definition at line 33 of file MemaPluginParameterInfo.h.

Member Function Documentation

◆ fromAudioProcessorParameter()

static PluginParameterInfo Mema::PluginParameterInfo::fromAudioProcessorParameter ( juce::AudioProcessorParameter &  processorParameter)
inlinestatic

◆ fromString()

static PluginParameterInfo Mema::PluginParameterInfo::fromString ( const juce::String &  parameterString)
inlinestatic

Definition at line 161 of file MemaPluginParameterInfo.h.

References initializeFromString().

Referenced by Mema::MemaProcessor::setStateXml().

◆ initializeFromAudioProcessorParameter()

bool Mema::PluginParameterInfo::initializeFromAudioProcessorParameter ( juce::AudioProcessorParameter &  processorParameter)
inline

◆ initializeFromString()

bool Mema::PluginParameterInfo::initializeFromString ( const juce::String &  parameterString)
inline

◆ operator!=()

bool Mema::PluginParameterInfo::operator!= ( const PluginParameterInfo other) const
inline

Definition at line 73 of file MemaPluginParameterInfo.h.

◆ operator<()

bool Mema::PluginParameterInfo::operator< ( const PluginParameterInfo other) const
inline

Definition at line 79 of file MemaPluginParameterInfo.h.

References id, and index.

◆ operator<=()

bool Mema::PluginParameterInfo::operator<= ( const PluginParameterInfo other) const
inline

Definition at line 93 of file MemaPluginParameterInfo.h.

◆ operator==()

bool Mema::PluginParameterInfo::operator== ( const PluginParameterInfo other) const
inline

◆ operator>()

bool Mema::PluginParameterInfo::operator> ( const PluginParameterInfo other) const
inline

Definition at line 87 of file MemaPluginParameterInfo.h.

◆ operator>=()

bool Mema::PluginParameterInfo::operator>= ( const PluginParameterInfo other) const
inline

Definition at line 99 of file MemaPluginParameterInfo.h.

◆ parametersToInfos()

static std::vector< PluginParameterInfo > Mema::PluginParameterInfo::parametersToInfos ( juce::Array< juce::AudioProcessorParameter * >  processorParameters)
inlinestatic

◆ toString()

juce::String Mema::PluginParameterInfo::toString ( ) const
inline

Member Data Documentation

◆ category

juce::AudioProcessorParameter::Category Mema::PluginParameterInfo::category = juce::AudioProcessorParameter::Category::genericParameter

◆ currentValue

float Mema::PluginParameterInfo::currentValue = 0.0f

◆ defaultValue

float Mema::PluginParameterInfo::defaultValue = 0.0f

◆ id

juce::String Mema::PluginParameterInfo::id = "0"

Unique string identifier of the parameter.

Definition at line 36 of file MemaPluginParameterInfo.h.

Referenced by operator<(), operator==(), and Mema::PluginParameterInfosMessage::PluginParameterInfosMessage().

◆ index

int Mema::PluginParameterInfo::index = 0

◆ isAutomatable

bool Mema::PluginParameterInfo::isAutomatable = false

◆ isDiscrete

bool Mema::PluginParameterInfo::isDiscrete = false

◆ isRemoteControllable

bool Mema::PluginParameterInfo::isRemoteControllable = true

◆ label

juce::String Mema::PluginParameterInfo::label = ""

◆ maxValue

float Mema::PluginParameterInfo::maxValue = 1.0f

◆ minValue

float Mema::PluginParameterInfo::minValue = 0.0f

◆ name

juce::String Mema::PluginParameterInfo::name = ""

◆ stepCount

int Mema::PluginParameterInfo::stepCount = 0

Number of discrete steps (0 if continuous).

Definition at line 49 of file MemaPluginParameterInfo.h.

Referenced by initializeFromString(), operator==(), Mema::PluginParameterInfosMessage::PluginParameterInfosMessage(), and toString().

◆ stepNames

std::vector<std::string> Mema::PluginParameterInfo::stepNames

Display names for each discrete step.

Definition at line 50 of file MemaPluginParameterInfo.h.

Referenced by initializeFromString(), Mema::PluginParameterInfosMessage::PluginParameterInfosMessage(), and toString().

◆ stepSize

float Mema::PluginParameterInfo::stepSize = 0.0f

◆ type

ParameterControlType Mema::PluginParameterInfo::type = ParameterControlType::Continuous

Control widget type (slider, combo, toggle).

Definition at line 48 of file MemaPluginParameterInfo.h.

Referenced by initializeFromString(), operator==(), Mema::PluginParameterInfosMessage::PluginParameterInfosMessage(), and toString().


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