EventInstant

Enum EventInstant 

Source
pub enum EventInstant {
    Seconds(InstantSeconds),
    Samples(InstantSamples),
    Musical(InstantMusical),
}
Expand description

When a particular audio event should occur, in units of absolute audio clock time.

Variants§

§

Seconds(InstantSeconds)

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

The value is an absolute time, NOT a delta time. Use FirewheelCtx::audio_clock to get the current time of the clock.

§

Samples(InstantSamples)

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

The value is an absolute time, NOT a delta time. Use FirewheelCtx::audio_clock to get the current time of the clock.

§

Musical(InstantMusical)

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

Implementations§

Source§

impl EventInstant

Source

pub fn is_musical(&self) -> bool

Source

pub fn to_samples(&self, proc_info: &ProcInfo) -> Option<InstantSamples>

Convert the instant to the given time in samples.

If this instant is of type EventInstant::Musical and either there is no musical transport or the musical transport is not currently playing, then this will return None.

Trait Implementations§

Source§

impl Clone for EventInstant

Source§

fn clone(&self) -> EventInstant

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for EventInstant

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Diff for EventInstant

Source§

fn diff<E: EventQueue>( &self, baseline: &Self, path: PathBuilder, event_queue: &mut E, )

Compare self to baseline and generate events to resolve any differences.
Source§

impl From<EventInstant> for ParamData

Source§

fn from(value: EventInstant) -> Self

Converts to this type from the input type.
Source§

impl From<InstantMusical> for EventInstant

Source§

fn from(value: InstantMusical) -> Self

Converts to this type from the input type.
Source§

impl From<InstantSamples> for EventInstant

Source§

fn from(value: InstantSamples) -> Self

Converts to this type from the input type.
Source§

impl From<InstantSeconds> for EventInstant

Source§

fn from(value: InstantSeconds) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for EventInstant

Source§

fn eq(&self, other: &EventInstant) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Patch for EventInstant

Source§

type Patch = EventInstant

A type’s patch. Read more
Source§

fn patch(data: &ParamData, _path: &[u32]) -> Result<Self::Patch, PatchError>

Construct a patch from a parameter event. Read more
Source§

fn apply(&mut self, patch: Self::Patch)

Apply a patch. Read more
Source§

fn patch_event(event: &NodeEventType) -> Option<Self::Patch>

Construct a patch from a node event. Read more
Source§

impl TryInto<EventInstant> for &ParamData

Source§

type Error = PatchError

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

fn try_into(self) -> Result<EventInstant, PatchError>

Performs the conversion.
Source§

impl Copy for EventInstant

Source§

impl StructuralPartialEq for EventInstant

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> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Converts Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Converts Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Converts &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Converts &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSend for T
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<ConcreteType> where ConcreteType implements Trait.
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<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<T> TypeData for T
where T: 'static + Send + Sync + Clone,

Source§

impl<T> ConditionalSend for T
where T: Send,