rnbo.remote
Examples
Arguments
None.
Attributes
addr [symbol]
Setting the address of the device host running the RNBO code will point the rnbo.remote device to communicate with that device. The address is the IPV4 address of the RNBO remote device.
fdbkdel [float]
The number of milliseconds to ignore incoming parameter updates after a local update for feedback suppression.
inst [int]
The numbered instance of the patcher to load and communicate with. This is associated alpabetically with the patchername that has been exported to your Pi (f.e. if you have two patches on your pi, @inst 0 will reference @patchername delay and @inst 1 will reference @patchername reverb).
name [symbol]
The name of the RNBO device host to communicate with. This is the name set for your RNBO device determined in the configuration settings at the time of export.
patchername [symbol]
The name of the patcher to load and communicate with. This is the name set for your patcher determined under Patch Name in the target sidebar at the the time of export.
port [int]
Communicate on a specific port of the RNBO device shared IPv4 network. This can be specifically useful for instances where you would like to utilize port forwarding for the rnbo.remote 's communication. Provided that both the RNBO device and the remote are connected to the same network, setting the port will allow messaging to be forwarded specifically to that port. The default port is 5678.
presets/midichannel [symbol]
Use MIDI channels for changing RNBO presets via MIDI program messages. This is helpful for setting presets from MIDI hardware connected to the RNBO device.
The MIDI program number will load the preset by it's number represented in the preset index.
By default, this setting is set to omni, which allows any midichannel to set program changes to the rnbo devices presets
Setting a integer value between 1 and 16 will allow programs from a specific Midi channel, f.e. presets/midichannel 1 will only allow program changes via MIDI channel 1.
Setting presets/midichannel none will not allow program changes to be made to any MIDI channels.
transport/bpm [float]
Remote control the transport tempo (beats per minute) of the RNBO code running locally on the RNBO remote device.
transport/rolling [int] (default: 0)
The RNBO code running on the remote device has it's own transport tempo. Enabling transport/rolling allows us the ability to remotely control and visualize the transport tempo running on the RNBO runner from the rnbo.remote object.
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]
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]
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]
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.
Messages
int
Arguments
message
Arguments
message 'inport @name' $
status
The "host names" message retrieves a list of discovered remote rnbo devices. This is essentially all of the RNBO Device names that appear on the shared networks address.
The "connectivity" message reveals the connectivity status between the Remote and the RNBO device. An output value of '1' means that the devices are connected for remote control and retrieval of information from the devicE, AND '0'means there are no connected devices.
The "instance_info" message retrieves and lists the values of the named parameters, inports, outports, and data_refs
patcherdestroy
Arguments
If an instance of the patcher is loaded when a "patcherdestroy" is set for it, the instance will remain loaded until a different patcher is loaded.
preset
Arguments
To load a preset from the RNBO devices preset index, append the preset message with the load argument, followed by the name of the preset so that it looks like this : preset load $1.
To save a preset from the RNBO devices preset index, append the preset message with the save argument, followed by the name of the preset so that it looks like this : preset save $1.
To delete a preset from the RNBO devices preset index, append the preset message with the delete argument, followed by the name of the preset so that it looks like this : preset delete $1.
To set a preset to load first when the device intially boots, append the preset message with the initial argument,followed by the name of the preset so that it looks like this : preset initial $1. If this is not set, then by default, the first preset saved to the rnbo.device will load on reboot.
Outlets
Midi Bytes
The middle outlet outputs the status of midiformatted messages that are sent to midiout objects in the exported RNBO code on the remote device.
Outport Messages
The left outlet reports the state of outport objects exported rnbo code on the RNBO remote device. To report the state of the outport objects, reference the object by namespace using an object such as route.
Status Info
The right outlet reports the status of the RNBO code on the remote device.
The "host names" message retrieves a list of discovered remote rnbo devices. This is essentially all of the RNBO Device names that appear on the shared networks address.
The "connectivity" message reveals the connectivity status between the Remote and the RNBO device. An output value of '1' means that the devices are connected for remote control and retrieval of information from the device, and '0'means there are no connected devices.
The "instance_info" message retrieves and lists the values of the named parameters, inports, outports, and data_refs
See Also
| Name | Description |
|---|---|
| rnbo~ | The rnbo~ object is a Max wrapper for RNBO technology |