LV2 UI
type: Ontology
comment: User interfaces for LV2 plugins.
imports: lv2core
imports: options

User Interface
type: Class
comment: A UI for an LV2 plugin.

GTK2 UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a pointer to a Gtk+ 2.0 GtkWidget.

GTK3 UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a pointer to a Gtk+ 3.0 GtkWidget.

GTK4 UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a pointer to a Gtk+ 4.0 GtkWidget.

Qt4 UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a pointer to a Qt4 QWidget.

Qt5 UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a pointer to a Qt5 QWidget.

Qt6 UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a pointer to a Qt6 QWidget.

X11 UI
type: Class
subclass of: User Interface
comment: A UI where the widget is an X11 Window window ID.

Windows UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a Windows HWND window ID.

Cocoa UI
type: Class
subclass of: User Interface
comment: A UI where the widget is a pointer to a NSView.

user interface
type: Property
type: ObjectProperty
domain: Plugin
range: User Interface
comment: Relates a plugin to a UI that applies to it.

binary
type: Property
type: ObjectProperty
deprecated: true
comment: The shared library that a UI resides in.

make SO name resident
type: Feature
deprecated: true
comment: UI binary must not be unloaded.

no user resize
type: Feature
comment: Non-resizable UI.

fixed size
type: Feature
comment: Non-resizable UI that will never resize itself.

scale factor
type: Property
type: DatatypeProperty
type: Option
range: float
comment: Scale factor for high resolution screens.

background color
type: Property
type: DatatypeProperty
type: Option
comment: The background color of the host's UI.

foreground color
type: Property
type: DatatypeProperty
type: Option
comment: The foreground color of the host's UI.

parent
type: Feature
comment: The parent for a UI.

Port Notification
type: Class
subclass of: Restriction
  on property: plugin
  cardinality: 1
  comment: A PortNotification MUST have exactly one ui:plugin.
comment: A description of port updates that a host must send a UI.

port notification
type: Property
type: ObjectProperty
domain: User Interface
range: Port Notification
comment: Specifies a port notification that is required by a UI.

plugin
type: Property
type: ObjectProperty
domain: Port Notification
range: Plugin
comment: The plugin a portNotification applies to.

port index
type: Property
type: DatatypeProperty
domain: Port Notification
range: decimal
comment: The index of the port a portNotification applies to.

notify type
type: Property
type: ObjectProperty
domain: Port Notification
comment: A particular type that the UI should be notified of.

resize
type: Feature
type: ExtensionData
deprecated: true
comment: A feature that provides control of, and notifications about, a UI's size.

port map
type: Feature
comment: A feature for accessing the index of a port by symbol.

port subscribe
type: Feature
comment: A feature for dynamically subscribing to updates from a port.

touch
type: Feature
comment: A feature to notify that the user has grabbed a port control.

request value
type: Feature
comment: A feature to request a parameter value from the user via the host.

idle interface
type: Feature
type: ExtensionData
comment: A feature that provides a callback for the host to drive the UI.

show interface
type: ExtensionData
comment: An interface for showing and hiding a window for a UI.

window title
type: Property
type: DatatypeProperty
range: string
comment: The title for the window shown by LV2UI_Show_Interface.

update rate
type: Property
type: DatatypeProperty
range: float
comment: The target rate, in Hz, to send updates to the UI.

protocol
type: Property
type: ObjectProperty
domain: Port Notification
range: Port Protocol
comment: The protocol to be used for this notification.

Port Protocol
type: Class
subclass of: Feature
comment: A method to communicate port data between a UI and plugin.

float protocol
type: Port Protocol
comment: A protocol for transferring single floating point values.

peak protocol
type: Port Protocol
comment: A protocol for sending continuous peak measurements of an audio signal.