LMMS
Loading...
Searching...
No Matches
plugin_proxy_base Struct Reference

Common data and functions for GTK+ GUI and External GUI. More...

Inheritance diagram for plugin_proxy_base:
lv2_plugin_proxy

Public Member Functions

 plugin_proxy_base (const plugin_metadata_iface *metadata, LV2UI_Write_Function wf, LV2UI_Controller c, const LV2_Feature *const *features)
void send_float_to_host (int param_no, float value)
 Send a float value to a control port in the host.
char * configure (const char *key, const char *value)
 Send a string value to a string port in the host, by name (configure-like mechanism).
void send_configures (send_configure_iface *sci)
 Obtain the list of variables from the plugin.
void enable_all_sends ()
 Enable sending to host for all ports.
void resolve_instance ()
 Obtain instance pointers.
const line_graph_ifaceget_line_graph_iface () const
 Obtain line graph interface if available.
const phase_graph_ifaceget_phase_graph_iface () const
 Obtain phase graph interface if available.
uint32_t map_urid (const char *uri)
 Map an URI to an integer value using a given URID map.

Public Attributes

const plugin_metadata_ifaceplugin_metadata
LV2UI_Write_Function write_function
LV2UI_Controller controller
LV2_Handle instance_handle
 Handle to the plugin instance.
LV2_Extension_Data_Featuredata_access
 Data access feature instance.
const LV2_URID_Mapurid_map
 URID map feature.
lv2_external_ui_hostext_ui_host
 External UI host feature (must be set when instantiating external UI plugins).
bool atom_present
uint32_t property_type
uint32_t string_type
uint32_t event_transfer
plugin_ctl_ifaceinstance
 Instance pointer - usually NULL unless the host supports instance-access extension.
vector< bool > sends
 If true, a given parameter (not port) may be sent to host - it is blocked when the parameter is written to by the host.
map< string, intparams_by_name
 Map of parameter name to parameter index (used for mapping configure values to string ports).
vector< float > params
 Values of parameters (float control ports).
int param_count
 Number of parameters (non-audio ports).
int param_offset
 Number of the first parameter port.
gulong widget_destroyed_signal
 Signal handler for main widget destroyed.
gulong window_destroyed_signal
 Signal handler for external window destroyed.

Detailed Description

Common data and functions for GTK+ GUI and External GUI.

Constructor & Destructor Documentation

◆ plugin_proxy_base()

plugin_proxy_base::plugin_proxy_base ( const plugin_metadata_iface * metadata,
LV2UI_Write_Function wf,
LV2UI_Controller c,
const LV2_Feature *const * features )

Block all updates until GUI is ready

Member Function Documentation

◆ configure()

char * plugin_proxy_base::configure ( const char * key,
const char * value )

Send a string value to a string port in the host, by name (configure-like mechanism).

◆ enable_all_sends()

void plugin_proxy_base::enable_all_sends ( )

Enable sending to host for all ports.

◆ get_line_graph_iface()

const line_graph_iface * plugin_proxy_base::get_line_graph_iface ( ) const

Obtain line graph interface if available.

◆ get_phase_graph_iface()

const phase_graph_iface * plugin_proxy_base::get_phase_graph_iface ( ) const

Obtain phase graph interface if available.

◆ map_urid()

uint32_t plugin_proxy_base::map_urid ( const char * uri)

Map an URI to an integer value using a given URID map.

◆ resolve_instance()

void plugin_proxy_base::resolve_instance ( )

Obtain instance pointers.

◆ send_configures()

void plugin_proxy_base::send_configures ( send_configure_iface * sci)

Obtain the list of variables from the plugin.

◆ send_float_to_host()

void plugin_proxy_base::send_float_to_host ( int param_no,
float value )

Send a float value to a control port in the host.

Member Data Documentation

◆ atom_present

bool plugin_proxy_base::atom_present

◆ controller

LV2UI_Controller plugin_proxy_base::controller

◆ data_access

LV2_Extension_Data_Feature* plugin_proxy_base::data_access

Data access feature instance.

◆ event_transfer

uint32_t plugin_proxy_base::event_transfer

◆ ext_ui_host

lv2_external_ui_host* plugin_proxy_base::ext_ui_host

External UI host feature (must be set when instantiating external UI plugins).

◆ instance

plugin_ctl_iface* plugin_proxy_base::instance

Instance pointer - usually NULL unless the host supports instance-access extension.

◆ instance_handle

LV2_Handle plugin_proxy_base::instance_handle

Handle to the plugin instance.

◆ param_count

int plugin_proxy_base::param_count

Number of parameters (non-audio ports).

◆ param_offset

int plugin_proxy_base::param_offset

Number of the first parameter port.

◆ params

vector<float> plugin_proxy_base::params

Values of parameters (float control ports).

◆ params_by_name

map<string, int> plugin_proxy_base::params_by_name

Map of parameter name to parameter index (used for mapping configure values to string ports).

◆ plugin_metadata

const plugin_metadata_iface* plugin_proxy_base::plugin_metadata

◆ property_type

uint32_t plugin_proxy_base::property_type

◆ sends

vector<bool> plugin_proxy_base::sends

If true, a given parameter (not port) may be sent to host - it is blocked when the parameter is written to by the host.

◆ string_type

uint32_t plugin_proxy_base::string_type

◆ urid_map

const LV2_URID_Map* plugin_proxy_base::urid_map

URID map feature.

◆ widget_destroyed_signal

gulong plugin_proxy_base::widget_destroyed_signal

Signal handler for main widget destroyed.

◆ window_destroyed_signal

gulong plugin_proxy_base::window_destroyed_signal

Signal handler for external window destroyed.

◆ write_function

LV2UI_Write_Function plugin_proxy_base::write_function

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