diff options
Diffstat (limited to 'lv2/lv2plug.in/ns/ext/options/options.ttl')
| -rw-r--r-- | lv2/lv2plug.in/ns/ext/options/options.ttl | 36 |
1 files changed, 26 insertions, 10 deletions
diff --git a/lv2/lv2plug.in/ns/ext/options/options.ttl b/lv2/lv2plug.in/ns/ext/options/options.ttl index c66aff3..12ac4aa 100644 --- a/lv2/lv2plug.in/ns/ext/options/options.ttl +++ b/lv2/lv2plug.in/ns/ext/options/options.ttl @@ -11,18 +11,17 @@ <../../meta/meta.ttl> , <lv2-options.doap.ttl> ; lv2:documentation """ -<p>This extension defines a facility for <q>options</q>, which are parameters -passed to a plugin, UI, or other instance at instantiation time. Like the -command-line <em>options</em> of a program, options do not change over the -lifetime of an instance.</p> -<p>Because they are available at instantiation time, options are useful for -adding parameters which are not suitable for dynamic control, such as those -that require expensive pre-computation. They are also useful for providing -information which would not otherwise be available.</p> +<p>This extension defines a facility for <q>options</q>, which are dynamic +properties that may be changed at run time.</p> -<p>Options are provided to instances by the host via the opts:options -feature.</p> +<p>There are two facilities for passing options to an instance: opts:options +allows passing options at instantiation time, and the opts:interface interface +allows options to be dynamically set and retrieved after instantiation.</p> + +<p>Note that this extension is only for allowing hosts to configure plugins, +and is not a <q>live</q> control mechanism. For real-time control, use +event-based control via an atom:AtomPort with an atom:Sequence buffer.</p> <p>Instances may indicate they <q>require</q> an option with the opts:requiredOption property, or that they optionally <q>support</q> an option @@ -43,6 +42,23 @@ given this type for documentation purposes, and to assist hosts in discovering option definitions.</p> """ . +opts:interface + a lv2:ExtensionData ; + lv2:documentation """ +<p>An interface (LV2_Options_Interface) for dynamically setting and getting +options. Note this is intended for use by the host for configuring plugins +only, and and is <em>not</em> a <q>live</q> plugin control mechanism.</p> + +<p>The plugin data file should describe this like so:</p> +<pre class="turtle-code"> +@prefix opts: <http://lv2plug.in/ns/ext/options#> . + +<plugin> + a lv2:Plugin ; + lv2:extensionData opts:interface . +</pre> +""" . + opts:options a lv2:Feature ; rdfs:label "options" ; |