Enum songbird::events::Event

#[non_exhaustive]pub enum Event {
    Periodic(Duration, Option<Duration>),
    Delayed(Duration),
    Track(TrackEvent),
    Core(CoreEvent),
    Cancel,
}

Classes of event which may occur, triggering a handler at the local (track-specific) or global level.

Local time-based events rely upon the current playback time of a track, and so will not fire if a track becomes paused or stops. In case this is required, global events are a better fit.

Event handlers themselves are described in EventData::action.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Periodic(Duration, Option<Duration>)

Periodic events rely upon two parameters: a period and an optional phase.

If the phase is None, then the event will first fire in one period. Periodic events repeat automatically so long as the action in EventData returns None.

Delayed(Duration)

Delayed events rely upon a delay parameter, and fire one delay after the audio context processes them.

Delayed events are automatically removed once fired, so long as the action in EventData returns None.

Track(TrackEvent)

Track events correspond to certain actions or changes of state, such as a track finishing, looping, or being manually stopped.

Track events persist while the action in EventData returns None.

Core(CoreEvent)

Core events

Track events persist while the action in EventData returns None. Core events must be applied globally, as attaching them to a track is a no-op.

Cancel

Cancels the event, if it was intended to persist.

Trait Implementations

impl Clone for Event

fn clone(&self) -> Event

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Event

impl Debug for Event

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

Formats the value using the given formatter.

impl Eq for Event

impl From<CoreEvent> for Event

fn from(evt: CoreEvent) -> Self

Performs the conversion.

impl From<TrackEvent> for Event

fn from(evt: TrackEvent) -> Self

Performs the conversion.

impl Hash for Event

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Event> for Event

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralEq for Event

impl StructuralPartialEq for Event