Module xOscClient
xOscClient is a simple OSC client .
- Connects to the built-in OSC server in Renoise,
- Produce realtime messages (notes or MIDI messages)
Functions
create (osc_host, osc_port) | Initialize the xOscClient class |
trigger_instrument (note_on, instr, track, note, velocity) | Trigger instrument-note |
trigger_midi (t) | Trigger standard midi-message |
_show_instructions () | Display usage instructions the first time the class is used |
Fields
self.preferences | ScriptingToolPreferences, set this to specify global "preferences" (will display a message the first time a note message is sent) |
self._connection | the socket connection, nil if not established |
self._osc_host | string |
self._osc_port | int |
Functions
- create (osc_host, osc_port)
-
Initialize the xOscClient class
Parameters:
- osc_host (string) the host-address name (can be an IP address)
- osc_port (int) the host port
Returns:
- boolean,
- string, error message when failed
- trigger_instrument (note_on, instr, track, note, velocity)
-
Trigger instrument-note
Parameters:
- note_on (bool), true when note-on and false when note-off
- instr (int), the Renoise instrument index
- track (int) the Renoise track index
- note (int), the desired pitch, 0-120
- velocity (int), the desired velocity, 0-127
- trigger_midi (t)
-
Trigger standard midi-message
Parameters:
- t (table), a ready-to-send MIDI message
- _show_instructions ()
- Display usage instructions the first time the class is used