param~
Define a parameter that can control RNBO externally
Description
param~ will create and expose a parameter within a RNBO patcher to the parent Max patch and to any target platform. This allows for easy control of parameter values, as well as reference of parameter states outside of the RNBO patcher.
Unlike inport , param~ processes numerical values and outputs signal values. param~ also contains built-in bounding and exponential scaling that can be used to process and scale these incoming messages.
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 for guides on target specific syntax.
Inlets
value [number]
Pass values to the output of param~ from within the RNBO patcher.
Outlets
out [signal]
The processed parameter value as a signal, received by either the RNBO subpatcher or by any external RNBO targets
Fixed Attributes
These attributes must be set in the object box and determine the behavior of the object at runtime.
displayname [symbol]
A more readable name for the parameter in an external RNBO target
displayorder [symbol] (default: -)
Order in which parameters will show up in a list of all parameters. The order can be numeric or symbolic ('first' and 'last').
exponent [number] (default: 1)
Using an exponent will scale the output by a provided exponential degree.
id [symbol]
DEPRECATED
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 for guides on target specific syntax.
steps [number] (default: 0)
Divide the output into a number of discrete steps
unit [symbol]
A symbol to describe the unit of the parameter in an external RNBO target
Dynamic Attributes
These attributes can be modified in the code during execution using the set object
audioinlet [signal]
audioinlet
sigin [signal]
sigin
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 signal parameters for RNBO that can be accessed by the target platform. |
| fromnormalized~ | Define signal parameters for RNBO that can be accessed by the target platform. |
| gen~ | gen~ |
| set | set value of attributes and parameters |