path: root/lv2/lv2plug.in/ns/extensions/ui
diff options
authorDavid Robillard <d@drobilla.net>2012-02-16 23:16:37 +0000
committerDavid Robillard <d@drobilla.net>2012-02-16 23:16:37 +0000
commit495f83c7f13349930df3526789d09c75c1312bd4 (patch)
tree5187d1b195dfd9e23caaafad30ab272882468720 /lv2/lv2plug.in/ns/extensions/ui
parent75d524c764a6f91aa9662040a2c218e8d2802438 (diff)
Implement real-time safe sample loading.
Diffstat (limited to 'lv2/lv2plug.in/ns/extensions/ui')
1 files changed, 22 insertions, 1 deletions
diff --git a/lv2/lv2plug.in/ns/extensions/ui/ui.ttl b/lv2/lv2plug.in/ns/extensions/ui/ui.ttl
index 9eb0933..010580f 100644
--- a/lv2/lv2plug.in/ns/extensions/ui/ui.ttl
+++ b/lv2/lv2plug.in/ns/extensions/ui/ui.ttl
@@ -204,7 +204,17 @@ A PortNotification MUST have exactly one ui:plugin which is a lv2:Plugin.
A PortNotification MUST have exactly one ui:portIndex which is an xsd:decimal.
] ;
- rdfs:comment "Port Notification" .
+ lv2:documentation """
+<p>A port notification. This describes which ports the host must send
+notifications to the UI about. The port can be specific by index, using the
+ui:portIndex property, or symbol, using the lv2:symbol property. Since port
+indices are not guaranteed to be stable between different revisions (or even
+instantiations) of a plugin, symbol is recommended, and index may only be used
+by UIs shipped in the same bundle as the plugin.</p>
+<p>A ui:PortNotification MUST have either a ui:portIndex or a lv2:symbol to
+indicate which port it refers to.</p>
+""" .
a rdf:Property ,
@@ -233,3 +243,14 @@ ui:portIndex
rdfs:comment """
The index of the port a portNotification applies to.
""" .
+ a rdf:Property ;
+ rdfs:domain ui:PortNotification ;
+ lv2:comment """
+<p>Indicates a particular type that the UI should be notified of. In the case
+of ports where several types of data can be present (e.g. event ports), this
+can be used to indicate that only a particular type of data should cause
+notification. This is useful where port traffic is very dense, but only a
+certain small number of events are actually of interest to the UI.</p>
+""" .