Struct PluginHost 

pub struct PluginHost { /* private fields */ }

One running host process with one plugin.

Implementations

impl PluginHost

pub fn spawn( format: PluginFormat, label: &str, path: &Path, watchdog: Duration, ) -> Result<PluginHost>

Start a host for format; label and path name the plugin in errors.

pub fn label(&self) -> &str

pub fn set_label(&mut self, label: &str)

pub fn request(&mut self, req: &Request) -> Result<Reply>

Send one request and wait (under the watchdog) for its reply.

pub fn probe(&mut self, path: &Path) -> Result<Vec<Descriptor>>

pub fn load(&mut self, plugin_id: Option<&str>) -> Result<PluginInfo>

pub fn set_params( &mut self, params: &[(String, String)], ) -> Result<Vec<ParamValue>>

pub fn get_params(&mut self) -> Result<Vec<ParamValue>>

pub fn load_preset(&mut self, preset: &str) -> Result<Vec<ParamValue>>

pub fn list_presets(&mut self) -> Result<Vec<PresetInfo>>

pub fn get_state(&mut self) -> Result<Vec<u8>>

pub fn set_state(&mut self, state: &[u8]) -> Result<()>

pub fn activate( &mut self, sample_rate: u32, block_size: u32, channels_in: u32, channels_out: u32, slots: u32, ) -> Result<Activated>

Create the shared-memory ring and activate the plugin.

pub fn run( &mut self, input: &[Vec<f32>], total: usize, events: &[(u64, Event)], progress: &mut dyn FnMut(f64) -> Result<()>, ) -> Result<Vec<Vec<f32>>>

Stream total frames through the plugin. input (planar, may be shorter than total — the rest is silence) must match the shared-memory input channel count. events are (absolute frame, event) pairs; their time fields are rewritten. progress is called after each block with the fraction done and may abort.

pub fn shutdown(self)

Ask the host to exit and reap it.

Trait Implementations

impl Drop for PluginHost

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.