rtvamp::hostsdk Namespace Reference

Classes
class	Plugin
class	PluginHostAdapter
class	PluginKey
	Identifier for a plugin uniquely within the scope of the current system. More...
class	PluginLibrary

Typedefs
using	PathList = std::vector< std::filesystem::path >

Functions
PathList	getVampPaths ()
	Get default Vamp search paths for plugin libraries.
bool	isVampLibrary (const std::filesystem::path &libraryPath)
	Check if the library is an existing and valid Vamp library.
PathList	listLibraries ()
	List all plugin libraries in default Vamp search paths.
PathList	listLibraries (const std::filesystem::path &path)
	List all plugin libraries in custom search path.
PathList	listLibraries (std::span< const std::filesystem::path > paths)
	List all plugin libraries in custom search paths.
PluginLibrary	loadLibrary (const std::filesystem::path &libraryPath)
	Load plugin library by file path.
std::vector< PluginKey >	listPlugins ()
	List plugins in default Vamp search paths.
std::vector< PluginKey >	listPlugins (const std::filesystem::path &path)
	List plugins in path (either directory or library).
std::vector< PluginKey >	listPlugins (std::span< const std::filesystem::path > paths)
	List plugins in given list of paths (either search paths or library paths).
std::unique_ptr< Plugin >	loadPlugin (const PluginKey &key, float inputSampleRate)
	Load plugin.
std::unique_ptr< Plugin >	loadPlugin (const PluginKey &key, float inputSampleRate, std::span< const std::filesystem::path > paths)
	Load plugin from given list of paths (either search paths or library paths).

Typedef Documentation

PathList

using rtvamp::hostsdk::PathList = typedef std::vector<std::filesystem::path>

Function Documentation

getVampPaths()

PathList rtvamp::hostsdk::getVampPaths

(

)

Get default Vamp search paths for plugin libraries.

A custom path can be set with the VAMP_PATH environment variable.

isVampLibrary()

bool rtvamp::hostsdk::isVampLibrary

(

const std::filesystem::path &

libraryPath

)

Check if the library is an existing and valid Vamp library.

listLibraries() [1/3]

PathList rtvamp::hostsdk::listLibraries

(

)

List all plugin libraries in default Vamp search paths.

listLibraries() [2/3]

PathList rtvamp::hostsdk::listLibraries

(

const std::filesystem::path &

path

)

List all plugin libraries in custom search path.

listLibraries() [3/3]

PathList rtvamp::hostsdk::listLibraries

(

std::span< const std::filesystem::path >

paths

)

List all plugin libraries in custom search paths.

listPlugins() [1/3]

std::vector< PluginKey > rtvamp::hostsdk::listPlugins

(

)

List plugins in default Vamp search paths.

listPlugins() [2/3]

std::vector< PluginKey > rtvamp::hostsdk::listPlugins

(

const std::filesystem::path &

path

)

List plugins in path (either directory or library).

listPlugins() [3/3]

std::vector< PluginKey > rtvamp::hostsdk::listPlugins

(

std::span< const std::filesystem::path >

paths

)

List plugins in given list of paths (either search paths or library paths).

loadLibrary()

PluginLibrary rtvamp::hostsdk::loadLibrary

(

const std::filesystem::path &

libraryPath

)

Load plugin library by file path.

loadPlugin() [1/2]

std::unique_ptr< Plugin > rtvamp::hostsdk::loadPlugin	(	const PluginKey &	key,
		float	inputSampleRate
	)

Load plugin.

loadPlugin() [2/2]

std::unique_ptr< Plugin > rtvamp::hostsdk::loadPlugin	(	const PluginKey &	key,
		float	inputSampleRate,
		std::span< const std::filesystem::path >	paths
	)

Load plugin from given list of paths (either search paths or library paths).

Providing the cached library paths speeds up the search.