Skip to main content

ClockSync

Struct ClockSync 

Source
pub struct ClockSync { /* private fields */ }
Expand description

A 24-PPQN clock that both emits pulses over time and estimates incoming BPM.

Generation: ClockSync::advance accumulates elapsed seconds and returns how many whole clock pulses should be transmitted. Consumption: ClockSync::on_pulse feeds pulse timestamps and returns the current smoothed BPM estimate once enough intervals are known.

Implementations§

Source§

impl ClockSync

Source

pub fn new(bpm: f64) -> Result<Self, AudioError>

Build a generator/estimator anchored at bpm. Errors on bad tempo.

Source

pub fn set_bpm(&mut self, bpm: f64) -> Result<(), AudioError>

Retune the generator’s tempo. Errors on bad tempo.

Source

pub fn advance(&mut self, delta_seconds: f64) -> Result<u32, AudioError>

Generation: advance by delta_seconds, returning the number of whole clock pulses to transmit in that slice. Errors if delta_seconds is negative or not finite.

Source

pub fn on_pulse(&mut self, timestamp_seconds: f64) -> Option<f64>

Consumption: feed the absolute timestamp (seconds) of a received clock pulse. Returns Some(bpm) once at least one interval is known, using the average of the recent-interval window; None on the first pulse.

Trait Implementations§

Source§

impl Clone for ClockSync

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ClockSync

Source§

impl Debug for ClockSync

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.