Struct bevy_audio::AudioLoader
source · pub struct AudioLoader;
Expand description
Loads files as AudioSource
Assets
This asset loader supports different audio formats based on the enable Bevy features.
The feature bevy/vorbis
enables loading from .ogg
files and is enabled by default.
Other file endings can be loaded from with additional features:
.mp3
with bevy/mp3
.flac
with bevy/flac
.wav
with bevy/wav
Trait Implementations§
source§impl AssetLoader for AudioLoader
impl AssetLoader for AudioLoader
§type Asset = AudioSource
type Asset = AudioSource
The top level
Asset
loaded by this AssetLoader
.§type Settings = ()
type Settings = ()
The settings type used by this
AssetLoader
.source§async fn load<'a>(
&'a self,
reader: &'a mut Reader<'_>,
_settings: &'a Self::Settings,
_load_context: &'a mut LoadContext<'_>
) -> Result<AudioSource, Self::Error>
async fn load<'a>( &'a self, reader: &'a mut Reader<'_>, _settings: &'a Self::Settings, _load_context: &'a mut LoadContext<'_> ) -> Result<AudioSource, Self::Error>
Asynchronously loads
AssetLoader::Asset
(and any other labeled assets) from the bytes provided by Reader
.source§fn extensions(&self) -> &[&str]
fn extensions(&self) -> &[&str]
Returns a list of extensions supported by this
AssetLoader
, without the preceding dot.
Note that users of this AssetLoader
may choose to load files with a non-matching extension.source§impl Default for AudioLoader
impl Default for AudioLoader
source§fn default() -> AudioLoader
fn default() -> AudioLoader
Returns the “default value” for a type. Read more
Auto Trait Implementations§
impl Freeze for AudioLoader
impl RefUnwindSafe for AudioLoader
impl Send for AudioLoader
impl Sync for AudioLoader
impl Unpin for AudioLoader
impl UnwindSafe for AudioLoader
Blanket Implementations§
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<L> ErasedAssetLoader for L
impl<L> ErasedAssetLoader for L
source§fn load<'a>(
&'a self,
reader: &'a mut (dyn AsyncReadAndSeek + Unpin + Sync + Send + '_),
meta: Box<dyn AssetMetaDyn>,
load_context: LoadContext<'a>
) -> Pin<Box<dyn ConditionalSendFuture<Output = Result<ErasedLoadedAsset, Box<dyn Error + Sync + Send>>> + 'a>>
fn load<'a>( &'a self, reader: &'a mut (dyn AsyncReadAndSeek + Unpin + Sync + Send + '_), meta: Box<dyn AssetMetaDyn>, load_context: LoadContext<'a> ) -> Pin<Box<dyn ConditionalSendFuture<Output = Result<ErasedLoadedAsset, Box<dyn Error + Sync + Send>>> + 'a>>
Processes the asset in an asynchronous closure.
source§fn extensions(&self) -> &[&str]
fn extensions(&self) -> &[&str]
Returns a list of extensions supported by this asset loader, without the preceding dot.
source§fn deserialize_meta(
&self,
meta: &[u8]
) -> Result<Box<dyn AssetMetaDyn>, DeserializeMetaError>
fn deserialize_meta( &self, meta: &[u8] ) -> Result<Box<dyn AssetMetaDyn>, DeserializeMetaError>
Deserializes metadata from the input
meta
bytes into the appropriate type (erased as Box<dyn AssetMetaDyn>
).source§fn default_meta(&self) -> Box<dyn AssetMetaDyn>
fn default_meta(&self) -> Box<dyn AssetMetaDyn>
Returns the default meta value for the
AssetLoader
(erased as Box<dyn AssetMetaDyn>
).source§fn type_name(&self) -> &'static str
fn type_name(&self) -> &'static str
Returns the type name of the
AssetLoader
.source§fn asset_type_name(&self) -> &'static str
fn asset_type_name(&self) -> &'static str
Returns the type name of the top-level
Asset
loaded by the AssetLoader
.source§fn asset_type_id(&self) -> TypeId
fn asset_type_id(&self) -> TypeId
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
.