From c35b46cb80712a0c84fa87f9a55ba7fbf21e1963 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Sat, 26 Apr 2014 20:01:35 +0000 Subject: Improve documentation. --- lv2/lv2plug.in/ns/lv2core/lv2core.ttl | 32 +++++++++++++++++--------------- 1 file changed, 17 insertions(+), 15 deletions(-) (limited to 'lv2/lv2plug.in/ns/lv2core/lv2core.ttl') diff --git a/lv2/lv2plug.in/ns/lv2core/lv2core.ttl b/lv2/lv2plug.in/ns/lv2core/lv2core.ttl index 7fbffd4..b48b4ca 100644 --- a/lv2/lv2plug.in/ns/lv2core/lv2core.ttl +++ b/lv2/lv2plug.in/ns/lv2core/lv2core.ttl @@ -61,10 +61,10 @@ and non-C programs to work with LV2 data. LV2 itself and extensions are distributed in a similar way.

An LV2 plugin library is suitable for dynamic loading (e.g. via -dlopen()) and provides one or more plugin descriptors via the -lv2_descriptor() function. These can be instantiated to create -plugin instances, which can be run directly on data or connected -together to perform advanced signal processing tasks.

+dlopen()) and provides one or more plugin descriptors via +lv2_descriptor() or lv2_lib_descriptor(). These can +be instantiated to create plugin instances, which can be run directly on +data or connected together to perform advanced signal processing tasks.

Plugins communicate via ports, which can transmit any type of data. Data is processed by first connecting each port to a buffer, then @@ -92,10 +92,11 @@ into several threading classes:

lv2_descriptor() LV2_Descriptor::instantiate() LV2_Descriptor::run() -LV2_Descriptor::extension_data() +lv2_lib_descriptor() LV2_Descriptor::cleanup() LV2_Descriptor::connect_port() -LV2_Descriptor::activate() +LV2_Descriptor::extension_data() + LV2_Descriptor::activate() LV2_Descriptor::deactivate() @@ -416,10 +417,11 @@ resolves to a shared library object (the actual type of this library is system specific).

This is a required property of a Plugin which MUST be included in the -bundle's manifest.ttl file. The lv2:binary of an lv2:Plugin is the -shared object containing the lv2_descriptor() function which can -be used to access the descriptor for that plugin. This property may be used -similarly by extensions to relate other resources to their implementations.

+bundle's manifest.ttl file. The lv2:binary of an lv2:Plugin is the shared +object containing the lv2_descriptor() or +lv2_lib_descriptor() function which can be used to access the +descriptor for that plugin. This property may be used similarly by extensions +to relate other resources to their implementations.

""" . lv2:appliesTo @@ -688,10 +690,10 @@ lv2:ExtensionData a rdfs:Class , owl:Class ; rdfs:label "Extension Data" ; - rdfs:comment """ -Additional data and/or functions a plugin may return from -LV2_Descriptor:extension_data() which can be used to add additional API beyond -that defined by LV2_Descriptor. + lv2:documentation """ +

Additional data and/or functions a plugin may return from +LV2_Descriptor::extension_data() which can be used to add additional API beyond +that defined by LV2_Descriptor.

""" . lv2:extensionData @@ -701,7 +703,7 @@ lv2:extensionData rdfs:label "extension data" ; lv2:documentation """

Signifies that a plugin provides additional data or functions (as defined by -some extension) via LV2:Descriptor::instantiate().

+some extension) via LV2_Descriptor::instantiate().

""" . lv2:isLive -- cgit v1.2.1