diff options
author | David Robillard <d@drobilla.net> | 2020-03-22 16:36:44 +0100 |
---|---|---|
committer | David Robillard <d@drobilla.net> | 2020-04-10 19:46:04 +0200 |
commit | 430284545345539c9ffb31df889debac1d3888b5 (patch) | |
tree | dc9bb1f32f0d6fe34a7339221389048e199f14a5 /lv2/dynmanifest/dynmanifest.ttl | |
parent | c4514483da1ab4f49148f9c4fe4ff5b559323217 (diff) | |
download | lv2-430284545345539c9ffb31df889debac1d3888b5.tar.xz |
Move documentation to metadata files and convert it to Markdown
Diffstat (limited to 'lv2/dynmanifest/dynmanifest.ttl')
-rw-r--r-- | lv2/dynmanifest/dynmanifest.ttl | 71 |
1 files changed, 5 insertions, 66 deletions
diff --git a/lv2/dynmanifest/dynmanifest.ttl b/lv2/dynmanifest/dynmanifest.ttl index caa2a08..c93120f 100644 --- a/lv2/dynmanifest/dynmanifest.ttl +++ b/lv2/dynmanifest/dynmanifest.ttl @@ -7,67 +7,10 @@ <http://lv2plug.in/ns/ext/dynmanifest> a lv2:Specification ; + rdfs:label "LV2 Dyn Manifest" ; + rdfs:comment "Support for dynamic manifest data generation." ; rdfs:seeAlso <dynmanifest.h> , - <dynmanifest.meta.ttl> ; - lv2:documentation """ -<p>The LV2 API, on its own, cannot be used to write plugin libraries where data -is dynamically generated at runtime (e.g. API wrappers), since LV2 requires -needed information to be provided in one or more static data (RDF) files. This -API addresses this limitation by extending the LV2 API.</p> - -<p>To detect that a plugin library implements a dynamic manifest generator, -the host checks its static manifest for a description like:</p> - -<pre class="turtle-code"> -<http://example.org/my-dynamic-manifest> - a dman:DynManifest ; - lv2:binary <mydynmanifest.so> . -</pre> - -<p>To load the data, the host loads the library -(e.g. <code>mydynmanifest.so</code>) as usual and fetches the dynamic Turtle -data from it using this API.</p> - -<p>The host is allowed to request regeneration of the dynamic manifest multiple -times, and the plugin library is expected to provide updated data if/when -possible. All data and references provided via this API before the last -regeneration of the dynamic manifest is to be considered invalid by the host, -including plugin descriptors whose URIs were discovered using this API.</p> - -<h3>Accessing Data</h3> - -<p>Whenever a host wants to access data using this API, it could:</p> - -<ol> -<li>Call lv2_dyn_manifest_open().</li> -<li>Create a FILE for functions to write data to (e.g. using tmpfile()).</li> -<li>Get a <q>list</q> of exposed subject URIs using - lv2_dyn_manifest_get_subjects().</li> -<li>Call lv2_dyn_manifest_get_data() for each URI of interest to - get the data related to that URI (which can be written to any FILE).</li> -<li>Call lv2_dyn_manifest_close().</li> -<li>Parse the content of the FILE(s).</li> -<li>Free/delete/unlink the FILE(s).</li> -</ol> - -<p>Each call to the above mentioned dynamic manifest functions MUST write a -complete, valid Turtle document (including all needed prefix definitions) to -the output FILE.</p> - -<p>Each call to lv2_dyn_manifest_open() causes the (re)generation of the -dynamic manifest data, and invalidates all data fetched before the call.</p> - -<p>In case the plugin library uses this same API to access other dynamic -manifests, it MUST implement some mechanism to avoid potentially endless loops -(such as A loads B, B loads A, etc.) and, in case such a loop is detected, the -operation MUST fail. For this purpose, use of a static boolean flag is -suggested.</p> - -<h3>Threading Rules</h3> - -<p>All of the functions defined by this specification belong to the Discovery -class.</p> -""" . + <dynmanifest.meta.ttl> . dman:DynManifest a rdfs:Class ; @@ -76,11 +19,7 @@ dman:DynManifest a owl:Restriction ; owl:onProperty lv2:binary ; owl:minCardinality 1 ; - rdfs:comment "A DynManifest MUST have at least 1 lv2:binary, which MUST implement all the functions defined in dynmanifest.h." + rdfs:comment "A DynManifest MUST have at least one lv2:binary." ] ; - rdfs:comment """The class which represents a dynamic manifest generator. - -There MUST NOT be any instances of dman:DynManifest in the generated manifest. - -All relative URIs in the generated data MUST be relative to the base path that would be used to parse a normal LV2 manifest (the bundle path).""" . + rdfs:comment "Dynamic manifest for an LV2 binary." . |