Struct NoteDetectionResult 

pub struct NoteDetectionResult {
    pub actual_freq: f64,
    pub note_name: NoteName,
    pub note_freq: f64,
    pub octave: i32,
    pub cents_offset: f64,
    pub previous_note_name: NoteName,
    pub next_note_name: NoteName,
    pub in_tune: bool,
}

The resut of a pitch detection expressed as a note. You will rarely need to instantiate this struct directly. Most commonly this will be returned from detect_note.

Fields

actual_freq: f64

The predominant frequency detected from a signal.

note_name: NoteName

The note name of the detected note.

note_freq: f64

The expected frequency of the detected note.

octave: i32

The octave of the detected note.

cents_offset: f64

The degree to which the detected not is in tune, expressed in cents. The absolute maximum cents_offset is 50, since anything larger than 50 would be considered the next or previous note.

previous_note_name: NoteName

The note name of the note that comes before the detected note. Not commonly used.

next_note_name: NoteName

The note name of the note that comes after the detected note. Not commonly used.

in_tune: bool

A NoteDetectionResult will be marked as in_tune if the cents_offset is less than MAX_CENTS_OFFSET.

Trait Implementations

impl Clone for NoteDetectionResult

fn clone(&self) -> NoteDetectionResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NoteDetectionResult

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

Formats the value using the given formatter.

impl PartialEq for NoteDetectionResult

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

fn partial_cmp(&self, other: &NoteDetectionResult) -> 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 TryFrom<f64> for NoteDetectionResult

type Error = Error

The type returned in the event of a conversion error.

fn try_from(freq: f64) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for NoteDetectionResult