LV2  1.0.13
Data Structures | Macros | Typedefs | Enumerations
worker.h File Reference

C header for the LV2 Worker extension http://lv2plug.in/ns/ext/worker. More...

Data Structures

struct  LV2_Worker_Interface
 LV2 Plugin Worker Interface. More...
struct  LV2_Worker_Schedule

Macros

#define LV2_WORKER_URI   "http://lv2plug.in/ns/ext/worker"
#define LV2_WORKER_PREFIX   LV2_WORKER_URI "#"
#define LV2_WORKER__interface   LV2_WORKER_PREFIX "interface"
#define LV2_WORKER__schedule   LV2_WORKER_PREFIX "schedule"

Typedefs

typedef void * LV2_Worker_Respond_Handle
typedef LV2_Worker_Status(* LV2_Worker_Respond_Function )(LV2_Worker_Respond_Handle handle, uint32_t size, const void *data)
 A function to respond to run() from the worker method.
typedef void * LV2_Worker_Schedule_Handle

Enumerations

enum  LV2_Worker_Status { LV2_WORKER_SUCCESS = 0, LV2_WORKER_ERR_UNKNOWN = 1, LV2_WORKER_ERR_NO_SPACE = 2 }
 A status code for worker functions. More...

Detailed Description

C header for the LV2 Worker extension http://lv2plug.in/ns/ext/worker.

Macro Definition Documentation

#define LV2_WORKER_URI   "http://lv2plug.in/ns/ext/worker"
#define LV2_WORKER_PREFIX   LV2_WORKER_URI "#"
#define LV2_WORKER__interface   LV2_WORKER_PREFIX "interface"
#define LV2_WORKER__schedule   LV2_WORKER_PREFIX "schedule"

Typedef Documentation

typedef LV2_Worker_Status(* LV2_Worker_Respond_Function)(LV2_Worker_Respond_Handle handle, uint32_t size, const void *data)

A function to respond to run() from the worker method.

The data MUST be safe for the host to copy and later pass to work_response(), and the host MUST guarantee that it will be eventually passed to work_response() if this function returns LV2_WORKER_SUCCESS.

Enumeration Type Documentation

A status code for worker functions.

Enumerator:
LV2_WORKER_SUCCESS 

Completed successfully.

LV2_WORKER_ERR_UNKNOWN 

Unknown error.

LV2_WORKER_ERR_NO_SPACE 

Failed due to lack of space.