#include <vamp/vamp.h>Chris@6:
Go to the source code of this file.
Chris@6:Chris@6: Typedefs | |
| typedef struct vhLibrary_t * | vhLibrary |
Chris@6: Functions | |
| int | vhGetLibraryCount () |
| Return the number of Vamp plugin libraries discovered in the installation path. More... | |
| const char * | vhGetLibraryName (int library) |
| Return the library name (base soname) of the library with the given index, in the range 0..(vhGetLibraryCount()-1). More... | |
| int | vhGetLibraryIndex (const char *name) |
| Return the library index for the given library name, or -1 if the name is not known. More... | |
| vhLibrary | vhLoadLibrary (int library) |
| Load the library with the given index. More... | |
| int | vhGetPluginCount (vhLibrary library) |
| Return the number of Vamp plugins in the given library. More... | |
| const VampPluginDescriptor * | vhGetPluginDescriptor (vhLibrary library, int plugin) |
| Return a Vamp plugin descriptor for a plugin in a given library. More... | |
| void | vhUnloadLibrary (vhLibrary) |
| Unload a plugin library. More... | |
Typedef Documentation
Chris@6: Chris@6:◆ vhLibrary
Chris@6: Chris@6:| typedef struct vhLibrary_t* vhLibrary | Chris@6:
Function Documentation
Chris@6: Chris@6:◆ vhGetLibraryCount()
Chris@6: Chris@6:| int vhGetLibraryCount | Chris@6:( | Chris@6:) | Chris@6:Chris@6: |
Return the number of Vamp plugin libraries discovered in the installation path.
Chris@6:This number will remain fixed after the first call – plugins are only discovered once, the first time this function is called.
Chris@6: Chris@6:◆ vhGetLibraryName()
Chris@6: Chris@6:| const char* vhGetLibraryName | Chris@6:( | Chris@6:int | Chris@6:library | ) | Chris@6:Chris@6: |
Return the library name (base soname) of the library with the given index, in the range 0..(vhGetLibraryCount()-1).
Chris@6: Chris@6:◆ vhGetLibraryIndex()
Chris@6: Chris@6:| int vhGetLibraryIndex | Chris@6:( | Chris@6:const char * | Chris@6:name | ) | Chris@6:Chris@6: |
Return the library index for the given library name, or -1 if the name is not known.
Chris@6: Chris@6:◆ vhLoadLibrary()
Chris@6: Chris@6:| vhLibrary vhLoadLibrary | Chris@6:( | Chris@6:int | Chris@6:library | ) | Chris@6:Chris@6: |
Load the library with the given index.
Chris@6:If the library cannot be loaded for any reason, the return value is 0; otherwise it is an opaque pointer suitable for passing to other functions in this API.
Chris@6: Chris@6:◆ vhGetPluginCount()
Chris@6: Chris@6:| int vhGetPluginCount | Chris@6:( | Chris@6:vhLibrary | Chris@6:library | ) | Chris@6:Chris@6: |
Return the number of Vamp plugins in the given library.
Chris@6: Chris@6:◆ vhGetPluginDescriptor()
Chris@6: Chris@6:| const VampPluginDescriptor* vhGetPluginDescriptor | Chris@6:( | Chris@6:vhLibrary | Chris@6:library, | Chris@6:
| Chris@6: | Chris@6: | int | Chris@6:plugin | Chris@6:
| Chris@6: | ) | Chris@6:Chris@6: |
Return a Vamp plugin descriptor for a plugin in a given library.
Chris@6:This simply calls the vampGetPluginDescriptor function in that library with the given plugin index and returns the result. See vamp/vamp.h for details about the plugin descriptor.
Chris@6: Chris@6:◆ vhUnloadLibrary()
Chris@6: Chris@6:| void vhUnloadLibrary | Chris@6:( | Chris@6:vhLibrary | Chris@6:) | Chris@6:Chris@6: |
Unload a plugin library.
Chris@6:Do not do this while any of its plugins are still in use.
Chris@6: Chris@6: