LV2  1.0.13
Data Structures | Macros | Enumerations
options.h File Reference

Data Structures

struct  LV2_Options_Option
 An option. More...
struct  LV2_Options_Interface
 Interface for dynamically setting options (LV2_OPTIONS__interface). More...

Macros

#define LV2_OPTIONS_URI   "http://lv2plug.in/ns/ext/options"
#define LV2_OPTIONS_PREFIX   LV2_OPTIONS_URI "#"
#define LV2_OPTIONS__Option   LV2_OPTIONS_PREFIX "Option"
#define LV2_OPTIONS__interface   LV2_OPTIONS_PREFIX "interface"
#define LV2_OPTIONS__options   LV2_OPTIONS_PREFIX "options"
#define LV2_OPTIONS__requiredOption   LV2_OPTIONS_PREFIX "requiredOption"
#define LV2_OPTIONS__supportedOption   LV2_OPTIONS_PREFIX "supportedOption"

Enumerations

enum  LV2_Options_Context { LV2_OPTIONS_INSTANCE, LV2_OPTIONS_RESOURCE, LV2_OPTIONS_BLANK, LV2_OPTIONS_PORT }
 The context of an Option, which defines the subject it applies to. More...
enum  LV2_Options_Status {
  LV2_OPTIONS_SUCCESS = 0, LV2_OPTIONS_ERR_UNKNOWN = 1, LV2_OPTIONS_ERR_BAD_SUBJECT = 1 << 1, LV2_OPTIONS_ERR_BAD_KEY = 1 << 2,
  LV2_OPTIONS_ERR_BAD_VALUE = 1 << 3
}
 A status code for option functions. More...

Macro Definition Documentation

#define LV2_OPTIONS_URI   "http://lv2plug.in/ns/ext/options"
#define LV2_OPTIONS_PREFIX   LV2_OPTIONS_URI "#"
#define LV2_OPTIONS__Option   LV2_OPTIONS_PREFIX "Option"
#define LV2_OPTIONS__interface   LV2_OPTIONS_PREFIX "interface"
#define LV2_OPTIONS__options   LV2_OPTIONS_PREFIX "options"
#define LV2_OPTIONS__requiredOption   LV2_OPTIONS_PREFIX "requiredOption"
#define LV2_OPTIONS__supportedOption   LV2_OPTIONS_PREFIX "supportedOption"

Enumeration Type Documentation

The context of an Option, which defines the subject it applies to.

Enumerator:
LV2_OPTIONS_INSTANCE 

This option applies to the instance itself.

The subject must be ignored.

LV2_OPTIONS_RESOURCE 

This option applies to some named resource.

The subject is a URI mapped to an integer (a LV2_URID, like the key)

LV2_OPTIONS_BLANK 

This option applies to some blank node.

The subject is a blank node identifier, which is valid only within the current local scope.

LV2_OPTIONS_PORT 

This option applies to a port on the instance.

The subject is the port's index.

A status code for option functions.

Enumerator:
LV2_OPTIONS_SUCCESS 

Completed successfully.

LV2_OPTIONS_ERR_UNKNOWN 

Unknown error.

LV2_OPTIONS_ERR_BAD_SUBJECT 

Invalid/unsupported subject.

LV2_OPTIONS_ERR_BAD_KEY 

Invalid/unsupported key.

LV2_OPTIONS_ERR_BAD_VALUE 

Invalid/unsupported value.