Struct MidiEvent 

pub struct MidiEvent {
    pub channel: u4,
    pub message: MidiMessage,
}

Represents a MIDI message. An instance of this type can sometimes be converted from a TrackEventKind with the TryFrom trait. This type can be fed to a synthesizer.

Examples

// An instance of this type can be sent to a synthesizer like this.
let msg: MidiEvent = /* ... */;
let mut buf = Vec::new();
msg.write(&mut buf)?;
// Now `buf` contains a valid MIDI message, send it to a MIDI api like `midir::MidiOutputConnection`.

Fields

channel: u4

The channel this event is to be sent to.

message: MidiMessage

The message body.

Implementations

impl MidiEvent

pub fn transposed(self, shift: i8, transpose_ch9: bool) -> Option<Self>

Transposes self shift amount of half-steps. Only MIDI events with keys are transposed, others are left as is.

Notes

Normally MIDI channel 10 (index 9) is reserved for drums and MIDI keys on that channel mean not pitch but instrument/timber. So transposing them is often not desirable. If you still want to transpose the channel 9, set transpose_ch9 to true.

Return Value

This function is lossy: MIDI notes can’t exceed 127 or go below 0 so when that happens, this function returns None, otherwise it returns the transposed event.

impl MidiEvent

pub fn write<W: Write>(&self, w: &mut W) -> Result<()>

Writes a valid MIDI message to the given io::Write.

Trait Implementations

impl Clone for MidiEvent

fn clone(&self) -> MidiEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MidiEvent

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

Formats the value using the given formatter.

impl Hash for MidiEvent

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 MidiEvent

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

impl Eq for MidiEvent

impl StructuralPartialEq for MidiEvent