Logo Search packages:      
Sourcecode: vamp-plugin-sdk version File versions  Download package

Vamp::HostExt::PluginLoader Class Reference

#include <vamp-sdk/hostext/PluginLoader.h>

List of all members.


Detailed Description

Vamp::HostExt::PluginLoader is a convenience class for discovering and loading Vamp plugins using the typical plugin-path, library naming, and categorisation conventions described in the Vamp SDK documentation. This class is intended to greatly simplify the task of becoming a Vamp plugin host for any C++ application.

Hosts are not required by the Vamp specification to use the same plugin search path and naming conventions as implemented by this class, and are certainly not required to use this actual class. But we do strongly recommend it.

Note:
This class was introduced in version 1.1 of the Vamp plugin SDK.

Definition at line 69 of file PluginLoader.h.


Public Types

enum  AdapterFlags {
  ADAPT_INPUT_DOMAIN = 0x01, ADAPT_CHANNEL_COUNT = 0x02, ADAPT_BUFFER_SIZE = 0x04, ADAPT_ALL_SAFE = 0x03,
  ADAPT_ALL = 0xff
}
typedef std::vector< std::string > PluginCategoryHierarchy
typedef std::string PluginKey
typedef std::vector< PluginKeyPluginKeyList

Public Member Functions

PluginKey composePluginKey (std::string libraryName, std::string identifier)
std::string getLibraryPathForPlugin (PluginKey plugin)
PluginCategoryHierarchy getPluginCategory (PluginKey plugin)
PluginKeyList listPlugins ()
PluginloadPlugin (PluginKey key, float inputSampleRate, int adapterFlags=0)

Static Public Member Functions

static PluginLoadergetInstance ()

Protected Attributes

Impl * m_impl

Static Protected Attributes

static PluginLoaderm_instance = 0

Classes

class  Impl

The documentation for this class was generated from the following files:

Generated by  Doxygen 1.6.0   Back to index