_LV2UI_Port_Subscribe Struct Reference

#include <ui.h>

Public Attributes
LV2UI_Feature_Handle	handle
uint32_t(*	subscribe )(LV2UI_Feature_Handle handle, uint32_t port_index, uint32_t port_protocol, const LV2_Feature *const *features)
uint32_t(*	unsubscribe )(LV2UI_Feature_Handle handle, uint32_t port_index, uint32_t port_protocol, const LV2_Feature *const *features)

Detailed Description

Feature to subscribe to port updates (LV2_UI__portSubscribe).

Member Data Documentation

handle

LV2UI_Feature_Handle _LV2UI_Port_Subscribe::handle

Pointer to opaque data which must be passed to subscribe() and unsubscribe().

subscribe

uint32_t(* _LV2UI_Port_Subscribe::subscribe)(LV2UI_Feature_Handle handle, uint32_t port_index, uint32_t port_protocol, const LV2_Feature *const *features)

Subscribe to updates for a port.

This means that the host will call the UI's port_event() function when the port value changes (as defined by protocol).

Calling this function with the same port_index and port_protocol as an already active subscription has no effect.

Parameters

handle	The handle field of this struct.
port_index	The index of the port.
port_protocol	The URID of the ui:PortProtocol.
features	Features for this subscription.

Returns

0 on success.

Subscribe to updates for a port.

This means that the host will call the UI's port_event() function when the port value changes (as defined by protocol).

Calling this function with the same port_index and port_protocol as an already active subscription has no effect.

Parameters

handle	The handle field of this struct.
port_index	The index of the port.
port_protocol	The URID of the ui:PortProtocol.
features	Features for this subscription.

Returns

0 on success.

unsubscribe

uint32_t(* _LV2UI_Port_Subscribe::unsubscribe)(LV2UI_Feature_Handle handle, uint32_t port_index, uint32_t port_protocol, const LV2_Feature *const *features)

Unsubscribe from updates for a port.

This means that the host will cease calling calling port_event() when the port value changes.

Calling this function with a port_index and port_protocol that does not refer to an active port subscription has no effect.

Parameters

handle	The handle field of this struct.
port_index	The index of the port.
port_protocol	The URID of the ui:PortProtocol.
features	Features for this subscription.

Returns

0 on success.

Unsubscribe from updates for a port.

This means that the host will cease calling calling port_event() when the port value changes.

Calling this function with a port_index and port_protocol that does not refer to an active port subscription has no effect.

Parameters

handle	The handle field of this struct.
port_index	The index of the port.
port_protocol	The URID of the ui:PortProtocol.
features	Features for this subscription.

Returns

0 on success.

---

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

• /home/runner/work/lmms-fork/lmms-fork/plugins/CarlaBase/carla/source/includes/lv2/ui.h
• /home/runner/work/lmms-fork/lmms-fork/plugins/LadspaEffect/calf/veal/src/calf/lv2_ui.h