LV2  1.0.13
Data Structures | Enumerations | Macros
Options

Detailed Description

Instantiation time options, see http://lv2plug.in/ns/ext/options for details.

Data Structures

struct  LV2_Options_Option
 
struct  LV2_Options_Interface
 

Enumerations

enum  LV2_Options_Context {
  LV2_OPTIONS_INSTANCE,
  LV2_OPTIONS_RESOURCE,
  LV2_OPTIONS_BLANK,
  LV2_OPTIONS_PORT
}
 
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
}
 

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"
 

Data Structure Documentation

§ LV2_Options_Option

struct LV2_Options_Option

An option.

This is a property with a subject, also known as a triple or statement.

This struct is useful anywhere a statement needs to be passed where no memory ownership issues are present (since the value is a const pointer).

Options can be passed to an instance via the feature LV2_OPTIONS__options with data pointed to an array of options terminated by a zeroed option, or accessed/manipulated using LV2_Options_Interface.

Data Fields
LV2_Options_Context context Context (type of subject).
uint32_t subject Subject.
LV2_URID key Key (property).
uint32_t size Size of value in bytes.
LV2_URID type Type of value (datatype).
const void * value Pointer to value (object).

§ LV2_Options_Interface

struct LV2_Options_Interface

Interface for dynamically setting options (LV2_OPTIONS__interface).

Data Fields

uint32_t(* get )(LV2_Handle instance, LV2_Options_Option *options)
 
uint32_t(* set )(LV2_Handle instance, const LV2_Options_Option *options)
 

Field Documentation

§ get

uint32_t(* LV2_Options_Interface::get) (LV2_Handle instance, LV2_Options_Option *options)

Get the given options.

Each element of the passed options array MUST have type, subject, and key set. All other fields (size, type, value) MUST be initialised to zero, and are set to the option value if such an option is found.

This function is in the "instantiation" LV2 threading class, so no other instance functions may be called concurrently.

Returns
Bitwise OR of LV2_Options_Status values.

§ set

uint32_t(* LV2_Options_Interface::set) (LV2_Handle instance, const LV2_Options_Option *options)

Set the given options.

This function is in the "instantiation" LV2 threading class, so no other instance functions may be called concurrently.

Returns
Bitwise OR of LV2_Options_Status values.

Macro Definition Documentation

§ LV2_OPTIONS_URI

#define LV2_OPTIONS_URI   "http://lv2plug.in/ns/ext/options"

§ LV2_OPTIONS_PREFIX

#define LV2_OPTIONS_PREFIX   LV2_OPTIONS_URI "#"

§ LV2_OPTIONS__Option

#define LV2_OPTIONS__Option   LV2_OPTIONS_PREFIX "Option"

§ LV2_OPTIONS__interface

#define LV2_OPTIONS__interface   LV2_OPTIONS_PREFIX "interface"

§ LV2_OPTIONS__options

#define LV2_OPTIONS__options   LV2_OPTIONS_PREFIX "options"

§ LV2_OPTIONS__requiredOption

#define LV2_OPTIONS__requiredOption   LV2_OPTIONS_PREFIX "requiredOption"

§ LV2_OPTIONS__supportedOption

#define LV2_OPTIONS__supportedOption   LV2_OPTIONS_PREFIX "supportedOption"

Enumeration Type Documentation

§ LV2_Options_Context

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.

§ LV2_Options_Status

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.