Enum HostCommand 

pub enum HostCommand {
    LoadPlugin {
        path: String,
        sample_rate: f64,
        block_size: u32,
        tempo: f64,
        time_sig_numerator: i32,
        time_sig_denominator: i32,
    },
    UnloadPlugin,
    CreateGui,
    CloseGui,
    StartProcessing,
    StopProcessing,
    SetParameter {
        id: u32,
        value: f64,
    },
    SetParameterAt {
        id: u32,
        value: f64,
        offset: i32,
    },
    GetParameter {
        id: u32,
    },
    GetAllParameters,
    FormatParameter {
        id: u32,
        normalized: f64,
    },
    SendMidi {
        event: MidiEvent,
    },
    Process {
        inputs: Vec<Vec<f32>>,
        frames: u32,
    },
    SaveState,
    LoadState {
        data: Vec<u8>,
    },
    NoteOn {
        channel: u8,
        note: u8,
        velocity: u8,
        sample_offset: i32,
    },
    NoteOff {
        note_id: i32,
        sample_offset: i32,
    },
    SendNoteExpression {
        note_id: i32,
        kind: NoteExpressionType,
        value: f64,
        sample_offset: i32,
    },
    NoteExpressions {
        bus: i32,
        channel: i16,
    },
    Shutdown,
}

Commands that can be sent to the isolated plugin process.

This enum is the single source of truth for the isolation IPC protocol — the helper binary imports it from here rather than redefining it, so the two halves can never drift apart.

Variants

LoadPlugin

Load a plugin from the specified path, configured for the given audio settings.

Fields

path: String

Path to the .vst3 bundle.

sample_rate: f64

Sample rate to configure the plugin for.

block_size: u32

Block size to configure the plugin for.

tempo: f64

Transport tempo (BPM) to advertise in the plugin’s host ProcessContext.

time_sig_numerator: i32

Time signature numerator to advertise in the host ProcessContext.

time_sig_denominator: i32

Time signature denominator to advertise in the host ProcessContext.

UnloadPlugin

Unload the current plugin

CreateGui

Create plugin GUI

CloseGui

Close plugin GUI

StartProcessing

Start the plugin’s audio processing.

StopProcessing

Stop the plugin’s audio processing.

SetParameter

Set a parameter (normalized 0.0..=1.0).

Fields

id: u32

Parameter id.

value: f64

Normalized value.

SetParameterAt

Schedule a parameter change at a sample offset within the next process block.

Fields

id: u32

Parameter id.

value: f64

Normalized value.

offset: i32

Sample offset within the next processed block.

GetParameter

Read a parameter’s current normalized value.

Fields

id: u32

Parameter id.

GetAllParameters

Read all parameters.

FormatParameter

Ask the plugin to format a normalized value as a display string.

Fields

id: u32

Parameter id.

normalized: f64

Normalized value to format.

SendMidi

Send a MIDI event to the plugin.

Fields

event: MidiEvent

The event to deliver.

Process

Process one block of audio. inputs is per-channel; frames is the block length.

Fields

inputs: Vec<Vec<f32>>

Per-channel input samples ([channel][frame]).

frames: u32

Number of frames in this block.

SaveState

Serialize the plugin’s current state to an opaque byte blob.

LoadState

Restore the plugin’s state from a blob previously returned by SaveState.

Fields

data: Vec<u8>

The opaque state bytes.

NoteOn

Start a note (MPE). The helper’s plugin allocates the per-voice note id and returns it in HostResponse::NoteStarted (in isolation the helper owns the real plugin).

Fields

channel: u8

MIDI channel, 0-based index (MidiChannel::as_index).

note: u8

Note number (0-127).

velocity: u8

Velocity (0-127).

sample_offset: i32

Sample offset within the next processed block.

NoteOff

Release a note previously started with HostCommand::NoteOn.

Fields

note_id: i32

Raw note id returned by NoteOn.

sample_offset: i32

Sample offset within the next processed block.

SendNoteExpression

Send a per-note expression value (normalized 0..1) for a voice. The expression dimension crosses the boundary as the serializable NoteExpressionType enum.

Fields

note_id: i32

Raw note id returned by NoteOn.

kind: NoteExpressionType

Which note-expression dimension to set.

value: f64

Normalized expression value (0..1).

sample_offset: i32

Sample offset within the next processed block.

NoteExpressions

Enumerate the per-note expressions the plugin advertises (INoteExpressionController).

Fields

bus: i32

Event bus index.

channel: i16

Channel index.

Shutdown

Shutdown the helper process

Trait Implementations

impl Clone for HostCommand

fn clone(&self) -> HostCommand

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for HostCommand

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HostCommand

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HostCommand

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.