Skip to main content

ClapEvent

Enum ClapEvent 

Source
pub enum ClapEvent {
    MidiShort {
        time: u32,
        bytes: [u8; 3],
        len: u8,
    },
    NoteOn {
        time: u32,
        channel: u8,
        key: u8,
        velocity: f32,
    },
    NoteOff {
        time: u32,
        channel: u8,
        key: u8,
        velocity: f32,
    },
    ParamValue {
        time: u32,
        clap_param_id: u32,
        value: f64,
    },
}
Expand description

A CLAP input event, mirroring the CLAP event union SIM accepts from a host.

Each variant carries a sample-relative time offset and maps to a matching BlockEvent via ClapEvent::to_block_event.

Variants§

§

MidiShort

A short (up to 3-byte) raw MIDI message.

Fields

§time: u32

Sample offset of the event within the block.

§bytes: [u8; 3]

Raw MIDI bytes; only the first len are significant.

§len: u8

Number of valid bytes in bytes.

§

NoteOn

A note-on event.

Fields

§time: u32

Sample offset of the event within the block.

§channel: u8

MIDI channel (0-based).

§key: u8

Note key number.

§velocity: f32

Note velocity, normalized to 0.0 to 1.0.

§

NoteOff

A note-off event.

Fields

§time: u32

Sample offset of the event within the block.

§channel: u8

MIDI channel (0-based).

§key: u8

Note key number.

§velocity: f32

Release velocity, normalized to 0.0 to 1.0.

§

ParamValue

A parameter value change addressed by CLAP parameter id.

Fields

§time: u32

Sample offset of the event within the block.

§clap_param_id: u32

CLAP parameter id, translated through a ClapParamMap.

§value: f64

New parameter value.

Implementations§

Source§

impl ClapEvent

Source

pub fn to_block_event(&self, params: &ClapParamMap) -> BlockEvent<'_>

Translates this CLAP event into the audio-graph BlockEvent.

Note and MIDI events pass through unchanged; a ClapEvent::ParamValue has its CLAP parameter id resolved to a SIM parameter id through params.

Trait Implementations§

Source§

impl Clone for ClapEvent

Source§

fn clone(&self) -> ClapEvent

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 Debug for ClapEvent

Source§

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

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

impl PartialEq for ClapEvent

Source§

fn eq(&self, other: &ClapEvent) -> 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 ClapEvent

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.