From 188e34375827915a9832ddb1db4b94494bbee455 Mon Sep 17 00:00:00 2001
From: David Robillard \b /ingen/ok - Respond to a successful user command
+ * \arg \b response-id (int) - Request ID this is a response to
+ * \b /ingen/response - Respond to a user command
* \arg \b response-id (int) - Request ID this is a response to
- * \arg \b success (boolean int) - Whether response is affirmative or an error
- * \arg \b message (string) - Error message (natural language text)
+ * \arg \b message (const std::string&) - Error message (natural language text)
* \b /ingen/error - Notification that an error has occurred
- * \arg \b message (string) - Error message (natural language text) \n\n
+ * \arg \b message (const std::string&) - Error message (natural language text) \n\n
* \li This is for notification of errors that aren't a direct response to a
* user command, ie "unexpected" errors. \b /ingen/plugin - Notification of the existance of a plugin
- * \arg \b type (string) - Type if plugin ("LADSPA", "DSSI", or "Internal")
- * \arg \b uri (string) - URI of the plugin (see engine namespace documentation) \n
- * \arg \b lib-name (string) - Name of shared library plugin resides in (ie "cmt.so")
- * \arg \b plug-label (string) - Label of the plugin (ie "dahdsr_iaoa")
- * \arg \b name (string) - Descriptive human-readable name of plugin (ie "ADSR Envelope")
+ * \arg \b type (const std::string&) - Type if plugin ("LADSPA", "DSSI", or "Internal")
+ * \arg \b uri (const std::string&) - URI of the plugin (see engine namespace documentation) \n
+ * \arg \b lib-name (const std::string&) - Name of shared library plugin resides in (ie "cmt.so")
+ * \arg \b plug-label (const std::string&) - Label of the plugin (ie "dahdsr_iaoa")
+ * \arg \b name (const std::string&) - Descriptive human-readable name of plugin (ie "ADSR Envelope")
* \b /ingen/new_node - Notification of a new node's creation.
- * \arg \b plug-uri (string) - URI of the plugin new node is an instance of
- * \arg \b path (string) - Path of the new node
+ * \arg \b plug-uri (const std::string&) - URI of the plugin new node is an instance of
+ * \arg \b path (const std::string&) - Path of the new node
* \arg \b polyphonic (integer-boolean) - Node is polyphonic (1 = yes, 0 = no)
* \arg \b num-ports (integer) - Number of ports (number of new_port messages to expect)\n\n
* \li New nodes are sent as a bundle. The first message in the bundle will be
* this one (/ingen/new_node), followed by a series of /ingen/new_port commands,
* followed by /ingen/new_node_end. \b /ingen/new_port - Notification of a new port's creation.
- * \arg \b path (string) - Path of new port
- * \arg \b data-type (string) - Type of port (ingen:audio, ingen:control, ingen:midi, or ingen:osc)
+ * \arg \b path (const std::string&) - Path of new port
+ * \arg \b data-type (const std::string&) - Type of port (ingen:audio, ingen:control, ingen:midi, or ingen:osc)
* \arg \b direction ("is-output") (integer) - Direction of data flow (Input = 0, Output = 1)
*
* \li Note that in the event of loading a patch, this message could be
@@ -350,8 +366,8 @@ void OSCClientSender::new_node(string plugin_uri,
* as metadata. \b /ingen/destroyed - Notification an object has been destroyed
- * \arg \b path (string) - Path of object (which no longer exists) Control Band
*/
+
+/** \page client_osc_namespace
+ *
\b /ingen/patch_cleared - Notification a patch has been cleared (all children destroyed) - * \arg \b path (string) - Path of patch (which is now empty)
\n \n + * \arg \b path (const std::string&) - Path of patch (which is now empty) \n \n */ void -OSCClientSender::patch_cleared(string patch_path) +OSCClientSender::patch_cleared(const std::string& patch_path) { if (!_enabled) return; @@ -393,10 +409,10 @@ OSCClientSender::patch_cleared(string patch_path) /** \page client_osc_namespace *\b /ingen/patch_enabled - Notification a patch's DSP processing has been enabled. - * \arg \b path (string) - Path of enabled patch
\n \n + * \arg \b path (const std::string&) - Path of enabled patch \n \n */ void -OSCClientSender::patch_enabled(string patch_path) +OSCClientSender::patch_enabled(const std::string& patch_path) { if (!_enabled) return; @@ -407,10 +423,10 @@ OSCClientSender::patch_enabled(string patch_path) /** \page client_osc_namespace *\b /ingen/patch_disabled - Notification a patch's DSP processing has been disabled. - * \arg \b path (string) - Path of disabled patch
\n \n + * \arg \b path (const std::string&) - Path of disabled patch \n \n */ void -OSCClientSender::patch_disabled(string patch_path) +OSCClientSender::patch_disabled(const std::string& patch_path) { if (!_enabled) return; @@ -421,11 +437,11 @@ OSCClientSender::patch_disabled(string patch_path) /** \page client_osc_namespace *\b /ingen/new_connection - Notification a new connection has been made. - * \arg \b src-path (string) - Path of the source port - * \arg \b dst-path (string) - Path of the destination port
\n \n + * \arg \b src-path (const std::string&) - Path of the source port + * \arg \b dst-path (const std::string&) - Path of the destination port \n \n */ void -OSCClientSender::connection(string src_port_path, string dst_port_path) +OSCClientSender::connection(const std::string& src_port_path, const std::string& dst_port_path) { if (!_enabled) return; @@ -436,11 +452,11 @@ OSCClientSender::connection(string src_port_path, string dst_port_path) /** \page client_osc_namespace *\b /ingen/disconnection - Notification a connection has been unmade. - * \arg \b src-path (string) - Path of the source port - * \arg \b dst-path (string) - Path of the destination port
\n \n + * \arg \b src-path (const std::string&) - Path of the source port + * \arg \b dst-path (const std::string&) - Path of the destination port \n \n */ void -OSCClientSender::disconnection(string src_port_path, string dst_port_path) +OSCClientSender::disconnection(const std::string& src_port_path, const std::string& dst_port_path) { if (!_enabled) return; @@ -451,12 +467,12 @@ OSCClientSender::disconnection(string src_port_path, string dst_port_path) /** \page client_osc_namespace *\b /ingen/metadata_update - Notification of a piece of metadata. - * \arg \b path (string) - Path of the object associated with metadata (can be a node, patch, or port) - * \arg \b key (string) - * \arg \b value (string)
\n \n + * \arg \b path (const std::string&) - Path of the object associated with metadata (can be a node, patch, or port) + * \arg \b key (const std::string&) + * \arg \b value (const std::string&) \n \n */ void -OSCClientSender::metadata_update(string path, string key, Atom value) +OSCClientSender::metadata_update(const std::string& path, const std::string& key, const Atom& value) { if (!_enabled) return; @@ -471,14 +487,14 @@ OSCClientSender::metadata_update(string path, string key, Atom value) /** \page client_osc_namespace *\b /ingen/control_change - Notification the value of a port has changed - * \arg \b path (string) - Path of port + * \arg \b path (const std::string&) - Path of port * \arg \b value (float) - New value of port * * \li This will only send updates for values set by clients of course - not values * changing because of connections to other ports!
\n \n */ void -OSCClientSender::control_change(string port_path, float value) +OSCClientSender::control_change(const std::string& port_path, float value) { if (!_enabled) return; @@ -489,12 +505,12 @@ OSCClientSender::control_change(string port_path, float value) /** \page client_osc_namespace *\b /ingen/plugin - Notification of the existance of a plugin - * \arg \b type (string) - Type of plugin ("LADSPA", "DSSI", or "Internal") - * \arg \b uri (string) - Type of plugin ("LADSPA", "DSSI", or "Internal") - * \arg \b name (string) - Descriptive human-readable name of plugin (ie "ADSR Envelope") + * \arg \b type (const std::string&) - Type of plugin ("LADSPA", "DSSI", or "Internal") + * \arg \b uri (const std::string&) - Type of plugin ("LADSPA", "DSSI", or "Internal") + * \arg \b name (const std::string&) - Descriptive human-readable name of plugin (ie "ADSR Envelope") */ void -OSCClientSender::new_plugin(string uri, string type_uri, string name) +OSCClientSender::new_plugin(const std::string& uri, const std::string& type_uri, const std::string& name) { if (!_enabled) return; @@ -525,11 +541,11 @@ OSCClientSender::new_plugin(string uri, string type_uri, string name) /** \page client_osc_namespace *
\b /ingen/new_patch - Notification of a new patch - * \arg \b path (string) - Path of new patch + * \arg \b path (const std::string&) - Path of new patch * \arg \b poly (int) - Polyphony of new patch (\em not a boolean like new_node)
\n \n */ void -OSCClientSender::new_patch(string path, uint32_t poly) +OSCClientSender::new_patch(const std::string& path, uint32_t poly) { if (!_enabled) return; @@ -541,8 +557,8 @@ OSCClientSender::new_patch(string path, uint32_t poly) patch_enabled(p->path()); // Send metadata - const map\b /ingen/object_renamed - Notification of an object's renaming - * \arg \b old-path (string) - Old path of object - * \arg \b new-path (string) - New path of object
\n \n + * \arg \b old-path (const std::string&) - Old path of object + * \arg \b new-path (const std::string&) - New path of object \n \n */ void -OSCClientSender::object_renamed(string old_path, string new_path) +OSCClientSender::object_renamed(const std::string& old_path, const std::string& new_path) { if (!_enabled) return; @@ -567,7 +583,7 @@ OSCClientSender::object_renamed(string old_path, string new_path) /** Sends information about a program associated with a DSSI plugin node. */ void -OSCClientSender::program_add(string node_path, uint32_t bank, uint32_t program, string name) +OSCClientSender::program_add(const std::string& node_path, uint32_t bank, uint32_t program, const std::string& name) { if (!_enabled) return; @@ -578,7 +594,7 @@ OSCClientSender::program_add(string node_path, uint32_t bank, uint32_t program, void -OSCClientSender::program_remove(string node_path, uint32_t bank, uint32_t program) +OSCClientSender::program_remove(const std::string& node_path, uint32_t bank, uint32_t program) { if (!_enabled) return; -- cgit v1.2.1