aboutsummaryrefslogtreecommitdiffstats
path: root/lv2/lv2plug.in/ns/ext/worker
diff options
context:
space:
mode:
authorDavid Robillard <d@drobilla.net>2015-01-19 17:29:34 -0500
committerDavid Robillard <d@drobilla.net>2015-01-19 17:29:34 -0500
commitbf89c83b8f81aa485d71d9c05c734c08fde4871e (patch)
tree09f49ae0945f5edc5e70c259b8d2568a21f1ac2b /lv2/lv2plug.in/ns/ext/worker
parent203f89011dcd8c96adfd2bb8205caf70e3eacbb5 (diff)
downloadlv2-bf89c83b8f81aa485d71d9c05c734c08fde4871e.tar.xz
Improve documentation.
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/worker')
-rw-r--r--lv2/lv2plug.in/ns/ext/worker/worker.ttl12
1 files changed, 12 insertions, 0 deletions
diff --git a/lv2/lv2plug.in/ns/ext/worker/worker.ttl b/lv2/lv2plug.in/ns/ext/worker/worker.ttl
index 8ab330d..fb182a7 100644
--- a/lv2/lv2plug.in/ns/ext/worker/worker.ttl
+++ b/lv2/lv2plug.in/ns/ext/worker/worker.ttl
@@ -54,4 +54,16 @@ work:schedule
worker method. To support this feature, the host must pass an LV2_Feature to
LV2_Descriptor::instantiate() with URI LV2_WORKER__schedule and data pointed to
an instance of LV2_Worker_Schedule.</p>
+
+<p>The plugin data file should describe this like so:</p>
+<pre class="turtle-code">
+@prefix work: &lt;http://lv2plug.in/ns/ext/worker#&gt; .
+
+&lt;plugin&gt;
+ a lv2:Plugin ;
+ lv2:requiredFeature work:schedule .
+</pre>
+
+<p>As usual, lv2:optionalFeature may be used instead, if the plugin is capable
+of running in a host that does not provide this feature.</p>
""" .