Trait vst::host::Host

pub trait Host {
    fn automate(&self, index: i32, value: f32) { ... }
    fn begin_edit(&self, index: i32) { ... }
    fn end_edit(&self, index: i32) { ... }
    fn get_plugin_id(&self) -> i32 { ... }
    fn idle(&self) { ... }
    fn get_info(&self) -> (isize, String, String) { ... }
    fn process_events(&self, events: &Events) { ... }
    fn get_time_info(&self, mask: i32) -> Option<TimeInfo> { ... }
    fn get_block_size(&self) -> isize { ... }
    fn update_display(&self) { ... }
}

Implemented by all VST hosts.

Provided Methods

fn automate(&self, index: i32, value: f32)

Automate a parameter; the value has been changed.

fn begin_edit(&self, index: i32)

Signal that automation of a parameter started (the knob has been touched / mouse button down).

fn end_edit(&self, index: i32)

Signal that automation of a parameter ended (the knob is no longer been touched / mouse button up).

fn get_plugin_id(&self) -> i32

Get the plugin ID of the currently loading plugin.

This is only useful for shell plugins where this value will change the plugin returned. TODO: implement shell plugins

fn idle(&self)

An idle call.

This is useful when the plugin is doing something such as mouse tracking in the UI.

fn get_info(&self) -> (isize, String, String)

Get vendor and product information.

Returns a tuple in the form of (version, vendor_name, product_name).

fn process_events(&self, events: &Events)

Handle incoming events from the plugin.

fn get_time_info(&self, mask: i32) -> Option<TimeInfo>

Get time information.

fn get_block_size(&self) -> isize

Get block size.

fn update_display(&self)

Refresh UI after the plugin’s parameters changed.

Note: some hosts will call some PluginParameters methods from within the update_display call, including get_parameter, get_parameter_label, get_parameter_name and get_parameter_text.

Implementors

impl Host for HostCallback