Skip to main content

OutputMidiConsumer

Struct OutputMidiConsumer 

Source
pub struct OutputMidiConsumer { /* private fields */ }
Expand description

A Send + Sync handle for draining the MIDI a plugin emits (arpeggiators, MPE, MIDI thru, …) without locking the audio thread.

Obtain one from Plugin::output_midi_handle. The plugin’s audio thread pushes emitted events into a lock-free bounded queue; this handle pops them from any other thread (e.g. a UI poll loop) with no lock on either side — the lock-free counterpart to the audio-thread drain in Plugin::take_output_midi. When the queue is full the oldest event is dropped, so a host that stops polling can’t grow it without bound.

Available for in-process plugins; the process-isolation path returns None (output MIDI crosses the boundary in the IPC responses instead).

Implementations§

Source§

impl OutputMidiConsumer

Source

pub fn pop(&self) -> Option<MidiEvent>

Pop the oldest emitted event, or None if none are queued. Lock-free.

Source

pub fn drain(&self) -> Vec<MidiEvent>

Drain all currently queued events in emission order into a Vec. Lock-free pops; the returned Vec allocates on the calling thread (intended for a UI/control thread, not the audio thread — use pop in a loop to stay allocation-free).

Trait Implementations§

Source§

impl Clone for OutputMidiConsumer

Source§

fn clone(&self) -> OutputMidiConsumer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.