Skip to main content

ControlEvent

Enum ControlEvent 

Source
pub enum ControlEvent {
    Button {
        id: u32,
        pressed: bool,
    },
    Knob {
        id: u32,
        value: f32,
        normalized: f32,
    },
    Fader {
        id: u32,
        value: f32,
        normalized: f32,
    },
    MidiControl {
        channel: u8,
        controller: u8,
        value: u8,
        normalized: f32,
    },
    MidiNote {
        channel: u8,
        note: u8,
        velocity: u8,
        on: bool,
    },
    Osc {
        address: String,
        args: Vec<f32>,
    },
}
Expand description

A controller event from hardware or protocol input.

Variants§

§

Button

Button press/release.

Fields

§id: u32

Button identifier.

§pressed: bool

Whether the button is pressed.

§

Knob

Rotary knob / encoder.

Fields

§id: u32

Knob identifier.

§value: f32

Raw value.

§normalized: f32

Normalised value (0.0–1.0).

§

Fader

Linear fader.

Fields

§id: u32

Fader identifier.

§value: f32

Raw value.

§normalized: f32

Normalised value (0.0–1.0).

§

MidiControl

MIDI Control Change.

Fields

§channel: u8

MIDI channel (0–15).

§controller: u8

Controller number (0–127).

§value: u8

Raw controller value (0–127).

§normalized: f32

Normalised value (0.0–1.0).

§

MidiNote

MIDI Note.

Fields

§channel: u8

MIDI channel (0–15).

§note: u8

Note number (0–127).

§velocity: u8

Velocity (0–127).

§on: bool

Whether the note is on (true) or off (false).

§

Osc

OSC message.

Fields

§address: String

OSC address pattern (e.g. /filter/cutoff).

§args: Vec<f32>

Message arguments.

Implementations§

Source§

impl ControlEvent

Source

pub fn normalized_value(&self) -> Option<f32>

Return the normalised value (0.0–1.0) if applicable.

Source

pub fn id(&self) -> Option<u32>

Return the controller element ID, if any.

Trait Implementations§

Source§

impl Clone for ControlEvent

Source§

fn clone(&self) -> ControlEvent

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ControlEvent

Source§

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

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

impl PartialEq for ControlEvent

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · 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 ControlEvent

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> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V