LV2_External_UI_Host Struct Reference

On UI instantiation, host must supply LV2_EXTERNAL_UI__Host feature. More...

#include <plugins/lv2/lv2_external_ui.h>

Data Fields
void(*	ui_closed )(LV2UI_Controller controller)
	Callback that plugin UI will call when UI (GUI window) is closed by user.
const char *	plugin_human_id
	Optional (may be NULL) "user friendly" identifier which the UI may display to allow a user to easily associate this particular UI instance with the correct plugin instance as it is represented by the host (e.g.

Detailed Description

On UI instantiation, host must supply LV2_EXTERNAL_UI__Host feature.

LV2_Feature::data must be pointer to LV2_External_UI_Host.

Definition at line 77 of file lv2_external_ui.h.

Field Documentation

plugin_human_id

const char* LV2_External_UI_Host::plugin_human_id

Optional (may be NULL) "user friendly" identifier which the UI may display to allow a user to easily associate this particular UI instance with the correct plugin instance as it is represented by the host (e.g.

"track 1" or "channel 4").

If supplied by host, the string will be referenced only during LV2UI_Descriptor::instantiate()

Definition at line 105 of file lv2_external_ui.h.

ui_closed

void(* LV2_External_UI_Host::ui_closed) (LV2UI_Controller controller)

Callback that plugin UI will call when UI (GUI window) is closed by user.

This callback will be called during execution of LV2_External_UI_Widget::run() (i.e. not from background thread).

After this callback is called, UI is defunct. Host must call LV2UI_Descriptor::cleanup(). If host wants to make the UI visible again, the UI must be reinstantiated.

Note

When using the deprecated URI LV2_EXTERNAL_UI_DEPRECATED_URI, some hosts will not call LV2UI_Descriptor::cleanup() as they should, and may call show() again without re-initialization.

Parameters

controller

Host context associated with plugin UI, as supplied to LV2UI_Descriptor::instantiate().

Definition at line 94 of file lv2_external_ui.h.

---

The documentation for this struct was generated from the following file:

• plugins/lv2/lv2_external_ui.h