Enum Instruction 

pub enum Instruction {
    PlayNote {
        midi_note: MidiNote,
        len: u32,
        channel_id: u8,
    },
    StartNote {
        midi_note: MidiNote,
        channel_id: u8,
    },
    StopNote {
        midi_note: MidiNote,
        channel_id: u8,
    },
    SendCC {
        channel_id: u8,
        parameter: u8,
        value: u8,
    },
    StopAllNotes,
    MidiMessage {
        midi_message: MidiMessage,
    },
    Continue,
    Start,
    Stop,
}

Represents instructions that can be interpreted and processed by the MidiController.

These instructions are used to generate and send MIDI messages.

Variants

PlayNote

Plays a note for a specified duration on a given MIDI channel.

Fields

midi_note: MidiNote

The MIDI note to play.

len: u32

Duration of the note in MIDI clock ticks (1 tick = 1/24 of a quarter note at the current BPM).

channel_id: u8

The MIDI channel to send the message on (1–16).

StartNote

Starts playing a MIDI note without specifying a duration.

Requires a corresponding Instruction::StopNote to stop the note.

Fields

midi_note: MidiNote

The MIDI note to start.

channel_id: u8

MIDI channel (1–16) to use.

StopNote

Stops a previously started MIDI note.

Fields

midi_note: MidiNote

The MIDI note to stop.

channel_id: u8

MIDI channel (1–16) used when the note was started.

SendCC

Sends a MIDI Control Change (CC) message.

Fields

channel_id: u8

MIDI channel (1–16).

parameter: u8

The controller number (0–127).

value: u8

The controller value (0–127).

StopAllNotes

Stops all currently playing notes.

MidiMessage

Sends a raw MIDI message directly.

Fields

midi_message: MidiMessage

The raw MIDI message to send.

Continue

Sends a MIDI Continue message to resume playback.

This instruction is not intended to be called manually. Prefer calling crate::Context::resume instead.

Start

Sends a MIDI Start message to begin playback from the start.

This instruction is not intended to be called manually. Prefer calling crate::Context::start instead.

Stop

Sends a MIDI Stop message to halt playback.

This instruction is not intended to be called manually. Prefer calling crate::Context::pause instead.

Implementations

impl Instruction

pub fn transpose(&mut self, semitones: i8)

Transposes the note in the instruction by the given number of semitones.

This function is only applicable when the Instruction variant is Instruction::PlayNote, Instruction::StartNote, or Instruction::StopNote.

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl PartialEq for Instruction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Instruction

impl StructuralPartialEq for Instruction