Skip to main content

LiveMidiSession

Struct LiveMidiSession 

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

Public handle for an active live MIDI stream.

The handle owns the bounded live ring used by host callbacks. Callback-side entry points enqueue into the ring only; evaluation code consumes the ring through the MidiSource and MidiSink accessors.

Implementations§

Source§

impl LiveMidiSession

Source

pub fn modeled(direction: LiveMidiDirection) -> Result<Self, LiveMidiError>

Creates a modeled session with the default MIDI tick resolution and ring capacity.

Source

pub fn with_ring( tpq: u32, capacity: usize, direction: LiveMidiDirection, ) -> Result<Self, LiveMidiError>

Creates a session backed by a bounded ring buffer.

Source

pub fn direction(&self) -> LiveMidiDirection

Returns the stream direction exposed by this session.

Source

pub fn source_mut(&mut self) -> &mut dyn MidiSource<Err = Infallible>

Returns the live source side.

Source

pub fn sink_mut(&mut self) -> Option<&mut dyn MidiSink<Err = Infallible>>

Returns the live sink side when the session supports output.

Source

pub fn enqueue_from_callback( &mut self, event: &MidiEvent, ) -> Result<(), Infallible>

Enqueues one event from a host callback into the bounded live ring.

Source

pub fn close(self) -> Result<(), LiveMidiError>

Closes the session.

Trait Implementations§

Source§

impl Debug for LiveMidiSession

Source§

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

Formats the value using the given formatter. 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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, 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.