Struct lv2_raw::ui::LV2UIExternalUIHost [−] [src]

#[repr(C)]

pub struct LV2UIExternalUIHost {
    pub ui_closed: extern "C" fn(_: LV2UIControllerRaw) -> c_void,
    pub plugin_human_id: *const c_char,
}

On UI instantiation, host must supply LV2_EXTERNAL_UI__Host feature. LV2_Feature::data must be pointer to LV2_External_UI_Host.

Fields

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 depreated 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.

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

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()