rt-vamp-plugin-sdk 0.3.1
Real-time Vamp plugin SDK for C++20
Loading...
Searching...
No Matches
Static Public Member Functions | List of all members
rtvamp::pluginsdk::EntryPoint< Plugins > Class Template Reference

Helper class to create the entry point for plugin libraries. More...

#include <rtvamp/pluginsdk/EntryPoint.hpp>

Static Public Member Functions

static constexpr const VampPluginDescriptorgetDescriptor (unsigned int version, unsigned int index)
 

Detailed Description

template<IsPlugin... Plugins>
class rtvamp::pluginsdk::EntryPoint< Plugins >

Helper class to create the entry point for plugin libraries.

The plugins are defined as template parameters

A Vamp plugin must export a function vampGetPluginDescriptor. The EntryPoint::getDescriptor() method has the same signature as the required function. You have following options:

  1. Define, implement and export the vampGetPluginDescriptor manually
  2. Define, link and export the vampGetPluginDescriptor to the EntryPoint::getDescriptor() method
  3. Use the RTVAMP_ENTRY_POINT(...) macro to automatically define and export the entry point.

    Example:

    #include "RMS.hpp"
    #include "SpectralRolloff.hpp"
    RTVAMP_ENTRY_POINT(RMS, SpectralRolloff)
    #define RTVAMP_ENTRY_POINT(...)
    Generate entry point for given PluginDefintion types and export symbol with pragma.
    Definition EntryPoint.hpp:68

Member Function Documentation

◆ getDescriptor()

template<IsPlugin... Plugins>
static constexpr const VampPluginDescriptor * rtvamp::pluginsdk::EntryPoint< Plugins >::getDescriptor ( unsigned int  version,
unsigned int  index 
)
inlinestaticconstexpr

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