Struct bevy::audio::prelude::AudioSourceBundle
source · pub struct AudioSourceBundle<Source = AudioSource>{
pub source: Handle<Source>,
pub settings: PlaybackSettings,
}
Expand description
Bundle for playing a sound.
Insert this bundle onto an entity to trigger a sound source to begin playing.
If the handle refers to an unavailable asset (such as if it has not finished loading yet), the audio will not begin playing immediately. The audio will play when the asset is ready.
When Bevy begins the audio playback, an AudioSink
component will be
added to the entity. You can use that component to control the audio settings during playback.
Fields§
§source: Handle<Source>
Asset containing the audio data to play.
settings: PlaybackSettings
Initial settings that the audio starts playing with.
If you would like to control the audio while it is playing,
query for the AudioSink
component.
Changes to this component will not be applied to already-playing audio.
Trait Implementations§
source§impl<T> Default for AudioSourceBundle<T>
impl<T> Default for AudioSourceBundle<T>
source§fn default() -> AudioSourceBundle<T>
fn default() -> AudioSourceBundle<T>
Returns the “default value” for a type. Read more
impl<Source> Bundle for AudioSourceBundle<Source>
impl<Source> DynamicBundle for AudioSourceBundle<Source>
Auto Trait Implementations§
impl<Source = AudioSource> !RefUnwindSafe for AudioSourceBundle<Source>
impl<Source> Send for AudioSourceBundle<Source>
impl<Source> Sync for AudioSourceBundle<Source>
impl<Source> Unpin for AudioSourceBundle<Source>
impl<Source = AudioSource> !UnwindSafe for AudioSourceBundle<Source>
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn 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
.source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&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)
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.source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates
Self
using data from the given World
.