Skip to main content

LiveAudioEvent

Enum LiveAudioEvent 

Source
pub enum LiveAudioEvent {
    Xrun {
        frames: u32,
        max_frames: u32,
    },
    DroppedControlEvents {
        count: u64,
    },
    DroppedAudioEvents {
        count: u64,
    },
    ProcessorParamSet {
        offset: u32,
        param: u32,
        value: f64,
    },
    ProcessorMidi {
        offset: u32,
        bytes: [u8; 3],
        len: u8,
    },
}
Expand description

Owned audio event moved from the audio callback to the control thread.

Variants§

§

Xrun

An audio callback received more frames than the prepared maximum.

Fields

§frames: u32

Frames delivered to the callback.

§max_frames: u32

Maximum prepared block size.

§

DroppedControlEvents

Control-to-audio queue dropped events under backpressure.

Fields

§count: u64

Number of dropped events.

§

DroppedAudioEvents

Audio-to-control queue dropped events under backpressure.

Fields

§count: u64

Number of dropped events.

§

ProcessorParamSet

A processor emitted a parameter-set event.

Fields

§offset: u32

Sample offset into the block.

§param: u32

Parameter index.

§value: f64

New parameter value.

§

ProcessorMidi

A processor emitted a short MIDI message.

Fields

§offset: u32

Sample offset into the block.

§bytes: [u8; 3]

Message bytes (only the first len are valid).

§len: u8

Number of valid bytes in bytes.

Implementations§

Source§

impl LiveAudioEvent

Source

pub fn from_processor_event(event: BlockEvent<'_>) -> Option<Self>

Captures a processor-emitted BlockEvent as a live audio event.

Returns None for events that are not carried back to the control thread (long MIDI, note-on, and note-off).

Source

pub fn to_diagnostic_packet(self) -> StreamPacket

Renders the event as a stream diagnostic packet for the control thread.

Trait Implementations§

Source§

impl Clone for LiveAudioEvent

Source§

fn clone(&self) -> LiveAudioEvent

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
Source§

impl Copy for LiveAudioEvent

Source§

impl Debug for LiveAudioEvent

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PartialEq for LiveAudioEvent

Source§

fn eq(&self, other: &LiveAudioEvent) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for LiveAudioEvent

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