PluginFactory Class Reference

Factory for plugins. More...

#include <src/gui/dsp/plugin_factory.h>

Inheritance diagram for PluginFactory:

Collaboration diagram for PluginFactory:

Data Structures
struct	InstantiationFinishOptions
struct	CommonFactoryDependencies
class	Builder

Public Types
using	PluginConfiguration = zrythm::plugins::PluginConfiguration
using	InstantiationFinishedHandler
using	AudioThreadChecker = std::function<bool ()>
	Function that returns whether the caller is an audio DSP thread.

Public Member Functions
	PluginFactory (CommonFactoryDependencies dependencies, gui::SettingsManager &settings_mgr, QObject *parent=nullptr)
template<typename PluginT>
auto	get_builder () const
plugins::PluginUuidReference	create_plugin_from_setting (const PluginConfiguration &setting, InstantiationFinishOptions instantiation_finish_options) const

Static Public Member Functions
static PluginFactory *	get_instance ()

Detailed Description

Factory for plugins.

Note

API that starts with add adds the object to the project and should be used in most cases. API that starts with create only creates and registers the object but does not add it to the project (this should only be used internally).

Definition at line 20 of file plugin_factory.h.

Member Typedef Documentation

AudioThreadChecker

using PluginFactory::AudioThreadChecker = std::function<bool ()>

Function that returns whether the caller is an audio DSP thread.

Definition at line 44 of file plugin_factory.h.

InstantiationFinishedHandler

using PluginFactory::InstantiationFinishedHandler

Initial value:

 
    std::function<void (plugins::PluginUuidReference)>

Definition at line 32 of file plugin_factory.h.

PluginConfiguration

using PluginFactory::PluginConfiguration = zrythm::plugins::PluginConfiguration

Definition at line 27 of file plugin_factory.h.

Constructor & Destructor Documentation

PluginFactory()

PluginFactory::PluginFactory ( CommonFactoryDependencies dependencies, gui::SettingsManager & settings_mgr, QObject * parent = nullptr )

inline

Definition at line 60 of file plugin_factory.h.

Member Function Documentation

create_plugin_from_setting()

plugins::PluginUuidReference PluginFactory::create_plugin_from_setting ( const PluginConfiguration & setting, InstantiationFinishOptions instantiation_finish_options ) const

inline

Definition at line 174 of file plugin_factory.h.

get_builder()

template<typename PluginT>

auto PluginFactory::get_builder ( ) const

inline

Definition at line 166 of file plugin_factory.h.

---

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

• src/gui/dsp/plugin_factory.h