Enum MidiEventKind 

#[non_exhaustive]
pub enum MidiEventKind {
    NoteOn {
        channel: u8,
        key: u8,
        velocity: u8,
    },
    NoteOff {
        channel: u8,
        key: u8,
    },
    ControlChange {
        channel: u8,
        controller: u8,
        value: u8,
    },
    ProgramChange {
        channel: u8,
        program: u8,
    },
    PitchBend {
        channel: u8,
        value: i16,
    },
}

A MIDI message the synthesizer acts on.

These are the five commands it implements; anything else a file may carry (aftertouch, channel pressure, system messages) is not part of making a sound and has no variant here.

The channel is always the low nibble of the status byte, so 0 is the first channel.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

NoteOn

Press a key. velocity is 1 to 127; zero releases the key instead.

Fields

channel: u8

The channel the note plays on.

key: u8

The key, 0 to 127, where 60 is middle C.

velocity: u8

How hard the key was struck, 0 to 127.

NoteOff

Release a key.

Fields

channel: u8

The channel the note plays on.

key: u8

The key, 0 to 127.

ControlChange

Set a controller, such as the volume (7), the expression (11) or the sustain pedal (64).

Fields

channel: u8

The channel the controller belongs to.

controller: u8

The controller number, 0 to 127.

value: u8

The controller value, 0 to 127.

ProgramChange

Switch the channel to another instrument of the soundfont.

Fields

channel: u8

The channel that changes instrument.

program: u8

The General MIDI program number, zero-based.

PitchBend

Bend the channel’s pitch, from -8192 (fully down) through 0 (no bend) to 8191 (fully up).

Fields

channel: u8

The channel that bends.

value: i16

The bend, clamped to -8192..=8191.

Implementations

impl MidiEventKind

pub fn into_message(self) -> MidiMessage

The message this kind stands for.

pub fn from_message(message: MidiMessage) -> Option<Self>

The kind a message stands for, or None for a message the synthesizer does not act on.

A note-on with velocity zero stays a note-on: the synthesizer releases the key itself, and rewriting the message would make the two spellings of one release indistinguishable.

Trait Implementations

impl Clone for MidiEventKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MidiEventKind

impl Debug for MidiEventKind

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

Formats the value using the given formatter.

impl Eq for MidiEventKind

impl Hash for MidiEventKind

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for MidiEventKind

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MidiEventKind