rtvamp::hostsdk::PluginHostAdapter Class Reference

#include <rtvamp/hostsdk/PluginHostAdapter.hpp>

Inheritance diagram for rtvamp::hostsdk::PluginHostAdapter:

Public Member Functions
	PluginHostAdapter (const VampPluginDescriptor &descriptor, float inputSampleRate, std::shared_ptr< DynamicLibrary > library=nullptr)
	~PluginHostAdapter () override
	PluginHostAdapter (const PluginHostAdapter &)=delete
	PluginHostAdapter (PluginHostAdapter &&)=delete
PluginHostAdapter &	operator= (const PluginHostAdapter &)=delete
PluginHostAdapter &	operator= (PluginHostAdapter &&)=delete
std::filesystem::path	getLibraryPath () const noexcept override
uint32_t	getVampApiVersion () const noexcept override
std::string_view	getIdentifier () const noexcept override
std::string_view	getName () const noexcept override
std::string_view	getDescription () const noexcept override
std::string_view	getMaker () const noexcept override
std::string_view	getCopyright () const noexcept override
int	getPluginVersion () const noexcept override
InputDomain	getInputDomain () const noexcept override
ParameterList	getParameterDescriptors () const noexcept override
std::optional< float >	getParameter (std::string_view id) const override
bool	setParameter (std::string_view id, float value) override
ProgramList	getPrograms () const noexcept override
CurrentProgram	getCurrentProgram () const override
bool	selectProgram (std::string_view name) override
uint32_t	getPreferredStepSize () const override
uint32_t	getPreferredBlockSize () const override
uint32_t	getOutputCount () const override
OutputList	getOutputDescriptors () const override
bool	initialise (uint32_t stepSize, uint32_t blockSize) override
void	reset () override
FeatureSet	process (InputBuffer buffer, uint64_t nsec) override
Public Member Functions inherited from rtvamp::hostsdk::Plugin
	Plugin (float inputSampleRate)
virtual	~Plugin ()=default
	Plugin (const Plugin &)=default
	Plugin (Plugin &&)=default
Plugin &	operator= (const Plugin &)=default
Plugin &	operator= (Plugin &&)=default
float	getInputSampleRate () const noexcept

Additional Inherited Members
Public Types inherited from rtvamp::hostsdk::Plugin
enum class	InputDomain { Time , Frequency }
	Input domain of the plugin. More...
using	ParameterList = std::span< const ParameterDescriptor >
	List of parameter descriptors.
using	ProgramList = std::span< const std::string_view >
	List of programs.
using	CurrentProgram = std::optional< std::string_view >
	Current program (if programs avaiable)
using	OutputList = std::vector< OutputDescriptor >
	List of output descriptors.
using	TimeDomainBuffer = std::span< const float >
	Time domain buffer.
using	FrequencyDomainBuffer = std::span< const std::complex< float > >
	Frequency domain buffer (FFT)
using	InputBuffer = std::variant< TimeDomainBuffer, FrequencyDomainBuffer >
	Input buffer variant.
using	Feature = std::vector< float >
	Feature with one or more values (defined by OutputDescriptor::binCount)
using	FeatureSet = std::span< const Feature >
	Computed features for each output.

Constructor & Destructor Documentation

PluginHostAdapter() [1/3]

rtvamp::hostsdk::PluginHostAdapter::PluginHostAdapter	(	const VampPluginDescriptor &	descriptor,
		float	inputSampleRate,
		std::shared_ptr< DynamicLibrary >	library = nullptr
	)

~PluginHostAdapter()

rtvamp::hostsdk::PluginHostAdapter::~PluginHostAdapter ( )

override

PluginHostAdapter() [2/3]

rtvamp::hostsdk::PluginHostAdapter::PluginHostAdapter ( const PluginHostAdapter &  )

delete

PluginHostAdapter() [3/3]

rtvamp::hostsdk::PluginHostAdapter::PluginHostAdapter ( PluginHostAdapter &&  )

delete

Member Function Documentation

getCopyright()

std::string_view rtvamp::hostsdk::PluginHostAdapter::getCopyright ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getCurrentProgram()

CurrentProgram rtvamp::hostsdk::PluginHostAdapter::getCurrentProgram ( ) const

overridevirtual

Implements rtvamp::hostsdk::Plugin.

getDescription()

std::string_view rtvamp::hostsdk::PluginHostAdapter::getDescription ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getIdentifier()

std::string_view rtvamp::hostsdk::PluginHostAdapter::getIdentifier ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getInputDomain()

InputDomain rtvamp::hostsdk::PluginHostAdapter::getInputDomain ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getLibraryPath()

std::filesystem::path rtvamp::hostsdk::PluginHostAdapter::getLibraryPath ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getMaker()

std::string_view rtvamp::hostsdk::PluginHostAdapter::getMaker ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getName()

std::string_view rtvamp::hostsdk::PluginHostAdapter::getName ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getOutputCount()

uint32_t rtvamp::hostsdk::PluginHostAdapter::getOutputCount ( ) const

overridevirtual

Implements rtvamp::hostsdk::Plugin.

getOutputDescriptors()

OutputList rtvamp::hostsdk::PluginHostAdapter::getOutputDescriptors ( ) const

overridevirtual

Implements rtvamp::hostsdk::Plugin.

getParameter()

std::optional< float > rtvamp::hostsdk::PluginHostAdapter::getParameter ( std::string_view  id ) const

overridevirtual

Implements rtvamp::hostsdk::Plugin.

getParameterDescriptors()

ParameterList rtvamp::hostsdk::PluginHostAdapter::getParameterDescriptors ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getPluginVersion()

int rtvamp::hostsdk::PluginHostAdapter::getPluginVersion ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getPreferredBlockSize()

uint32_t rtvamp::hostsdk::PluginHostAdapter::getPreferredBlockSize ( ) const

overridevirtual

Implements rtvamp::hostsdk::Plugin.

getPreferredStepSize()

uint32_t rtvamp::hostsdk::PluginHostAdapter::getPreferredStepSize ( ) const

overridevirtual

Implements rtvamp::hostsdk::Plugin.

getPrograms()

ProgramList rtvamp::hostsdk::PluginHostAdapter::getPrograms ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

getVampApiVersion()

uint32_t rtvamp::hostsdk::PluginHostAdapter::getVampApiVersion ( ) const

overridevirtualnoexcept

Implements rtvamp::hostsdk::Plugin.

initialise()

bool rtvamp::hostsdk::PluginHostAdapter::initialise ( uint32_t  stepSize, uint32_t  blockSize  )

overridevirtual

Implements rtvamp::hostsdk::Plugin.

operator=() [1/2]

PluginHostAdapter & rtvamp::hostsdk::PluginHostAdapter::operator= ( const PluginHostAdapter &  )

delete

operator=() [2/2]

PluginHostAdapter & rtvamp::hostsdk::PluginHostAdapter::operator= ( PluginHostAdapter &&  )

delete

process()

FeatureSet rtvamp::hostsdk::PluginHostAdapter::process ( InputBuffer  buffer, uint64_t  nsec  )

overridevirtual

Implements rtvamp::hostsdk::Plugin.

reset()

void rtvamp::hostsdk::PluginHostAdapter::reset ( )

overridevirtual

Implements rtvamp::hostsdk::Plugin.

selectProgram()

bool rtvamp::hostsdk::PluginHostAdapter::selectProgram ( std::string_view  name )

overridevirtual

Implements rtvamp::hostsdk::Plugin.

setParameter()

bool rtvamp::hostsdk::PluginHostAdapter::setParameter ( std::string_view  id, float  value  )

overridevirtual

Implements rtvamp::hostsdk::Plugin.

---

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

• /home/runner/work/rt-vamp-plugin-sdk/rt-vamp-plugin-sdk/hostsdk/include/rtvamp/hostsdk/PluginHostAdapter.hpp