Struct bevy_retrograde::audio::kira::sound::handle::SoundHandle [−]
pub struct SoundHandle { /* fields omitted */ }
Expand description
Allows you to control a sound.
Implementations
impl SoundHandle
impl SoundHandle
pub fn default_track(&self) -> TrackIndex
pub fn default_track(&self) -> TrackIndex
Returns the default track instances of this sound will play on.
pub fn semantic_duration(&self) -> Option<f64>
pub fn semantic_duration(&self) -> Option<f64>
Returns the “musical length” of the sound (if there is one).
pub fn default_loop_start(&self) -> Option<f64>
pub fn default_loop_start(&self) -> Option<f64>
Returns the default time (in seconds) instances of this sound will loop back to when they reach the end.
pub fn play(
&mut self,
settings: InstanceSettings
) -> Result<InstanceHandle, CommandError>
pub fn play(
&mut self,
settings: InstanceSettings
) -> Result<InstanceHandle, CommandError>
Plays the sound.
pub fn pause(
&mut self,
settings: PauseInstanceSettings
) -> Result<(), CommandError>
pub fn pause(
&mut self,
settings: PauseInstanceSettings
) -> Result<(), CommandError>
Pauses all instances of this sound.
pub fn resume(
&mut self,
settings: ResumeInstanceSettings
) -> Result<(), CommandError>
pub fn resume(
&mut self,
settings: ResumeInstanceSettings
) -> Result<(), CommandError>
Resumes all instances of this sound.
pub fn stop(
&mut self,
settings: StopInstanceSettings
) -> Result<(), CommandError>
pub fn stop(
&mut self,
settings: StopInstanceSettings
) -> Result<(), CommandError>
Stops all instances of this sound.
Trait Implementations
impl Clone for SoundHandle
impl Clone for SoundHandle
pub fn clone(&self) -> SoundHandle
pub fn clone(&self) -> SoundHandle
Returns a copy of the value. Read more
Performs copy-assignment from source
. Read more
impl Debug for SoundHandle
impl Debug for SoundHandle
impl<'_> From<&'_ SoundHandle> for SoundId
impl<'_> From<&'_ SoundHandle> for SoundId
pub fn from(handle: &SoundHandle) -> SoundId
pub fn from(handle: &SoundHandle) -> SoundId
Performs the conversion.
impl<'_> From<&'_ SoundHandle> for PlayableId
impl<'_> From<&'_ SoundHandle> for PlayableId
pub fn from(handle: &SoundHandle) -> PlayableId
pub fn from(handle: &SoundHandle) -> PlayableId
Performs the conversion.
Auto Trait Implementations
impl RefUnwindSafe for SoundHandle
impl Send for SoundHandle
impl Sync for SoundHandle
impl Unpin for SoundHandle
impl UnwindSafe for SoundHandle
Blanket Implementations
Mutably borrows from an owned value. Read more
impl<T> Downcast for T where
T: Any,
impl<T> Downcast for T where
T: Any,
Convert Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
. Read more
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
Convert Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
. Read more
Convert &Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s. Read more
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert &mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s. Read more
Instruments this type with the provided Span
, returning an
Instrumented
wrapper. Read more
pub fn clone_type_data(&self) -> Box<dyn TypeData + 'static, Global>
pub fn vzip(self) -> V