rtvamp::pluginsdk::PluginBase Class Reference

Non-templated plugin base class with type definitions. More...

#include <rtvamp/pluginsdk/Plugin.hpp>

Inheritance diagram for rtvamp::pluginsdk::PluginBase:

Classes
struct	OutputDescriptor
struct	ParameterDescriptor

Public Types
enum class	InputDomain { Time , Frequency }
	Input domain of the plugin. More...
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 domain variant.
using	Feature = std::vector< float >
	Feature with one or more values (defined by OutputDescriptor::binCount)

Public Member Functions
	PluginBase ()=default
virtual	~PluginBase ()=default
	PluginBase (const PluginBase &)=default
	PluginBase (PluginBase &&)=default
PluginBase &	operator= (const PluginBase &)=default
PluginBase &	operator= (PluginBase &&)=default

Detailed Description

Non-templated plugin base class with type definitions.

Member Typedef Documentation

Feature

using rtvamp::pluginsdk::PluginBase::Feature = std::vector<float>

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

FrequencyDomainBuffer

using rtvamp::pluginsdk::PluginBase::FrequencyDomainBuffer = std::span<const std::complex<float> >

Frequency domain buffer (FFT)

InputBuffer

using rtvamp::pluginsdk::PluginBase::InputBuffer = std::variant<TimeDomainBuffer, FrequencyDomainBuffer>

Input domain variant.

TimeDomainBuffer

using rtvamp::pluginsdk::PluginBase::TimeDomainBuffer = std::span<const float>

Time domain buffer.

Member Enumeration Documentation

InputDomain

enum class rtvamp::pluginsdk::PluginBase::InputDomain

strong

Input domain of the plugin.

Enumerator
Time
Frequency

Constructor & Destructor Documentation

PluginBase() [1/3]

rtvamp::pluginsdk::PluginBase::PluginBase ( )

default

~PluginBase()

virtual rtvamp::pluginsdk::PluginBase::~PluginBase ( )

virtualdefault

PluginBase() [2/3]

rtvamp::pluginsdk::PluginBase::PluginBase ( const PluginBase &  )

default

PluginBase() [3/3]

rtvamp::pluginsdk::PluginBase::PluginBase ( PluginBase &&  )

default

Member Function Documentation

operator=() [1/2]

PluginBase & rtvamp::pluginsdk::PluginBase::operator= ( const PluginBase &  )

default

operator=() [2/2]

PluginBase & rtvamp::pluginsdk::PluginBase::operator= ( PluginBase &&  )

default

---

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

• /home/runner/work/rt-vamp-plugin-sdk/rt-vamp-plugin-sdk/pluginsdk/include/rtvamp/pluginsdk/Plugin.hpp