Mercurial > hg > piper-cpp

diff vamp-client/PluginClient.h @ 187:ad6025dc0b04

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documentation
author Chris Cannam <cannam@all-day-breakfast.com>
date Wed, 08 Feb 2017 10:09:51 +0000
parents 3eb00e5c76c4
children df65480a08de
line wrap: on
line diff
--- a/vamp-client/PluginClient.h	Mon Feb 06 16:44:33 2017 +0000
+++ b/vamp-client/PluginClient.h	Wed Feb 08 10:09:51 2017 +0000
@@ -43,6 +43,12 @@
 
 class PluginStub;
 
+/**
+ * Interface for a client that accepts Vamp-like structures (Plugin
+ * and the classes in vamp-support) and communicates with a Piper
+ * server, using some serialisation and transport defined by the
+ * specific implementation.
+ */
 class PluginClient
 {
 public:
@@ -63,7 +69,8 @@
 
     virtual
     void
-    reset(PluginStub *plugin, PluginConfiguration config) = 0;
+    reset(PluginStub *plugin,
+          PluginConfiguration config) = 0;
 };
 
 }