From f4baa8b70e3d26bc3f19e230729f0f409afb36e3 Mon Sep 17 00:00:00 2001
From: Lars Luthman This extension defines an interface that can be used to create UIs for
+plugins. The UIs are code that reside in shared object files in an LV2
+bundle and are referenced in the RDF data using the triples
+
+ @prefix ui: <http://lv2plug.in/ns/ext/ui#>.
+ <http://my.pluginui> a ui-gtk:GtkUI;
+ lv2:appliesTo <http://my.plugin>;
+ ui:binary <myui.so>.
+
+where <http://my.plugin> is the URI of the plugin,
+<http://my.pluginui> is
+the URI of the plugin UI and <myui.so> is the relative URI
+to the shared
+object file. While it is possible to have the plugin UI and the plugin in
+the same shared object file it is probably a good idea to keep them
+separate so that hosts that don't want UIs don't have to load the UI code.
+
A UI MUST specify its class in the RDF data and the class MUST be a proper +subclass of ui:UI, in this case ui-gtk:GtkUI. The class defines what type the UI +is, e.g. what graphics toolkit it uses. There are no UI classes defined in +this extension, those are specified separately (and anyone can define their +own). +
+ +It's entirely possible to have multiple UIs for the same plugin, or to have +the UI for a plugin in a different bundle from the actual plugin - this +way people other than the plugin author can write plugin UIs independently +without editing the original plugin bundle. It is also possible to have one +UI that works with several different plugins. +
+ +UIs should also be written in such a way that the host may load several +instances of an UI, or different UIs, and use them with the same plugin +instance. +
+ +Note that the process that loads the shared object file containing the UI +code and the process that loads the shared object file containing the +actual plugin implementation do not have to be the same. There are many +valid reasons for having the plugin and the UI in different processes, or +even on different machines. This means that you can not use singletons +and global variables and expect them to refer to the same objects in the +UI and the actual plugin. The function callback interface defined in the +header lv2_ui.h is all you can expect to work. +
+""". + +############## +## UI Class ## +############## + +ui:UI a rdfs:Class; + rdfs:subClassOf lv2:Feature; + rdfs:label "UI"; + lv2:documentation """ +The class which represents an LV2 plugin UI. +
+ +To be used by a host a UI MUST have at least the following properties: +
+ rdf:type (with object a proper subclass of ui:UI) + doap:name (one without language tag) + lv2:binary (with a shared object file as object) + lv2:appliesTo (with a LV2 plugin as object) ++The rdf:type of an UI is used by the host to decide whether it supports the +UI and how to handle the LV2_UI_Widget object that is returned by the UIs +get_widget() function. For example, a type of ui-gtk:GtkGUI might tell the host +that LV2_UI_Widget is a pointer to an object of a type defined in the Gtk+ +library. No UI types are defined in this extension, that is intentionally +left for other extensions. + + +
The doap:name property should be at most a few words in length using title +capitalization, e.g. "Flashy Mixer GUI". Use lv2:documentation for more +detailed descriptions.
+ +UIs may have optional or required features, specified using lv2:optionalFeature +or lv2:requiredFeature. The same rules apply here as for plugins; a host MUST +pass the LV2_Feature objects for all features it supports to the UI's +instantiate() function, a host SHOULD not try to instantiate an UI if it +doesn't support all of it's required features, and an UI MUST fail to +instantiate if the host doesn't pass all required features to instantiate(). +
+ +For details about the C API used to load UIs, see the file lv2_ui.h. +
+""" . + + +#################### +## Port Protocols ## +#################### + +ui:PortProtocol a rdfs:Class; + rdfs:subClassOf lv2:Feature; + rdfs:label "Port protocol"; + lv2:documentation """ +A PortProtocol defines a certain way of communicating port data between UI +and plugin. PortProtocols can be specified in additional extensions, and +those extensions MUST specify +
+ +For an example, see ui:floatControl. +
+ +PortProtocol is a subclass of lv2:Feature, so UIs use lv2:optionalFeature and +lv2:requiredFeature to specify which PortProtocols they want to use. +
+""". + +ui:floatControl a ui:PortProtocol; + rdfs:label "Floating point value"; + lv2:documentation """ +