Struct BeatGrid 

pub struct BeatGrid {
    pub bpm: f64,
    pub phase_offset_ms: f64,
}

A regular beat grid defined by a tempo.

Fields

bpm: f64

Tempo in beats per minute.

phase_offset_ms: f64

Phase offset of the first beat in milliseconds from the stream start.

Implementations

impl BeatGrid

pub fn new(bpm: f64) -> Self

Creates a new beat grid at the given BPM with zero phase offset.

pub fn with_phase(bpm: f64, phase_offset_ms: f64) -> Self

Creates a beat grid with an explicit phase offset.

pub fn interval_ms(&self) -> f64

Returns the interval between consecutive beats in milliseconds.

pub fn beat_time_ms(&self, beat_index: u32) -> f64

Returns the timestamp (ms from stream start) of the n-th beat (0-indexed).

pub fn nearest_beat(&self, time_ms: f64) -> u32

Returns the nearest beat index for a given timestamp (ms).

Trait Implementations

impl Clone for BeatGrid

fn clone(&self) -> BeatGrid

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BeatGrid

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

Formats the value using the given formatter.

impl PartialEq for BeatGrid

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

impl StructuralPartialEq for BeatGrid