Plugin related utilities

Functions
const char *	getBinaryFilename ()
const char *	getPluginFormatName () noexcept
const char *	getResourcePath (const char *bundlePath) noexcept

Detailed Description

Function Documentation

getBinaryFilename()

const char* getBinaryFilename

(

)

Get the absolute filename of the plugin DSP/UI binary.
Under certain systems or plugin formats the binary will be inside the plugin bundle.
Also, in some formats or setups, the DSP and UI binaries are in different files.

getPluginFormatName()

const char* getPluginFormatName ( )

noexcept

Get a string representation of the current plugin format we are building against.
This can be "JACK/Standalone", "LADSPA", "DSSI", "LV2", "VST2" or "VST3".
This string is purely informational and must not be used to tweak plugin behaviour.

Note

DO NOT CHANGE PLUGIN BEHAVIOUR BASED ON PLUGIN FORMAT.

getResourcePath()

const char* getResourcePath ( const char *  bundlePath )

noexcept

Get the path to where resources are stored within the plugin bundle.
Requires a valid plugin bundle path.

Returns a path inside the bundle where the plugin is meant to store its resources in.
This path varies between systems and plugin formats, like so:

• LV2: <bundle>/resources (can be stored anywhere inside the bundle really, DPF just uses this one)
• VST2 macOS: <bundle>/Contents/Resources
• VST2 non-macOS: <bundle>/resources (see note)

The other non-mentioned formats do not support bundles.

Note

For VST2 on non-macOS systems, this assumes you have your plugin inside a dedicated directory rather than only shipping with the binary (e.g. <myplugin.vst>/myplugin.dll)