Enum EventDelay

pub enum EventDelay {
    DelayUntilSeconds(ClockSeconds),
    DelayUntilSamples(ClockSamples),
    DelayUntilMusical(MusicalTime),
}

When a particular audio event should occur.

Variants

DelayUntilSeconds(ClockSeconds)

The event should happen when the clock reaches the given time in seconds.

Note, this clock is not perfectly accurate, but it does correctly account for any output underflows that may occur.

The value is an absolute time, NOT a delta time. Use the context’s clock_now method to get the current time of the clock.

DelayUntilSamples(ClockSamples)

The event should happen when the clock reaches the given time in samples (of a single channel of audio).

This is more accurate than DelayUntilSeconds, but it does not account for any output underflows that may occur. This clock is ideal for syncing events to a custom musical transport.

The value is an absolute time, NOT a delta time. Use the context’s clock_samples to get the current time of the clock.

DelayUntilMusical(MusicalTime)

The event should happen when the musical clock reaches the given musical time.

Like DelayUntilSamples, this is very accurate, but note it also does not account for any output underflows that may occur.

Implementations

impl EventDelay

pub fn elapsed_or_get(&self, proc_info: &ProcInfo<'_>) -> Option<Self>

pub fn elapsed_on_frame( &self, proc_info: &ProcInfo<'_>, sample_rate: u32, ) -> Option<usize>

Trait Implementations

impl Clone for EventDelay

fn clone(&self) -> EventDelay

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventDelay

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

Formats the value using the given formatter.

impl PartialEq for EventDelay

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

impl StructuralPartialEq for EventDelay