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	InputDomain { InputDomain::Time, InputDomain::Frequency }
	Input domain of the plugin. More...
using	TimeDomainBuffer = std::span< const float >
	Time domain buffer. More...
using	FrequencyDomainBuffer = std::span< const std::complex< float > >
	Frequency domain buffer (FFT) More...
using	InputBuffer = std::variant< TimeDomainBuffer, FrequencyDomainBuffer >
	Input domain variant. More...
using	Feature = std::vector< float >
	Feature with one or more values (defined by OutputDescriptor::binCount) More...

Public Member Functions
virtual	~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 rtvamp::pluginsdk::PluginBase::InputDomain

strong

Input domain of the plugin.

Enumerator
Time
Frequency

Constructor & Destructor Documentation

~PluginBase()

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

virtualdefault

---

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