rtvamp::hostsdk::Plugin Class Reference

#include <rtvamp/hostsdk/Plugin.hpp>

Inheritance diagram for rtvamp::hostsdk::Plugin:

Classes
struct	OutputDescriptor
struct	ParameterDescriptor

Public Types
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.

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

Member Typedef Documentation

CurrentProgram

using rtvamp::hostsdk::Plugin::CurrentProgram = std::optional<std::string_view>

Current program (if programs avaiable)

Feature

using rtvamp::hostsdk::Plugin::Feature = std::vector<float>

Feature with one or more values (defined by OutputDescriptor::binCount)

FeatureSet

using rtvamp::hostsdk::Plugin::FeatureSet = std::span<const Feature>

Computed features for each output.

FrequencyDomainBuffer

using rtvamp::hostsdk::Plugin::FrequencyDomainBuffer = std::span<const std::complex<float> >

Frequency domain buffer (FFT)

InputBuffer

using rtvamp::hostsdk::Plugin::InputBuffer = std::variant<TimeDomainBuffer, FrequencyDomainBuffer>

Input buffer variant.

OutputList

using rtvamp::hostsdk::Plugin::OutputList = std::vector<OutputDescriptor>

List of output descriptors.

ParameterList

using rtvamp::hostsdk::Plugin::ParameterList = std::span<const ParameterDescriptor>

List of parameter descriptors.

ProgramList

using rtvamp::hostsdk::Plugin::ProgramList = std::span<const std::string_view>

List of programs.

TimeDomainBuffer

using rtvamp::hostsdk::Plugin::TimeDomainBuffer = std::span<const float>

Time domain buffer.

Member Enumeration Documentation

InputDomain

enum class rtvamp::hostsdk::Plugin::InputDomain

strong

Input domain of the plugin.

Enumerator
Time
Frequency

Constructor & Destructor Documentation

Plugin() [1/3]

rtvamp::hostsdk::Plugin::Plugin ( float  inputSampleRate )

inlineexplicit

~Plugin()

virtual rtvamp::hostsdk::Plugin::~Plugin ( )

virtualdefault

Plugin() [2/3]

rtvamp::hostsdk::Plugin::Plugin ( const Plugin &  )

default

Plugin() [3/3]

rtvamp::hostsdk::Plugin::Plugin ( Plugin &&  )

default

Member Function Documentation

getCopyright()

virtual std::string_view rtvamp::hostsdk::Plugin::getCopyright ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getCurrentProgram()

virtual CurrentProgram rtvamp::hostsdk::Plugin::getCurrentProgram ( ) const

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getDescription()

virtual std::string_view rtvamp::hostsdk::Plugin::getDescription ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getIdentifier()

virtual std::string_view rtvamp::hostsdk::Plugin::getIdentifier ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getInputDomain()

virtual InputDomain rtvamp::hostsdk::Plugin::getInputDomain ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getInputSampleRate()

float rtvamp::hostsdk::Plugin::getInputSampleRate ( ) const

inlinenoexcept

getLibraryPath()

virtual std::filesystem::path rtvamp::hostsdk::Plugin::getLibraryPath ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getMaker()

virtual std::string_view rtvamp::hostsdk::Plugin::getMaker ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getName()

virtual std::string_view rtvamp::hostsdk::Plugin::getName ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getOutputCount()

virtual uint32_t rtvamp::hostsdk::Plugin::getOutputCount ( ) const

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getOutputDescriptors()

virtual OutputList rtvamp::hostsdk::Plugin::getOutputDescriptors ( ) const

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getParameter()

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

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getParameterDescriptors()

virtual ParameterList rtvamp::hostsdk::Plugin::getParameterDescriptors ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getPluginVersion()

virtual int rtvamp::hostsdk::Plugin::getPluginVersion ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getPreferredBlockSize()

virtual uint32_t rtvamp::hostsdk::Plugin::getPreferredBlockSize ( ) const

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getPreferredStepSize()

virtual uint32_t rtvamp::hostsdk::Plugin::getPreferredStepSize ( ) const

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getPrograms()

virtual ProgramList rtvamp::hostsdk::Plugin::getPrograms ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

getVampApiVersion()

virtual uint32_t rtvamp::hostsdk::Plugin::getVampApiVersion ( ) const

pure virtualnoexcept

Implemented in rtvamp::hostsdk::PluginHostAdapter.

initialise()

virtual bool rtvamp::hostsdk::Plugin::initialise ( uint32_t  stepSize, uint32_t  blockSize  )

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

operator=() [1/2]

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

default

operator=() [2/2]

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

default

process()

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

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

reset()

virtual void rtvamp::hostsdk::Plugin::reset ( )

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

selectProgram()

virtual bool rtvamp::hostsdk::Plugin::selectProgram ( std::string_view  name )

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

setParameter()

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

pure virtual

Implemented in rtvamp::hostsdk::PluginHostAdapter.

---

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/Plugin.hpp