Struct vst::host::PluginInstance

pub struct PluginInstance { /* private fields */ }

An instance of an externally loaded VST plugin.

Trait Implementations

impl Drop for PluginInstance

fn drop(&mut self)

Executes the destructor for this type.

impl Plugin for PluginInstance

fn get_info(&self) -> Info

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

This method must return an Info struct.

fn new(_host: HostCallback) -> Self

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called during initialization to pass a HostCallback to the plugin.

fn init(&mut self)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called when plugin is fully initialized.

fn set_sample_rate(&mut self, rate: f32)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called when sample rate is changed by host.

fn set_block_size(&mut self, size: i64)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called when block size is changed by host.

fn resume(&mut self)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called to transition the plugin into the resumed state.

fn suspend(&mut self)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called to transition the plugin into the suspended state.

fn vendor_specific(
    &mut self,
    index: i32,
    value: isize,
    ptr: *mut c_void,
    opt: f32
) -> isize

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Vendor specific handling.

fn can_do(&self, can_do: CanDo) -> Supported

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Return whether plugin supports specified action.

fn get_tail_size(&self) -> isize

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Get the tail size of plugin when it is stopped. Used in offline processing as well.

fn process(&mut self, buffer: &mut AudioBuffer<'_, f32>)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Process an audio buffer containing f32 values.

fn process_f64(&mut self, buffer: &mut AudioBuffer<'_, f64>)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Process an audio buffer containing f64 values.

fn process_events(&mut self, events: &Events)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Handle incoming events sent from the host.

fn get_input_info(&self, input: i32) -> ChannelInfo

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Get information about an input channel. Only used by some hosts.

fn get_output_info(&self, output: i32) -> ChannelInfo

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Get information about an output channel. Only used by some hosts.

fn get_parameter_object(&mut self) -> Arc<dyn PluginParameters>

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Get a reference to the shared parameter object.

fn get_editor(&mut self) -> Option<Box<dyn Editor>>

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Return handle to plugin editor if supported. The method need only return the object on the first call. Subsequent calls can just return None.

fn start_process(&mut self)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called one time before the start of process call.

fn stop_process(&mut self)

👎Deprecated: This crate has been deprecated. See https://github.com/RustAudio/vst-rs for more information.

Called after the stop of process call.