Mercurial > hg > vamp-plugin-sdk
comparison vamp-sdk/PluginBase.h @ 53:74822738965b
* Some doc updates
| author | cannam |
|---|---|
| date | Wed, 21 Mar 2007 14:15:25 +0000 |
| parents | b907557b2fb9 |
| children | fa79c4ec847d 9d3272c7db60 |
comparison
equal
deleted
inserted
replaced
| 52:d3995d2b5e08 | 53:74822738965b |
|---|---|
| 44 | 44 |
| 45 namespace Vamp { | 45 namespace Vamp { |
| 46 | 46 |
| 47 /** | 47 /** |
| 48 * A base class for plugins with optional configurable parameters, | 48 * A base class for plugins with optional configurable parameters, |
| 49 * programs, etc. | 49 * programs, etc. The Vamp::Plugin is derived from this, and |
| 50 * individual Vamp plugins should derive from that. | |
| 50 * | 51 * |
| 51 * This does not provide the necessary interfaces to instantiate or | 52 * This class does not provide the necessary interfaces to instantiate |
| 52 * run a plugin -- that depends on the plugin subclass, as different | 53 * or run a plugin. It only specifies an interface for retrieving |
| 53 * plugin types may have quite different operating structures. This | 54 * those controls that the host may wish to show to the user for |
| 54 * class just specifies the necessary interface to show editable | 55 * editing. It could meaningfully be subclassed by real-time plugins |
| 55 * controls for the plugin to the user. | 56 * or other sorts of plugin as well as Vamp plugins. |
| 56 */ | 57 */ |
| 57 | 58 |
| 58 class PluginBase | 59 class PluginBase |
| 59 { | 60 { |
| 60 public: | 61 public: |