Plugin Hints

Variables
static constexpr const uint	PLUGIN_IS_BRIDGE = 0x001
static constexpr const uint	PLUGIN_IS_RTSAFE = 0x002
static constexpr const uint	PLUGIN_IS_SYNTH = 0x004
static constexpr const uint	PLUGIN_HAS_CUSTOM_UI = 0x008
static constexpr const uint	PLUGIN_CAN_DRYWET = 0x010
static constexpr const uint	PLUGIN_CAN_VOLUME = 0x020
static constexpr const uint	PLUGIN_CAN_BALANCE = 0x040
static constexpr const uint	PLUGIN_CAN_PANNING = 0x080
static constexpr const uint	PLUGIN_NEEDS_FIXED_BUFFERS = 0x100
static constexpr const uint	PLUGIN_NEEDS_UI_MAIN_THREAD = 0x200
static constexpr const uint	PLUGIN_USES_MULTI_PROGS = 0x400
static constexpr const uint	PLUGIN_HAS_INLINE_DISPLAY = 0x800
static constexpr const uint	PLUGIN_HAS_CUSTOM_EMBED_UI = 0x1000
static constexpr const uint	PLUGIN_HAS_CUSTOM_UI_USING_FILE_OPEN = 0x2000
static constexpr const uint	PLUGIN_NEEDS_MAIN_THREAD_IDLE = 0x4000

Detailed Description

Various plugin hints.

See also

CarlaPlugin::getHints() and carla_get_plugin_info()

Variable Documentation

PLUGIN_CAN_BALANCE

const uint PLUGIN_CAN_BALANCE = 0x040

staticconstexpr

Plugin can use internal (Stereo) Balance controls.

PLUGIN_CAN_DRYWET

const uint PLUGIN_CAN_DRYWET = 0x010

staticconstexpr

Plugin can use internal Dry/Wet control.

PLUGIN_CAN_PANNING

const uint PLUGIN_CAN_PANNING = 0x080

staticconstexpr

Plugin can use internal (Mono) Panning control.

PLUGIN_CAN_VOLUME

const uint PLUGIN_CAN_VOLUME = 0x020

staticconstexpr

Plugin can use internal Volume control.

PLUGIN_HAS_CUSTOM_EMBED_UI

const uint PLUGIN_HAS_CUSTOM_EMBED_UI = 0x1000

staticconstexpr

Plugin has its own custom UI which can be embed into another Window.

See also

CarlaPlugin::embedCustomUI() and carla_embed_custom_ui()

Note

This is very experimental and subject to change at this point

PLUGIN_HAS_CUSTOM_UI

const uint PLUGIN_HAS_CUSTOM_UI = 0x008

staticconstexpr

Plugin has its own custom UI.

See also

CarlaPlugin::showCustomUI() and carla_show_custom_ui()

PLUGIN_HAS_CUSTOM_UI_USING_FILE_OPEN

const uint PLUGIN_HAS_CUSTOM_UI_USING_FILE_OPEN = 0x2000

staticconstexpr

Plugin custom UI is a fake one that simply invokes an open file browser dialog.

PLUGIN_HAS_INLINE_DISPLAY

const uint PLUGIN_HAS_INLINE_DISPLAY = 0x800

staticconstexpr

Plugin can make use of inline display API.

PLUGIN_IS_BRIDGE

const uint PLUGIN_IS_BRIDGE = 0x001

staticconstexpr

Plugin is a bridge. This hint is required because "bridge" itself is not a plugin type.

PLUGIN_IS_RTSAFE

const uint PLUGIN_IS_RTSAFE = 0x002

staticconstexpr

Plugin is hard real-time safe.

PLUGIN_IS_SYNTH

const uint PLUGIN_IS_SYNTH = 0x004

staticconstexpr

Plugin is a synth (produces sound).

PLUGIN_NEEDS_FIXED_BUFFERS

const uint PLUGIN_NEEDS_FIXED_BUFFERS = 0x100

staticconstexpr

Plugin needs a constant, fixed-size audio buffer.

PLUGIN_NEEDS_MAIN_THREAD_IDLE

const uint PLUGIN_NEEDS_MAIN_THREAD_IDLE = 0x4000

staticconstexpr

Plugin needs all idle events in the main thread.

Note

Not possible on all engine implementations.

PLUGIN_NEEDS_UI_MAIN_THREAD

const uint PLUGIN_NEEDS_UI_MAIN_THREAD = 0x200

staticconstexpr

Plugin needs to receive all UI events in the main thread.

PLUGIN_USES_MULTI_PROGS

const uint PLUGIN_USES_MULTI_PROGS = 0x400

staticconstexpr

Plugin uses 1 program per MIDI channel.

Note

: Only used in some internal plugins and sf2 files.