LV2  1.0.13
Data Fields
LV2UI_Port_Subscribe Struct Reference

Feature to subscribe to port updates (LV2_UI__portSubscribe). More...

Data Fields

LV2UI_Feature_Handle handle
 Pointer to opaque data which must be passed to subscribe() and unsubscribe(). More...
 
uint32_t(* subscribe )(LV2UI_Feature_Handle handle, uint32_t port_index, uint32_t port_protocol, const LV2_Feature *const *features)
 Subscribe to updates for a port. More...
 
uint32_t(* unsubscribe )(LV2UI_Feature_Handle handle, uint32_t port_index, uint32_t port_protocol, const LV2_Feature *const *features)
 Unsubscribe from updates for a port. More...
 

Detailed Description

Feature to subscribe to port updates (LV2_UI__portSubscribe).

Field Documentation

LV2UI_Feature_Handle LV2UI_Port_Subscribe::handle

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

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
handleThe handle field of this struct.
port_indexThe index of the port.
port_protocolThe URID of the ui:PortProtocol.
featuresFeatures for this subscription.
Returns
0 on success.
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
handleThe handle field of this struct.
port_indexThe index of the port.
port_protocolThe URID of the ui:PortProtocol.
featuresFeatures for this subscription.
Returns
0 on success.

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