zrythm::gui::old_dsp::plugins::PluginManager Class Reference

The PluginManager is responsible for scanning and keeping track of available Plugin's. More...

#include <src/gui/backend/plugin_manager.h>

Inheritance diagram for zrythm::gui::old_dsp::plugins::PluginManager:

Collaboration diagram for zrythm::gui::old_dsp::plugins::PluginManager:

Public Types
using	Protocol = zrythm::plugins::Protocol
using	PluginConfiguration = zrythm::plugins::PluginConfiguration

Public Member Functions
	PluginManager (QObject *parent=nullptr)
QString	getCurrentlyScanningPlugin () const
::zrythm::plugins::PluginScanManager *	getScanner () const
zrythm::plugins::discovery::PluginDescriptorList *	getPluginDescriptors () const
Q_INVOKABLE void	beginScan ()
auto &	get_format_manager () const
void	add_descriptor (const zrythm::plugins::PluginDescriptor &descr)
	Adds a new descriptor.
std::unique_ptr< zrythm::plugins::PluginDescriptor >	find_plugin_from_uri (const utils::Utf8String &uri) const
	Returns a PluginDescriptor for the given URI.
std::unique_ptr< zrythm::plugins::PluginDescriptor >	find_from_descriptor (const zrythm::plugins::PluginDescriptor &src_descr) const
	Finds and returns a PluginDescriptor matching the given descriptor.
std::unique_ptr< zrythm::plugins::PluginDescriptor >	pick_instrument () const
	Returns an instrument plugin, if any.
void	clear_plugins ()
int	get_num_new_plugins () const
	Returns the number of new plugins scanned this time (as opposed to known ones).
Q_SIGNAL void	scanFinished ()
Q_SIGNAL void	currentlyScanningPluginChanged (const QString &plugin)
Q_SLOT void	onScannerScanFinished ()
	Called by the scanner when it has finished scanning.

Static Public Member Functions
static PluginManager *	get_active_instance ()
static bool	supports_protocol (zrythm::plugins::Protocol::ProtocolType protocol)
	Returns if the plugin manager supports the given plugin protocol.

Properties
QML_ELEMENT zrythm::plugins::discovery::PluginDescriptorList *	pluginDescriptors
zrythm::plugins::PluginScanManager *	scanner
QString	currentlyScanningPlugin

Detailed Description

The PluginManager is responsible for scanning and keeping track of available Plugin's.

Definition at line 21 of file plugin_manager.h.

Member Typedef Documentation

PluginConfiguration

using zrythm::gui::old_dsp::plugins::PluginManager::PluginConfiguration = zrythm::plugins::PluginConfiguration

Definition at line 30 of file plugin_manager.h.

Protocol

using zrythm::gui::old_dsp::plugins::PluginManager::Protocol = zrythm::plugins::Protocol

Definition at line 29 of file plugin_manager.h.

Member Function Documentation

get_format_manager()

auto & zrythm::gui::old_dsp::plugins::PluginManager::get_format_manager ( ) const

inline

Definition at line 52 of file plugin_manager.h.

get_num_new_plugins()

int zrythm::gui::old_dsp::plugins::PluginManager::get_num_new_plugins ( ) const

inline

Returns the number of new plugins scanned this time (as opposed to known ones).

Definition at line 90 of file plugin_manager.h.

getCurrentlyScanningPlugin()

QString zrythm::gui::old_dsp::plugins::PluginManager::getCurrentlyScanningPlugin ( ) const

inline

Definition at line 34 of file plugin_manager.h.

getPluginDescriptors()

zrythm::plugins::discovery::PluginDescriptorList * zrythm::gui::old_dsp::plugins::PluginManager::getPluginDescriptors ( ) const

inline

Definition at line 45 of file plugin_manager.h.

getScanner()

::zrythm::plugins::PluginScanManager * zrythm::gui::old_dsp::plugins::PluginManager::getScanner ( ) const

inline

Definition at line 39 of file plugin_manager.h.

Property Documentation

currentlyScanningPlugin

QString zrythm::gui::old_dsp::plugins::PluginManager::currentlyScanningPlugin

read

Definition at line 27 of file plugin_manager.h.

pluginDescriptors

QML_ELEMENT zrythm::plugins::discovery::PluginDescriptorList * zrythm::gui::old_dsp::plugins::PluginManager::pluginDescriptors

read

Definition at line 25 of file plugin_manager.h.

scanner

zrythm::plugins::PluginScanManager * zrythm::gui::old_dsp::plugins::PluginManager::scanner

read

Definition at line 26 of file plugin_manager.h.

---

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

• src/gui/backend/plugin_manager.h