Engine OSC Namespace Documentation
These are the commands the engine recognizes. A client can control every aspect of the engine entirely with these commands.
All commands on this page are in the "control band". If a client needs to know about the state of the engine, it must listen to the "notification band". See the "Client OSC Namespace Documentation" for details.
/ingen/ping
Reply to sender immediately with a successful response.
/ingen/ping_queued
Reply to sender with a successful response after going through the event queue. This is useful for checking if the engine is actually active, or for sending after several events as a sentinel and wait on it's response, to know when all previous events have finished processing.
/ingen/quit
Terminate the engine. Note that there are NO order guarantees with this command at all. You could send 10 messages then quit, and the quit reply could come immediately and the 10 messages would never get executed.
/ingen/register_client
Register a new client with the engine. The incoming address will be used for the new registered client. If you want to register a different specific address, use the URL version.
/ingen/unregister_client
Unregister a client.
/ingen/load_plugins
Locate all available plugins, making them available for use.
/ingen/activate
Activate the engine (event processing and all drivers, e.g. audio and MIDI). Note that you
must send this message first if you want the engine to do anything at all -
including respond to your messages!
/ingen/deactivate
Deactivate the engine.
/ingen/put
- response-id (integer)
- path (string) - Path of object
- predicate
- value
- ...
PUT a set of properties to a path (see
Method Documentation).
/ingen/move
- response-id (integer)
- old-path - Object's path
- new-path - Object's new path
MOVE an object to a new path (see
Method Documentation).
/ingen/clear_patch
- response-id (integer)
- patch-path - Patch's path
Remove all nodes from a patch.
/ingen/del
- response-id (integer)
- path (string) - Full path of the object
DELETE an object (see
Method Documentation).
/ingen/connect
- response-id (integer)
- src-port-path (string) - Full path of source port
- dst-port-path (string) - Full path of destination port
Connect two ports (which must be in the same patch).
/ingen/disconnect
- response-id (integer)
- src-port-path (string) - Full path of source port
- dst-port-path (string) - Full path of destination port
Disconnect two ports.
/ingen/disconnect_all
- response-id (integer)
- patch-path (string) - The (parent) patch in which to disconnect object.
- object-path (string) - Full path of object.
Disconnect all connections to/from a node/port.
/ingen/set_port_value
- response-id (integer)
- port-path (string) - Name of port
- value (float) - Value to set port to.
Set the value of a port for all voices.
/ingen/note_on
- response-id (integer)
- node-path (string) - Patch of Node to trigger (must be a trigger or note node)
- note-num (int) - MIDI style note number (0-127)
- velocity (int) - MIDI style velocity (0-127)
Trigger a note-on, just as if it came from MIDI.
/ingen/note_off
- response-id (integer)
- node-path (string) - Patch of Node to trigger (must be a trigger or note node)
- note-num (int) - MIDI style note number (0-127)
Trigger a note-off, just as if it came from MIDI.
/ingen/all_notes_off
- response-id (integer)
- patch-path (string) - Patch of patch to send event to
Trigger a note-off for all voices, just as if it came from MIDI.
/ingen/midi_learn
- response-id (integer)
- node-path (string) - Path of control node.
Initiate MIDI learn for a given control node. The node will learn the next MIDI control event it receives and set its outputs accordingly. This command does nothing for objects that are not a control internal.
/ingen/set_variable
- response-id (integer)
- object-path (string) - Full path of object to associate variable with
- key (string) - Key (index/predicate/ID) for new variable
- value (string) - Value of new variable
Set a variable, associated with a graph object.
/ingen/set_property
- response-id (integer)
- object-path (string) - Full path of object to associate variable with
- key (string) - URI/QName for predicate of this property (e.g. "ingen:enabled")
- value (string) - Value of property
Set a property on a graph object.
/ingen/request_variable
- response-id (integer)
- object-path (string) - Full path of object variable is associated with
- key (string) - Key (index) for piece of variable
Request the value of a variable on a graph object.
/ingen/request_plugin
- response-id (integer)
- port-path (string) - Full path of port to send the value of
Request the value of a port.
/ingen/request_object
- response-id (integer)
- port-path (string) - Full path of port to send the value of
Request all properties of a graph object.
/ingen/request_plugins
Request the engine send a list of all known plugins.
/ingen/request_all_objects
Requests all information about all known objects.
