aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext/dynmanifest
diff options
context:
space:
mode:
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/dynmanifest')
-rw-r--r--lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h36
1 files changed, 18 insertions, 18 deletions
diff --git a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h
index 51908b7..b62f8ef 100644
--- a/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h
+++ b/lv2/lv2plug.in/ns/ext/dynmanifest/dynmanifest.h
@@ -37,7 +37,7 @@ extern "C" {
/**
Dynamic manifest generator handle.
-
+
This handle indicates a particular status of a dynamic manifest generator.
The host MUST NOT attempt to interpret it and, unlikely LV2_Handle, it is
NOT even valid to compare this to NULL. The dynamic manifest generator MAY
@@ -47,16 +47,16 @@ typedef void * LV2_Dyn_Manifest_Handle;
/**
Generate the dynamic manifest.
-
+
@param handle Pointer to an uninitialized dynamic manifest generator handle.
-
+
@param features NULL terminated array of LV2_Feature structs which represent
the features the host supports. The dynamic manifest generator may refuse to
(re)generate the dynamic manifest if required features are not found here
(however hosts SHOULD NOT use this as a discovery mechanism, instead of
reading the static manifest file). This array must always exist; if a host
has no features, it MUST pass a single element array containing NULL.
-
+
@return 0 on success, otherwise a non-zero error code. The host SHOULD
evaluate the result of the operation by examining the returned value and
MUST NOT try to interpret the value of handle.
@@ -66,25 +66,25 @@ int lv2_dyn_manifest_open(LV2_Dyn_Manifest_Handle * handle,
/**
Fetch a "list" of subject URIs described in the dynamic manifest.
-
+
The dynamic manifest generator has to fill the resource only with the needed
triples to make the host aware of the "objects" it wants to expose. For
example, if the plugin library exposes a regular LV2 plugin, it should
output only a triple like the following:
-
+
<http://www.example.com/plugin/uri> a lv2:Plugin .
-
+
The objects that are elegible for exposure are those that would need to be
represented by a subject node in a static manifest.
-
+
@param handle Dynamic manifest generator handle.
-
+
@param fp FILE * identifying the resource the host has to set up for the
dynamic manifest generator. The host MUST pass a writable, empty resource to
this function, and the dynamic manifest generator MUST ONLY perform write
operations on it at the end of the stream (e.g., using only fprintf(),
fwrite() and similar).
-
+
@return 0 on success, otherwise a non-zero error code.
*/
int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle,
@@ -92,7 +92,7 @@ int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle,
/**
Function that fetches data related to a specific URI.
-
+
The dynamic manifest generator has to fill the resource with data related to
object represented by the given URI. For example, if the library exposes a
regular LV2 plugin whose URI, as retrieved by the host using
@@ -106,18 +106,18 @@ int lv2_dyn_manifest_get_subjects(LV2_Dyn_Manifest_Handle handle,
lv2:binary <mylib.so> ;
etc:etc "..." .
</pre>
-
+
@param handle Dynamic manifest generator handle.
-
+
@param fp FILE * identifying the resource the host has to set up for the
dynamic manifest generator. The host MUST pass a writable resource to this
function, and the dynamic manifest generator MUST ONLY perform write
operations on it at the current position of the stream (e.g. using only
fprintf(), fwrite() and similar).
-
+
@param uri URI to get data about (in the "plain" form, i.e., absolute URI
without Turtle prefixes).
-
+
@return 0 on success, otherwise a non-zero error code.
*/
int lv2_dyn_manifest_get_data(LV2_Dyn_Manifest_Handle handle,
@@ -126,13 +126,13 @@ int lv2_dyn_manifest_get_data(LV2_Dyn_Manifest_Handle handle,
/**
Function that ends the operations on the dynamic manifest generator.
-
+
This function SHOULD be used by the dynamic manifest generator to perform
cleanup operations, etc.
-
+
Once this function is called, referring to handle will cause undefined
behavior.
-
+
@param handle Dynamic manifest generator handle.
*/
void lv2_dyn_manifest_close(LV2_Dyn_Manifest_Handle handle);