Struct Track

pub struct Track { /* private fields */ }

2.3 - Track Chunks The track chunks (type MTrk) are where actual song data is stored. Each track chunk is simply a stream of MIDI events (and non-MIDI events), preceded by delta-time values. The format for Track Chunks (described below) is exactly the same for all three formats (0, 1, and 2: see “Header Chunk” above) of MIDI Files.

Here is the syntax of an MTrk chunk (the + means “one or more”: at least one MTrk event must be present):

<Track Chunk> = <chunk type><length><MTrk event>+

Implementations

impl Track

pub fn is_empty(&self) -> bool

Returns true if the track has no events.

pub fn events_len(&self) -> usize

The number of events in the track.

pub fn events(&self) -> impl Iterator<Item = &TrackEvent>

Iterator over the events in the track.

pub fn push_event(&mut self, delta_time: u32, event: Event) -> Result<()>

Add an event to the end.

pub fn insert_event( &mut self, index: u32, delta_time: u32, event: Event, ) -> Result<()>

Add event at index and shift everything after it.

pub fn replace_event( &mut self, index: u32, delta_time: u32, event: Event, ) -> Result<()>

Replace the event at index.

pub fn set_name<S: Into<String>>(&mut self, name: S) -> Result<()>

Add, or replace, the track name at the beginning of a track.

pub fn set_instrument_name<S: Into<String>>(&mut self, name: S) -> Result<()>

Add, or replace, the instrument name at the beginning of a track.

pub fn set_general_midi( &mut self, channel: Channel, value: GeneralMidi, ) -> Result<()>

Add, or replace, the general midi program at the beginning of a track.

pub fn push_time_signature( &mut self, delta_time: u32, numerator: u8, denominator: DurationName, click: Clocks, ) -> Result<()>

Add a time signature.

pub fn push_tempo( &mut self, delta_time: u32, quarters_per_minute: QuartersPerMinute, ) -> Result<()>

Add a tempo message.

pub fn push_note_on( &mut self, delta_time: u32, channel: Channel, note_number: NoteNumber, velocity: Velocity, ) -> Result<()>

Add a note on message.

pub fn push_note_off( &mut self, delta_time: u32, channel: Channel, note_number: NoteNumber, velocity: Velocity, ) -> Result<()>

Add a note off message.

pub fn push_lyric<S: Into<String>>( &mut self, delta_time: u32, lyric: S, ) -> Result<()>

Add a lyric.

pub fn push_pitch_bend( &mut self, delta_time: u32, channel: Channel, pitch_bend: PitchBendValue, ) -> Result<()>

Add a pitch bend value.

Trait Implementations

impl Clone for Track

fn clone(&self) -> Track

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Track

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

Formats the value using the given formatter.

impl Default for Track

fn default() -> Track

Returns the “default value” for a type.

impl Hash for Track

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 Ord for Track

fn cmp(&self, other: &Track) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Track

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

fn partial_cmp(&self, other: &Track) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Track

impl StructuralPartialEq for Track