relay_send
Play or set something on the user's hardware through a relay: give a driver (id or slug) and one of its OSC addresses from list_routes with its arguments (e.g. address '/filter/cutoff', args [64]; '/note/on', args [60, 100]) — the server turns it into the right CC, NRPN, note or SysEx message. Or give raw MIDI bytes as hex. Values are the device's own numbers, clamped to the parameter's range. Any SysEx but the Identity Request (patch dumps, stores, settings, preset restores) may overwrite the device's memory: the relay asks the user to accept it first and this call waits for the answer (up to 2 minutes), so tell the user what you are about to send.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| hex | No | Raw MIDI messages instead of device/address, e.g. 'B0 2B 40'. | |
| args | No | OSC arguments (numbers, strings, booleans). | |
| code | Yes | The pairing code the relay page or program shows (e.g. 'K7QM-2XPA'). | |
| port | No | Output port name (or part of it); needed when the relay has several. | |
| device | No | Driver id (e.g. 'korg/minilogue') or slug. | |
| gap_ms | No | Pause between the SysEx messages of a dump, for devices that write slowly (default 50). | |
| address | No | OSC address of the driver, with or without its prefix. | |
| user_id | No | Your anonymous osc-bridge id, if you kept it from an earlier session (see the server instructions). Optional. |