diff vamp-sdk/PluginBase.h @ 64:9d3272c7db60

* Merge from host-factory-stuff branch: this adds several helper classes in
  the hostext directory that should make a host's life much easier.  This
  will become version 1.1 of the SDK, eventually.

--- a/vamp-sdk/PluginBase.h	Fri Mar 30 17:14:16 2007 +0000
+++ b/vamp-sdk/PluginBase.h	Fri Jun 01 15:10:17 2007 +0000
@@ -40,7 +40,7 @@
 #include <string>
 #include <vector>
 
-#define VAMP_SDK_VERSION "1.0"
+#define VAMP_SDK_VERSION "1.1"
 
 namespace Vamp {
 
@@ -217,7 +217,13 @@
     typedef std::vector<std::string> ProgramList;
 
     /**
-     * Get the program settings available in this plugin.
+     * Get the program settings available in this plugin.  A program
+     * is a named shorthand for a set of parameter values; changing
+     * the program may cause the plugin to alter the values of its
+     * published parameters (and/or non-public internal processing
+     * parameters).  The host should re-read the plugin's parameter
+     * values after setting a new program.
+     *
      * The programs must have unique names.
      */
     virtual ProgramList getPrograms() const { return ProgramList(); }