comparison 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.

 #define _VAMP_PLUGIN_BASE_H_
 
 #include <string>
 #include <vector>
 
-#define VAMP_SDK_VERSION "1.0"
+#define VAMP_SDK_VERSION "1.1"
 
 namespace Vamp {
 
 /**
  * A base class for plugins with optional configurable parameters,

 
     
     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(); }
 
     /**