comparison vamp-sdk/Plugin.h @ 53:74822738965b

* Some doc updates

  * In most cases, the input will be audio and the output will be a
  * stream of derived data at a lower sampling resolution than the
  * input.
  *
  * Note that this class inherits several abstract methods from
- * PluginBase, that must be implemented by the subclass.
- */
-
-/**
- * Plugin Lifecycle
- * ================
+ * PluginBase.  These must be implemented by the subclass.
+ * 
+ * 
+ * PLUGIN LIFECYCLE
  *
  * Feature extraction plugins are managed differently from real-time
  * plugins (such as VST effects).  The main difference is that the
  * parameters for a feature extraction plugin are configured before
  * the plugin is used, and do not change during use.

      * After all blocks have been processed, calculate and return any
      * remaining features derived from the complete input.
      */
     virtual FeatureSet getRemainingFeatures() = 0;
 
+    /**
+     * Used to distinguish between Vamp::Plugin and other potential
+     * sibling subclasses of PluginBase.  Do not implement this
+     * function in your subclass.
+     */
     virtual std::string getType() const { return "Feature Extraction Plugin"; }
 
 protected:
     Plugin(float inputSampleRate) :
 	m_inputSampleRate(inputSampleRate) { }