[−][src]Enum songbird::events::Event
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)
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.
Cancels the event, if it was intended to persist.
Trait Implementations
impl Clone for Event
[src]
impl Copy for Event
[src]
impl Debug for Event
[src]
impl Eq for Event
[src]
impl From<CoreEvent> for Event
[src]
impl From<TrackEvent> for Event
[src]
pub fn from(evt: TrackEvent) -> Self
[src]
impl Hash for Event
[src]
pub fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl PartialEq<Event> for Event
[src]
impl StructuralEq for Event
[src]
impl StructuralPartialEq for Event
[src]
Auto Trait Implementations
impl RefUnwindSafe for Event
[src]
impl Send for Event
[src]
impl Sync for Event
[src]
impl Unpin for Event
[src]
impl UnwindSafe for Event
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,
pub fn vzip(self) -> V
impl<T> WithSubscriber for T
[src]
pub fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
[src]
S: Into<Dispatch>,