plugins/plugin_descriptor.h file

Contents

Base plugin.

Enums

enum ZPluginCategory { ZPLUGIN_CATEGORY_NONE, PC_DELAY, PC_REVERB, PC_DISTORTION, PC_WAVESHAPER, PC_DYNAMICS, PC_AMPLIFIER, PC_COMPRESSOR, PC_ENVELOPE, PC_EXPANDER, PC_GATE, PC_LIMITER, PC_FILTER, PC_ALLPASS_FILTER, PC_BANDPASS_FILTER, PC_COMB_FILTER, PC_EQ, PC_MULTI_EQ, PC_PARA_EQ, PC_HIGHPASS_FILTER, PC_LOWPASS_FILTER, PC_GENERATOR, PC_CONSTANT, PC_INSTRUMENT, PC_OSCILLATOR, PC_MIDI, PC_MODULATOR, PC_CHORUS, PC_FLANGER, PC_PHASER, PC_SIMULATOR, PC_SIMULATOR_REVERB, PC_SPATIAL, PC_SPECTRAL, PC_PITCH, PC_UTILITY, PC_ANALYZER, PC_CONVERTER, PC_FUNCTION, PC_MIXER }
Plugin category.
enum PluginProtocol { PROT_DUMMY, PROT_LV2, PROT_DSSI, PROT_LADSPA, PROT_VST, PROT_VST3, PROT_AU, PROT_SFZ, PROT_SF2 }
Plugin protocol.
enum PluginArchitecture { ARCH_32, ARCH_64 }
32 or 64 bit.
enum CarlaBridgeMode { CARLA_BRIDGE_NONE, CARLA_BRIDGE_UI, CARLA_BRIDGE_FULL }
Carla bridge mode.

Typedefs

using ZPluginCategory = enum ZPluginCategory
Plugin category.
using PluginProtocol = enum PluginProtocol
Plugin protocol.
using PluginArchitecture = enum PluginArchitecture
32 or 64 bit.
using CarlaBridgeMode = enum CarlaBridgeMode
Carla bridge mode.

Functions

void plugin_descriptor_copy(const PluginDescriptor* src, PluginDescriptor* dest)
Clones the plugin descriptor.
auto plugin_descriptor_clone(const PluginDescriptor* src) -> PluginDescriptor*
Clones the plugin descriptor.
auto plugin_descriptor_is_instrument(const PluginDescriptor* descr) -> int
Returns if the Plugin is an instrument or not.
auto plugin_descriptor_is_effect(PluginDescriptor* descr) -> int
Returns if the Plugin is an effect or not.
auto plugin_descriptor_is_modulator(PluginDescriptor* descr) -> int
Returns if the Plugin is a modulator or not.
auto plugin_descriptor_is_midi_modifier(PluginDescriptor* descr) -> int
Returns if the Plugin is a midi modifier or not.
auto plugin_descriptor_string_to_category(const char* str) -> ZPluginCategory
Returns the ZPluginCategory matching the given string.
auto plugin_descriptor_is_valid_for_slot_type(PluginDescriptor* self, int slot_type, int track_type) -> bool
Returns if the given plugin identifier can be dropped in a slot of the given type.
auto plugin_descriptor_has_custom_ui(PluginDescriptor* self) -> bool
Returns if the Plugin has a supported custom UI.