Struct MusicTimeCounter

pub struct MusicTimeCounter { /* private fields */ }

Data structure that handles advancing music time within a time signature.

Implementations

impl MusicTimeCounter

pub fn new(time_signature: TimeSignature) -> Self

Create a new MusicTimeCounter with a TimeSignature.

Arguments

• time_signature - The TimeSignature the MusicTimeCounter is constrained by.

Example

use music_timer::{time_signature::TimeSignature, music_time_counter::MusicTimeCounter};
let timer = MusicTimeCounter::new(TimeSignature::new(3, 4));

pub fn current_time(&self) -> &MusicTime

Gets the current time of the counter.

pub fn advance_beat(&mut self)

Advance this counter by 1 beat.

pub fn advance_beat_interval(&mut self)

Advance this counter by 1 beat interval.

pub fn beat_target_frames(&self, bpm: f32) -> Duration

Gets the time duration between beats.

Arguments

• bpm - Beats per minute

pub fn beat_interval_target_frames(&self, bpm: f32) -> Duration

Gets the time duration between beat intervals.

Arguments

• bpm - Beats per minute.

pub fn set_current_time(&mut self, current_time: MusicTime) -> &mut Self

Set the current music time of the counter.

Arguments

• current_time - The new current time to set counter to.

Trait Implementations

impl Debug for MusicTimeCounter

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

Formats the value using the given formatter.

impl Default for MusicTimeCounter

fn default() -> Self

Default MusicTimeCounter is created with a default TimeSignature.