zrythm::plugins::PluginFactory Class Reference

Factory for plugins. More...

#include <src/plugins/plugin_factory.h>

Inheritance diagram for zrythm::plugins::PluginFactory:

Collaboration diagram for zrythm::plugins::PluginFactory:

Data Structures
struct	InstantiationFinishOptions
struct	CommonFactoryDependencies

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, QObject *parent=nullptr)
plugins::PluginUuidReference	create_plugin_from_setting (const PluginConfiguration &setting, InstantiationFinishOptions instantiation_finish_options) const

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 21 of file plugin_factory.h.

Member Typedef Documentation

AudioThreadChecker

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

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

Definition at line 45 of file plugin_factory.h.

InstantiationFinishedHandler

using zrythm::plugins::PluginFactory::InstantiationFinishedHandler

Initial value:

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

Definition at line 33 of file plugin_factory.h.

PluginConfiguration

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

Definition at line 28 of file plugin_factory.h.

Constructor & Destructor Documentation

PluginFactory()

zrythm::plugins::PluginFactory::PluginFactory ( CommonFactoryDependencies dependencies, QObject * parent = nullptr )

inline

Definition at line 61 of file plugin_factory.h.

Member Function Documentation

create_plugin_from_setting()

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

inline

Definition at line 168 of file plugin_factory.h.

---

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

• src/plugins/plugin_factory.h