param Reference

Define a parameter that can control RNBO externally

param

Examples

Arguments

name [symbol]

A param object will receive numerical messages sent to rnbo~ in a format containing the parameter name followed by the message to be sent. Each param object within a RNBO patcher must have a unique name.

Messages can also be sent and received using the parameter name once a RNBO patch is exported to an external target. See the RNBO API Reference for guides on target specific syntax.

value [number]

Optional

Pass values to the output of param from within the RNBO patcher.

value [number]

Optional

Sets an initial value to be sent to param 's output on the initialization of a RNBO external target

Inlets

value [number]

Pass values to the output of param from within the RNBO patcher.

normalizedvalue [number]

Set value normalized.

Outlets

value [number]

Pass values to the output of param from within the RNBO patcher.

normalized [number]

The normalized output is used for processing and scaling the input of param . The default output will be the bounded @min and @max range of the input scaled between 0. and 1.

The normalized output can also be processed with exponential scaling using @exponent and with mathematical expressions in expr format using @tonormalized .

Fixed Attributes

These attributes must be set in the object box and determine the behavior of the object at runtime.

ctlin [number]

MIDI controller number to control this parameter.

displayname [symbol]

A more readable name for the parameter in an external RNBO target

enum [list]

A list of enumerated values can be set using a list of symbols, e.g. @enum one two three . Sending a message that contains the parameter name followed by any of the symbols provided will output the corresponding enumerated value.

For more information on enums, see RNBO parameters .

exponent [number] (default: 1)

Using an exponent will scale the normalized output (right outlet) by a provided exponential degree.

fromnormalized [symbol]

@fromnormalized will modify the input of param based on a provided mathematical expression. The resulting output is sent to any fromnormalized objects that share the same parameter name. The output, which must be bounded within a @min and @max range, will be modified based on the mathematical expression given an input between 0. and 1.

Expressions are written in expr format using the keyword value as the input variable. For instance, @fromnormalized pow(value, 2)+3 will produce the input value plus 3, raised to the 2nd power. For more info on expr format, see Designing Equations .

maximum [number] (default: 1)

Sets a bounded maximum value for the parameter output. Values sent to param that are below the minimum value will not be sent to the output.

meta [symbol]

A JSON formatted string containing metadata for use by the exported code.

@meta can be used to pass on any information for custom needs via the exported description.json file. This has potential use for hardware mappings/routings, UI generation, advanced toolchain integration, etc.

minimum [number] (default: 0)

Sets a bounded minimum value for the parameter output. Values sent to param that are below the minimum value will not be sent to the output.

name [symbol]

A param object will receive numerical messages sent to rnbo~ in a format containing the parameter name followed by the message to be sent. Each param object within a RNBO patcher must have a unique name.

Messages can also be sent and received using the parameter name once a RNBO patch is exported to an external target. See the RNBO API Reference for guides on target specific syntax.

order [symbol] (default: 0)

Order in which initial parameter values will be sent out on patcher load. The order can be numeric or symbolic ('first' and 'last')

preset [bool] (default: true)

Add this value to the preset.

sendinit [bool] (default: true)

Set whether or not to send the param object's initial value to the output

steps [number] (default: 0)

Setting the number of steps allows a numerical input to be divided into discrete steps. For instance, a step value of 5 will divide input ranging from 0-100 into values of 0, 25, 50, 75, and 100.

tonormalized [symbol]

@tonormalized will modify the input of param based on a provided mathematical expression. The resulting output is sent to the right outlet and to any tonormalized objects that share the same parameter name. The default normalized output between 0. and 1. is replaced with the output of the provided expression. When used along side @min and @max , the range (output) of the expression is unbounded, however, the domain (input) is bounded.

Expressions are written in expr format using the keyword value as the input variable. For instance, @tonormalized pow(value, 2)+3 will produce the input value plus 3, raised to the 2nd power. For more info on expr format, see Designing Equations .

unit [symbol]

A symbol to describe the unit of the parameter in an external RNBO target

value [number] (default: 0)

Sets an initial value to be sent to param 's output on the initialization of a RNBO external target

Dynamic Attributes

These attributes can be modified in the code during execution using the set object

normalizedvalue [number]

Set value normalized.

reset [bang]

Reset param to initial value

value [number]

Pass values to the output of param from within the RNBO patcher.

See Also

Name Description
param~ Define a parameter that can control RNBO externally
tonormalized Define numerical parameters for RNBO that can be accessed by the target platform.
fromnormalized Define numerical parameters for RNBO that can be accessed by the target platform.
gen~ gen~
set set value of attributes and parameters