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.
/om/ping - Immediately sends a successful response to the given request id.
/om/ping_slow - Sends response after going through the ("slow") event queue.
- See the documentation for /om/synth/set_port_value_slow for an explanation of how this differs from /om/ping. This is useful to send after sending a large cluster of events as a sentinel and wait on it's response, to know when the events are all finished processing.
/om/engine/quit - Terminates the engine.
- Note that there is 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. This is the client's problem, for the time being. Complain if you want it fixed.
/om/engine/register_client - Registers a new client with the engine (using source address)
- request-id (integer)
- url (string) - URL to send notifications to
/om/engine/unregister_client - Unregisters a client
- request-id (integer)
- url (string) - URL of client to unregister
/om/engine/load_plugins - Locates all available plugins, making them available for use.
/om/engine/activate - Activate the engine (MIDI, audio, everything)
- Note that you must send this message first if you want the engine to do anything at all - including respond to your messages!
/om/engine/deactivate - Deactivate the engine completely.
/om/engine/enable - Enable the engine's DSP processing
- The client that sends this command will receive an affirmative response, but not an engine enabled notification, to avoid a feedback loop.
/om/engine/disable - Disable the engine's DSP processing
- The client that sends this command will receive an affirmative response, but not an engine disabled notification, to avoid a feedback loop.
/om/synth/create_patch - Creates a new, empty, toplevel patch.
- request-id (integer)
- patch-path (string) - Patch path (complete, ie /master/parent/new_patch)
- poly (integer) - Patch's (internal) polyphony
/om/synth/destroy_patch - Destroys a patch and all nodes (etc) underneath it.
- request-id (integer)
- patch-path - Patch's path
/om/synth/rename - Rename an Object (only Nodes, for now)
- request-id (integer)
- path - Object's path
- name - New name for object
/om/synth/enable_patch - Enable DSP processing of a patch
- request-id (integer)
- patch-path - Patch's path
- The client that sends this command will receive an affirmative response, but not a patch enabled notification, to avoid a feedback loop.
/om/synth/disable_patch - Disable DSP processing of a patch
- request-id (integer)
- patch-path - Patch's path
- The client that sends this command will receive an affirmative response, but not a patch disabled notification, to avoid a feedback loop.
/om/synth/create_node - Adds (loads) a node into a given patch.
- request-id (integer)
- node-path (string) - Full path of the new node (ie. /patch2/subpatch/newnode)
- type (string) - Plugin type ("LADSPA" or "Internal")
- lib-name (string) - Name of library where plugin resides (eg "cmt.so")
- plug-label (string) - Label (ID) of plugin (eg "sine_fcaa")
- poly (integer-boolean) - Whether node is polyphonic (0 = false, 1 = true)
/om/synth/destroy_node - Removes (destroys) a loaded node from a patch
- request-id (integer)
- node-path (string) - Full path of the node
/om/synth/connect - Connects two ports (must be in the same patch)
- request-id (integer)
- src-port-path (string) - Full path of source port
- dst-port-path (string) - Full path of destination port
/om/synth/disconnect - Disconnects two ports.
- request-id (integer)
- src-port-path (string) - Full path of source port
- dst-port-path (string) - Full path of destination port
/om/synth/disconnect_all - Disconnect all connections to/from a node.
- request-id (integer)
- node-path (string) - Full path of node.
/om/synth/set_port_value - Sets the value of a port for all voices (both AR and CR)
- request-id (integer)
- port-path (string) - Name of port
- value (float) - Value to set port to
- The client that sends this command will receive an affirmative response, but not a control update notification, to avoid a feedback loop.
/om/synth/set_port_value - Sets the value of a port for a specific voice (both AR and CR)
- request-id (integer)
- port-path (string) - Name of port
- voice (integer) - Voice to set port value for
- value (float) - Value to set port to
- The client that sends this command will receive an affirmative response, but not a control update notification, to avoid a feedback loop.
/om/synth/set_port_value_slow - Sets the value of a port for all voices (as a SlowEvent)
- request-id (integer)
- port-path (string) - Name of port
- value (float) - Value to set port to
- This version exists so you can send it immediately after a SlowEvent it may depend on (ie a node creation) and be sure it happens after the event (a normal set_port_value could beat the slow event and arrive out of order).
/om/synth/note_on - Triggers a note-on, just as if it came from MIDI
- request-id (integer)
- patch-path (string) - Patch of patch to send event to
- note-num (integer) - MIDI style note number
- velocity (integer) - MIDI style velocity
/om/synth/note_off - Triggers a note-off, just as if it came from MIDI
- request-id (integer)
- patch-path (string) - Patch of patch to send event to
- note-num (integer) - MIDI style note number
/om/synth/all_notes_off - Triggers a note-off for all voices, just as if it came from MIDI
- request-id (integer)
- patch-path (string) - Patch of patch to send event to
/om/midi/learn - "Learn" a binding for a MIDI control node.
- request-id (integer)
- node-path (string) - Path of the MIDI control node to bind.
/om/metadata/set - Sets a piece of metadata, associated with a synth-space object (node, etc)
- request-id (integer)
- object-path (string) - Full path of object to associate metadata with
- key (string) - Key (index) for new piece of metadata
- value (string) - Value of new piece of metadata
- The client that sends this command will receive an affirmative response, but not a metadata update notification, to avoid a feedback loop.
/om/metadata/request - Requests the engine send a piece of metadata, associated with a synth-space object (node, etc)
- request-id (integer)
- url (string) - URL to send notification to
- object-path (string) - Full path of object metadata is associated with
- key (string) - Key (index) for piece of metadata
/om/request/plugins - Requests the engine send a list of all known plugins.
- request-id (integer)
- url (string) - URL to send notification to
/om/request/all_objects - Requests the engine send information about all objects (patches, nodes, etc)
- request-id (integer)
- url (string) - URL to send notification to
/om/request/port_value - Requests the engine send the value of a port.
- request-id (integer)
- url (string) - URL to send notification to
- port-path (string) - Full path of port to send the value of
Generated on Sat Sep 24 21:22:36 2005 for Om by
1.4.4