svcore  1.9
RealTimePluginFactory Class Referenceabstract

#include <RealTimePluginFactory.h>

Inheritance diagram for RealTimePluginFactory:

Public Member Functions

virtual ~RealTimePluginFactory ()
 
virtual void discoverPlugins ()=0
 Look up the plugin path and find the plugins in it. More...
 
virtual const std::vector< QString > & getPluginIdentifiers () const =0
 Return a reference to a list of all plugin identifiers that can be created by this factory. More...
 
virtual void enumeratePlugins (std::vector< QString > &list)=0
 Append to the given list descriptions of all the available plugins and their ports. More...
 
virtual const RealTimePluginDescriptorgetPluginDescriptor (QString identifier) const =0
 Get some basic information about a plugin (rapidly). More...
 
virtual RealTimePluginInstanceinstantiatePlugin (QString identifier, int clientId, int position, unsigned int sampleRate, unsigned int blockSize, unsigned int channels)=0
 Instantiate a plugin. More...
 
virtual QString getPluginCategory (QString identifier)=0
 Get category metadata about a plugin (without instantiating it). More...
 

Static Public Member Functions

static RealTimePluginFactoryinstance (QString pluginType)
 
static RealTimePluginFactoryinstanceFor (QString identifier)
 
static std::vector< QString > getAllPluginIdentifiers ()
 
static void enumerateAllPlugins (std::vector< QString > &)
 
static void setSampleRate (int sampleRate)
 

Protected Member Functions

 RealTimePluginFactory ()
 
virtual void releasePlugin (RealTimePluginInstance *, QString identifier)=0
 

Static Protected Attributes

static int m_sampleRate = 48000
 

Friends

class RealTimePluginInstance
 

Detailed Description

Definition at line 48 of file RealTimePluginFactory.h.

Constructor & Destructor Documentation

◆ ~RealTimePluginFactory()

RealTimePluginFactory::~RealTimePluginFactory ( )
virtual

Definition at line 38 of file RealTimePluginFactory.cpp.

◆ RealTimePluginFactory()

RealTimePluginFactory::RealTimePluginFactory ( )
inlineprotected

Definition at line 100 of file RealTimePluginFactory.h.

Member Function Documentation

◆ instance()

◆ instanceFor()

◆ getAllPluginIdentifiers()

std::vector< QString > RealTimePluginFactory::getAllPluginIdentifiers ( )
static

◆ enumerateAllPlugins()

void RealTimePluginFactory::enumerateAllPlugins ( std::vector< QString > &  list)
static

Definition at line 110 of file RealTimePluginFactory.cpp.

References enumeratePlugins(), instance(), and RestoreStartupLocale().

◆ setSampleRate()

static void RealTimePluginFactory::setSampleRate ( int  sampleRate)
inlinestatic

Definition at line 58 of file RealTimePluginFactory.h.

References m_sampleRate.

◆ discoverPlugins()

virtual void RealTimePluginFactory::discoverPlugins ( )
pure virtual

Look up the plugin path and find the plugins in it.

Called automatically after construction of a factory.

Implemented in LADSPAPluginFactory.

◆ getPluginIdentifiers()

virtual const std::vector<QString>& RealTimePluginFactory::getPluginIdentifiers ( ) const
pure virtual

Return a reference to a list of all plugin identifiers that can be created by this factory.

Implemented in LADSPAPluginFactory.

Referenced by getAllPluginIdentifiers().

◆ enumeratePlugins()

virtual void RealTimePluginFactory::enumeratePlugins ( std::vector< QString > &  list)
pure virtual

Append to the given list descriptions of all the available plugins and their ports.

This is in a standard format, see the LADSPA implementation for details.

Implemented in LADSPAPluginFactory, and DSSIPluginFactory.

Referenced by enumerateAllPlugins().

◆ getPluginDescriptor()

virtual const RealTimePluginDescriptor* RealTimePluginFactory::getPluginDescriptor ( QString  identifier) const
pure virtual

Get some basic information about a plugin (rapidly).

Implemented in LADSPAPluginFactory.

Referenced by TransformFactory::populateRealTimePlugins().

◆ instantiatePlugin()

virtual RealTimePluginInstance* RealTimePluginFactory::instantiatePlugin ( QString  identifier,
int  clientId,
int  position,
unsigned int  sampleRate,
unsigned int  blockSize,
unsigned int  channels 
)
pure virtual

◆ getPluginCategory()

virtual QString RealTimePluginFactory::getPluginCategory ( QString  identifier)
pure virtual

Get category metadata about a plugin (without instantiating it).

Implemented in LADSPAPluginFactory.

Referenced by TransformFactory::populateRealTimePlugins().

◆ releasePlugin()

virtual void RealTimePluginFactory::releasePlugin ( RealTimePluginInstance ,
QString  identifier 
)
protectedpure virtual

Friends And Related Function Documentation

◆ RealTimePluginInstance

friend class RealTimePluginInstance
friend

Definition at line 104 of file RealTimePluginFactory.h.

Member Data Documentation

◆ m_sampleRate

int RealTimePluginFactory::m_sampleRate = 48000
staticprotected

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