diff vamp-sdk/PluginBase.h @ 61:97c5ac99d725 host-factory-stuff

* install hostext headers to vamp-sdk/hostext/ rather than vamp-sdk/ * adjust timestamps in input-domain adapter so as to centre them on block as required by Plugin documentation * better handling for frequency-domain plugins that want non-power-of-two blocksizes (can't handle them, but at least try offering them a power-of-two alternative) * couple of Plugin doc additions * make PluginLoader capable of returning ready-wrapped plugins
author cannam
date Fri, 01 Jun 2007 13:53:42 +0000
parents fa79c4ec847d
children
line wrap: on
line diff
--- a/vamp-sdk/PluginBase.h	Fri May 25 13:26:59 2007 +0000
+++ b/vamp-sdk/PluginBase.h	Fri Jun 01 13:53:42 2007 +0000
@@ -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(); }