Skip to main content

Node Properties: parameter

The parameter node supports the following properties:

Basic Properties

index (required)

Type: unsigned int

The zero-based index of the plugin parameter.

name

Type: string

The name to display for this parameter instead of the default plugin parameter name.

valueMinimum

Type: int

The minimum value of this parameter.

valueMaximum

Type: int

The maximum value of this parameter.

valueDefault

Type: int

The default value of this parameter.

isIntRange

Type: bool

Set to true if the value range of this parameter is integer-based.

isToggle

Type: bool

Set to true if this parameter is a simple Off/On toggle. Implicitly sets valueMinimum, valueMaximum, and isIntRange.

valueTexts

Type: array of string

An array of strings representing the value texts for this parameter. Implicitly sets valueMinimum, valueMaximum, and isIntRange.

unit

Type: string

The unit of this parameter's value (e.g., "Hz", "dB").


Advanced Properties

matchedName

Type: string

The name of this parameter that should match the extracted parameter name if ParameterNames is set as matchingMode on the module.

quantizeDefault

Type: int

The default value of this parameter when the quantize mode is enabled.

quantizeMinimum

Type: int

The minimum value of this parameter when the quantize mode is enabled.

quantizeMaximum

Type: int

The maximum value of this parameter when the quantize mode is enabled.

hide

Type: bool

Set to true to hide a parameter. Useful when using a matchingMode that requires all parameters to be present in a module for detection purposes but some of these parameters are actually unused.

unusedIf

Type: string (math expression)

A math expression that evaluates whether this parameter is unused. Use p10 to refer to the value of the parameter at index 10. If no matchingMode is defined for this module, p10 evaluates the global parameter index. If a matchingMode is defined, p10 refers to the parameter index relative to the module's first parameter. If the expression evaluates to 1.0, the parameter is considered unused (it will be greyed out and stop displaying a parameter value on the E1).

hideIfUnused

Type: bool

Set to true to hide a parameter that is considered unused (via the unusedIf property) instead of displaying it as greyed out.

valueExpression

Type: string

A mathematical expression to convert a plugin's normalized parameter value (ranging from 0.0 to 1.0) into a more meaningful value (e.g., from 20 Hz to 20,000 Hz). This is especially useful for plugins that don't report their parameter values in meaningful units, such as those in Reason Rack or VCV Rack.

The current normalized parameter value from the plugin is represented by the variable x. For example, to map a normalized parameter to a range of -20 to 20, the expression can be written as (x * 40) - 20.

formattingProfile

Type: string (key)

A string that matches an existing formatting profile which will be used to format the result of a value expression.

unitConversionProfiles

Type: array of string

An array of unit conversion profiles that will be applied to this value expression.