Struct Note 

pub struct Note { /* private fields */ }

One note: onset, offset, pitch, and the fields later steps fill.

Implementations

impl Note

pub fn new( onset: Seconds, offset: Seconds, pitch: MidiPitch, ) -> Result<Self, NoteError>

Builds a note with every optional field unset.

Errors

Returns a NoteError when the offset is not after the onset.

pub fn with_contour(self, contour: Contour) -> Self

Sets the f0 contour.

pub fn with_octave_uncertain(self, flag: bool) -> Self

Sets whether the pitch may be an octave off.

pub fn with_velocity(self, velocity: Velocity) -> Self

Sets the velocity.

pub fn with_overlap(self, flag: bool) -> Self

Sets whether the note overlaps another.

pub fn onset(&self) -> Seconds

Returns the onset.

pub fn offset(&self) -> Seconds

Returns the offset.

pub fn pitch(&self) -> MidiPitch

Returns the pitch.

pub fn contour(&self) -> Option<&Contour>

Returns the f0 contour, if a pitch track filled it.

pub fn octave_uncertain(&self) -> Option<bool>

Returns the octave flag, if set.

pub fn velocity(&self) -> Option<Velocity>

Returns the velocity, if set.

pub fn overlap(&self) -> Option<bool>

Returns the overlap flag, if set.

pub fn sounds_at(&self, time: Seconds) -> bool

Returns whether the note sounds at a time: onset inclusive, offset exclusive.

pub fn f0_at(&self, time: Seconds) -> Hz

Returns the fundamental at a time: the contour when set, else the pitch as a constant.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl PartialEq for Note

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Note