rnbo~ Reference

The rnbo~ object is a Max wrapper for RNBO technology

rnbo~

Examples

Arguments

None.

Attributes

active [int] (default: 1)

Enable/disable event and signal processing within the rnbo~ object.

annotation_name [symbol] (default: )

The string that is prepended to annotations. This shows up in the Info pane in Live, and the clue window in Max.

autobuild [int] (default: 1)

When Automatic Rebuild is enabled, changes to the rnbo~ patcher will cause the rnbo~ patcher to recompile. Disabling this will disable the auto-compilation feature of the rnbo~ patcher.

autosave [int] (default: 1)

Allows for snapshots of the rnbo~ object to be saved as presets.

exposevoiceparams [int] (default: 0)

Expose parameters for each polyphonic voice. The number of voices will be determined by the polyphony attribute

optimization [symbol]

Set the Optimization of compilation speed. Possible values:

'O0' ( No Optimization )
'O1' ( Normal Optimization (default) )
'O2' ( Fast Optimization )
'O3' ( Fastest Optimization )

parameter_enable [int]

Parameter Mode Enable

parameter_mappable [int] (default: 1)

Visible to Mapping

polyphony [int] (default: 0)

Set the number of polyphonic voices for each parameter when exposevoiceparams is set to 1.

tabswitchesaudio [int] (default: 0)

When enabled, tabswitchaudio enables audio output from the currently open tab, and simultaneously disables audio output from closed tabs.

title [symbol]

The title sets the name of the rnbo~ object. This name appears as the patcher windows name and the default name for presets.

transport [symbol]

The name of the host platforms transport object to synchronize to. These objects will be metros and phasors in the rnbo~ patcher that are locked to the transport with the lock attribute set to 1.

Common Box Attributes

annotation [symbol]

Sets the text that will be displayed in the Clue window when the user moves the mouse over the object.

background [int] (default: 0)

Adds or removes the object from the patcher's background layer. background 1 adds the object to the background layer, background 0 removes it. Objects in the background layer are shown behind all objects in the default foreground layer.

color [4 floats]

Sets the color for the object box outline.

fontface [int]

Sets the type style used by the object. The options are:

plain
bold
italic
bold italic Possible values:

0 = 'regular'
1 = 'bold'
2 = 'italic'
3 = 'bold italic'

fontname [symbol]

Sets the object's font.

fontsize [float]

Sets the object's font size (in points). Possible values:

'8'
'9'
'10'
'11'
'12'
'13'
'14'
'16'
'18'
'20'
'24'
'30'
'36'
'48'
'64'
'72'

hidden [int] (default: 0)

Toggles whether an object is hidden when the patcher is locked.

hint [symbol]

Sets the text that will be displayed in as a pop-up hint when the user moves the mouse over the object in a locked patcher.

ignoreclick [int] (default: 0)

Toggles whether an object ignores mouse clicks in a locked patcher.

jspainterfile [symbol]

JS Painter File

patching_rect [4 floats] (default: 0. 0. 100. 0.)

Sets the position and size of the object in the patcher window.

position [2 floats]

g/s(set)

Sets the object's x and y position in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its size unchanged.

presentation [int] (default: 0)

Sets whether an object belongs to the patcher's presentation.

presentation_rect [4 floats] (default: 0. 0. 0. 0.)

Sets the x and y position and width and height of the object in the patcher's presentation, leaving its patching position unchanged.

rect [4 floats]

g/s(set)

Sets the x and y position and width and height of the object in both patching and presentation modes (if the object belongs to its patcher's presentation).

size [2 floats]

g/s(set)

Sets the object's width and height in both patching and presentation modes (if the object belongs to its patcher's presentation), leaving its position unchanged.

textcolor [4 floats]

Sets the color for the object's text in RGBA format.

textjustification [int]

Sets the justification for the object's text. Possible values:

0 = 'left'
1 = 'center'
2 = 'right'

varname [symbol]

Sets the patcher's scripting name, which can be used to address the object by name in pattr, scripting messages to thispatcher, and the js object.

Snapshot Attributes

autosave [int]

g/s(set)

When the containing patcher is saved, the state of this object's snapshots will also be saved.

Parameter Attributes

Order

Typeint

Sets the order of recall of this parameter. Lower numbers are recalled first. The order of recall of parameters with the same order number is undefined.

Parameter Mode Enable

Typeint

Parameter Mode Enable (not available from Parameters window)

Link to Scripting Name

Typeint

When checked, the Scripting Name is linked to the Long Name attribute.

Long Name

Typesymbol

The long name of the parameter. This name must be unique per patcher hierarchy.

Short Name

Typesymbol

Sets the short name for the object's visual display. The maximum length varies according to letter width, but is generally in a range of 5 to 7 characters.

Type

Typeint

Specifies the data type. The data types used in Max for Live are:

Float
Int
Enum (enumerated list)
Blob

Note: By convention, the Live application uses floating point numbers for its calculations; the native integer representation is limited to 256 values, with a default range of 0-255 (similar to the char data type used in Jitter). When working with Live UI objects whose integer values will exceed this range, the Type attribute should be set to Float, and the Unit Style attribute should be set to Int.

Range/Enum

Typelist

When used with an integer or floating point data type, this field is used to specify the minimum and maximum values of the parameter.
When used with an enumerated list (Enum) data type, this field contains a space-delimited list of the enumerated values (if list items contain a space or special characters, the name should be enclosed in double quotes).

Modulation Mode

Typeint

Sets the Modulation Mode used by the Live application. The modulation modes are:

None
Unipolar
Bipolar
Additive
Absolute

Modulation Range

Typelist

This parameter is only used with the Absolute modulation mode. It specifies defines the range of values used.

Initial Enable

Typeint

When checked (set to 1), the UI object can store an initialization value. The value is set using the Initial attribute (see below).

Initial

Typelist

Sets the initial value to be stored and used when the Initial Enable attribute is checked.

Unit Style

Typeint

Sets the unit style to be used when displaying values. The unit style values are: Int: displays integer values
Float: displays floating point values
Time: displays time values in milliseconds (ms)
Hertz: displays frequency values (Hz/kHz).
deciBel: displays loudness (dB)
%: Percentage
Pan: displays Left and Right values
Semitones: displays steps (st)
MIDI: displays pitch corresponding to the MIDI note number
Custom: displays custom data type
Native: defaults to floating point values

Custom Units

Typesymbol

Sets the units to be used with the 'Custom' unit style (see "Unit Style", above). Custom unit strings may be simple symbols (e.g. "Harmonic(s)"), in which case the parameter's value will be displayed in its 'Native' display mode, followed by the symbol (e.g. "12 Harmonic(s)" for an Int-typed parameter or "12.54 Harmonic(s)" for a Float-typed parameter). For additional control over the numerical component displayed, a sprintf-style string may be used (e.g. "%0.2f Bogon(s)", which would display a value such as ".87 Bogons").

Exponent

Typefloat

When set to a value other than 1., the parameter's input and output values will be exponentially scaled according to the factor entered in this column.

Steps

Typeint

The number of steps available between the minimum and maximum values of a parameter. For instance, if the parameter has a range from 0.-64., with Steps set to 4, the user can only set the parameter to 0, 21.33, 42.66 and 64.

Parameter Visibility

Typeint

For automatable parameters (Int, Float, Enum), 'Stored Only' disables automation, although parameter values are stored in presets. 'Hidden' causes the parameter's value to be ignored when storing and recalling data. Non-automatable parameters (Blob) are 'Stored Only' by default, and can be set to 'Hidden', if desired.

Update Limit (ms)

Typeint

Speed limits values triggered by automation.

Defer Automation Output

Typeint

Defers values triggered by automation.

Messages

bang

Send a bang from rnbo~'s default inlet. This will be received within the rnbo~ patchers' rnbo_in objects.

int

Arguments

value [int]
Set integer values in RNBO through rnbo~'s default inlet. This will be received within the rnbo~ patchers rnbo_in objects.

float

Arguments

value [float]
Set float value in RNBO through rnbo~'s default inlet. This will be received within the rnbo~ patchers rnbo_in objects.

list

Arguments

value [list]
Set lists in RNBO through rnbo's default inlet. This will be received within the rnbo~ patchers rnbo_in objects.

(mouse)

Double-click to open the RNBO Patcher

message

Send a message to set the value for parameters and rnbo_inport objects in rnbo~. rnbo_inport 's' value can be set using the following format : inport-tag {value}
Set rnbo_param and rnbo_param~ s' value by using the following format : param-name {value}

midievent

Send Midi formatted messages to RNBO via the rnbo~ objects MIDI inlet.

midiin

Send Midi messages to RNBO via the rnbo~ objects MIDI inlet.

open

Open the rnbo~ patcher. If the rnbo~ patcher is already open, the rnbo~ window will appear in front of all windows.

reset

Reset parameters to their initial value. The initial value of parameters is set with the value attribute of rnbo_param and rnbo_param~ objects in the rnbo~ patcher.

reset_param

Arguments

symbol [list]
Reset a specific rnbo_param or rnbo_param~ object's value attribute to its initial value.

setnormalized

Arguments

name [symbol]
value [float]
Set the normalized value of a rnbo_param or rnbo_param~ object. The normalized value (0.0 - 1.0) will be scales to rnbo_param or rnbo_param~ s' minimum and maximum attributes.

wclose

Close the rnbo~ patcher window.

Snapshot Messages

snapshot7.0.0

Arguments

file-name [symbol]
Create a snapshot. When embedsnapshot is on it will be saved into the current patcher. Otherwise it will be saved in an external file. You can determine the filename by an argument to this message.

restore7.0.0

Arguments

file-name [symbol]
Restore a snapshot. When embedsnapshot is on, the snapshot that is embedded in the current patcher will be used. Otherwise it will be loaded from an external file. You can determine the filename by an argument to this message.

addsnapshot

Arguments

userpath [String]
index [Number]
name [String]
Add a new snapshot. If there are no arguments, it will append the new snapshot to the current list of snapshots. If the first argument is a string containing a file path, Max will try to save a .maxsnap file to that location. If the first argument is a number, it will save the snapshot to that slot, incrementing subsequent slots. If the second argument is a string, it will set the name of the snapshot.

deletesnapshot

Arguments

index [Number]
Delete a snapshot at the given index, decrementing subsequent slots.

exportsnapshot

Arguments

index [Number]
filename [String]
Exports a snapshot from the given index, specified by the first argument. The second argument specifies the file name and path to export a maxsnap file to. If the second argument is empty, a File dialog box will open, allowing you to specify a file name and location.

importsnapshot

Arguments

index [Number]
filename [String]
Imports a snapshot to the given index, specified by the first argument. The second argument specifies the file name and path to load a maxsnap file from. If the second argument is empty, a File dialog box will open, allowing you to choose a file.

setsnapshotname

Arguments

index [Number]
name [String]
Set the name of the snapshot at the given index.

setembedsnapshot

Arguments

index [Number]
embedstate [Number]
Set the embed state of the snapshot at the index.

movesnapshot

Arguments

srcindex [Number]
dstindex [Number]
Change a snapshot's index.

Inlets

Default Inlet

The leftmost inlet(s) of the rnbo~ object accept event and signal messages.

Midi Inlet

The MIDI inlet appears whenever a MIDI supported The rightmost inlet with the creations of MIDI objects (rnbo_midiin, rnbo_notein, rnbo_ctlin, rnbo_bendin, rnbo_sysexin) inside the rnbo~ patcher.

Outlets

MIDI Outlet

Midi outlets output MIDI data from the rnbo~ object. The MIDI outlet appears to the right of all outlets whenever a MIDI supported 'out' object (rnbo_midiout, rnbo_noteout, rnbo_ctlout, rnbo_bendout, rnbo_sysexout) is created inside the rnbo~ patcher. These objects will in turn, send midiformatted messages out the MIDI Outlet.

Message Outlets

Message outlets output event data from the rnbo~ object. The message outlets appear to the right of the Port outlets with the creation of rnbo_out objects in the rnbo~ patcher.

Port Outlet

Output data from rnbo_outport objects. The rightmost outlet will appear whenever a rnbo_outport is added to the rnbo~ patcher.

Signal Outlets

Signal outlets output signal from the rnbo~ object. The signal outlets appear to the right of the Port outlets with the creation of rnbo_out~ objects in the rnbo~ patcher.

See Also

Name Description
rnbo.remote Communicate with a remote rnbo device