lilv.plugin

class Plugin Plugins

Types 2

classPlugin

An LV2 plugin.

Fields

private const(LilvPlugin) * _cPtr

private World _world

Methods

const(LilvPlugin) * handle() @property @nogc nothrow

World world() @property @nogc nothrow

bool verify() @nogc nothrowCheck if plugin is valid.

Node uri() @propertyGet the URI of plugin.

Node bundleUri() @propertyGet the (resolvable) URI of the plugin’s “main” bundle.

Node libraryUri() @propertyGet the (resolvable) URI of the shared library for plugin.

Nodes dataUris() @propertyGet the (resolvable) URIs of the RDF data files that define a plugin.

Node name() @propertyGet the name of plugin.

PluginClass pluginClass() @propertyGet the class this plugin belongs to (like “Filters” or “Effects”). Returns: Plugin class name

Nodes getValue(Node predicate)Get a value associated with the plugin in a plugin’s data files. Params: predicate = must be either a URI or a QName.

bool hasFeature(Node feature) @nogc nothrowReturn whether a feature is supported by a plugin. Returns: This will return true if the feature is an optional or required feature of the plugin.

Nodes supportedFeatures()Get the LV2 Features supported (required or optionally) by a plugin.

Nodes requiredFeatures()Get the LV2 Features required by a plugin.

Nodes optionalFeatures()Get the LV2 Features optionally supported by a plugin.

bool hasExtensionData(Node uri) @nogc nothrowReturn whether or not a plugin provides a specific extension data. Params: uri = The URI of the extension data Returns: true if the plugin has the given extension data

Nodes extensionData()Get a sequence of all extension data provided by a plugin.

uint numPorts() @property @nogc nothrowGet the number of ports on this plugin.

void getPortRangesFloat(float[] minValues, float[] maxValues, float[] defValues) @nogc nothrowGet the port ranges (minimum, maximum and default values) for all ports.

bool hasLatency() @nogc nothrowReturn whether or not the plugin introduces (and reports) latency.

uint latencyPortIndex() @nogc nothrowReturn the index of the plugin’s latency port.

Port portByIndex(uint index)Get a port on plugin by index. Params: index = Port index Returns: The port or null

Port portBySymbol(Node symbol)Get a port on plugin by symbol. Note this function is slower than portByIndex(), especially on plugins with a very large number of ports. Returns: The port or null

Port portByDesignation(Node portClass, Node designation)Get a port on plugin by its lv2:designation.

Node project()Get the project the plugin is a part of.

Node authorName()Get the full name of the plugin’s author.

Node authorEmail()Get the email address of the plugin’s author. Returns: null if author email address is not present.

Node authorHomepage()Get the address of the plugin author’s home page. Returns: null if author homepage is not present.

bool isReplaced() @nogc nothrowReturn true if plugin has been replaced by another plugin. The plugin will still be usable, but hosts should hide them from their user interfaces to prevent users from using deprecated plugins. Ret...

Nodes related(Node type)Get the resources related to plugin with lv2:appliesTo.

UIs uis()Get all UIs for plugin. Returns: Collection of UIs or null

Instance instantiate(double sampleRate, const(LV2_Feature *) * features = null)Instantiate a plugin.

Instance instantiate(double sampleRate, Feature[] features = null)Instantiate a plugin.

Constructors

this(const(LilvPlugin) * p, World world)

Destructors

~this

classPlugins

Collection of all plugins discovered by a World.

Methods

Plugin getByUri(Node uri)Get plugin by URI Params: uri = URI Returns: Plugin with the given URI or null