LV2_Event_Feature Struct Reference

The data field of the LV2_Feature for this extension. More...

#include <lv2_event.h>

List of all members.

Public Attributes

LV2_Event_Callback_Data callback_data
 Opaque pointer to host data.
uint32_t(* lv2_event_ref )(LV2_Event_Callback_Data callback_data, LV2_Event *event)
 Take a reference to a non-POD event.
uint32_t(* lv2_event_unref )(LV2_Event_Callback_Data callback_data, LV2_Event *event)
 Drop a reference to a non-POD event.


Detailed Description

The data field of the LV2_Feature for this extension.

To support this feature the host must pass an LV2_Feature struct to the plugin's instantiate method with URI "http://lv2plug.in/ns/ext/event" and data pointed to an instance of this struct.


Member Data Documentation

Opaque pointer to host data.

The plugin MUST pass this to any call to functions in this struct. Otherwise, it must not be interpreted in any way.

Take a reference to a non-POD event.

If a plugin receives an event with type 0, it means the event is a pointer to some object in memory and not a flat sequence of bytes in the buffer. When receiving a non-POD event, the plugin already has an implicit reference to the event. If the event is stored AND passed to an output, lv2_event_ref MUST be called on that event. If the event is only stored OR passed through, this is not necessary (as the plugin already has 1 implicit reference).

Parameters:
event An event received at an input that will not be copied to an output or stored in any way.
context The calling context. (Like event types) this is a mapped URI, see lv2_context.h. Simple plugin with just a run() method should pass 0 here (the ID of the 'standard' LV2 run context). The host guarantees that this function is realtime safe iff context is realtime safe.
PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS.

Drop a reference to a non-POD event.

If a plugin receives an event with type 0, it means the event is a pointer to some object in memory and not a flat sequence of bytes in the buffer. If the plugin does not pass the event through to an output or store it internally somehow, it MUST call this function on the event (more information on using non-POD events below).

Parameters:
event An event received at an input that will not be copied to an output or stored in any way.
context The calling context. (Like event types) this is a mapped URI, see lv2_context.h. Simple plugin with just a run() method should pass 0 here (the ID of the 'standard' LV2 run context). The host guarantees that this function is realtime safe iff context is realtime safe.
PLUGINS THAT VIOLATE THESE RULES MAY CAUSE CRASHES AND MEMORY LEAKS.


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

Generated on Mon Aug 3 16:01:42 2009 for RAUL by  doxygen 1.5.9