zrythm::plugins::PluginConfiguration Class Reference

Configuration for instantiating a plugin descriptor. More...

#include <src/plugins/plugin_configuration.h>

Inheritance diagram for zrythm::plugins::PluginConfiguration:

Collaboration diagram for zrythm::plugins::PluginConfiguration:

Public Types
enum class	HostingType : std::uint8_t { JUCE , Custom }

Public Member Functions
	PluginConfiguration (QObject *parent=nullptr)
PluginDescriptor *	descriptor () const
void	validate ()
	Makes sure the setting is valid in the current run and changes any fields to make it conform.
void	print () const
zrythm::plugins::PluginDescriptor *	get_descriptor () const
auto	get_name () const
void	copy_fields_from (const PluginConfiguration &other)

Static Public Member Functions
static std::unique_ptr< PluginConfiguration >	create_new_for_descriptor (const zrythm::plugins::PluginDescriptor &descr)
	Creates a plugin setting with the recommended settings for the given plugin descriptor based on the current setup.

Data Fields
std::unique_ptr< zrythm::plugins::PluginDescriptor >	descr_
	The descriptor of the plugin this setting is for.
HostingType	hosting_type_ { HostingType::JUCE }
bool	force_generic_ui_ {}
	Whether to force a generic UI.
zrythm::plugins::BridgeMode	bridge_mode_ {}
	Requested carla bridge mode.

Properties
zrythm::plugins::PluginDescriptor *	descriptor

Friends
void	init_from (PluginConfiguration &obj, const PluginConfiguration &other, utils::ObjectCloneType clone_type)
void	to_json (nlohmann::json &j, const PluginConfiguration &p)
void	from_json (const nlohmann::json &j, PluginConfiguration &p)

Detailed Description

Configuration for instantiating a plugin descriptor.

(Previously PluginSetting).

Definition at line 16 of file plugin_configuration.h.

Member Enumeration Documentation

HostingType

enum class zrythm::plugins::PluginConfiguration::HostingType : std::uint8_t

strong

Enumerator
JUCE	Plugin hosted via JUCE.
Custom	Plugin hosted via custom plugin format implementation. Note Unimplemented.

Definition at line 41 of file plugin_configuration.h.

Constructor & Destructor Documentation

PluginConfiguration()

zrythm::plugins::PluginConfiguration::PluginConfiguration ( QObject * parent = nullptr )

inline

Definition at line 24 of file plugin_configuration.h.

Member Function Documentation

descriptor()

PluginDescriptor * zrythm::plugins::PluginConfiguration::descriptor ( ) const

inline

Definition at line 30 of file plugin_configuration.h.

get_descriptor()

zrythm::plugins::PluginDescriptor * zrythm::plugins::PluginConfiguration::get_descriptor ( ) const

inline

Definition at line 70 of file plugin_configuration.h.

get_name()

auto zrythm::plugins::PluginConfiguration::get_name ( ) const

inline

Definition at line 75 of file plugin_configuration.h.

Friends And Related Symbol Documentation

to_json

void to_json ( nlohmann::json & j, const PluginConfiguration & p )

friend

Definition at line 83 of file plugin_configuration.h.

Field Documentation

bridge_mode_

zrythm::plugins::BridgeMode zrythm::plugins::PluginConfiguration::bridge_mode_ {}

Requested carla bridge mode.

Definition at line 103 of file plugin_configuration.h.

descr_

std::unique_ptr<zrythm::plugins::PluginDescriptor> zrythm::plugins::PluginConfiguration::descr_

The descriptor of the plugin this setting is for.

Definition at line 95 of file plugin_configuration.h.

force_generic_ui_

bool zrythm::plugins::PluginConfiguration::force_generic_ui_ {}

Whether to force a generic UI.

Definition at line 100 of file plugin_configuration.h.

hosting_type_

HostingType zrythm::plugins::PluginConfiguration::hosting_type_ { HostingType::JUCE }

Definition at line 97 of file plugin_configuration.h.

Property Documentation

descriptor

zrythm::plugins::PluginDescriptor * zrythm::plugins::PluginConfiguration::descriptor

read

Definition at line 19 of file plugin_configuration.h.

---

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

• src/plugins/plugin_configuration.h