Struct AudioSource

pub struct AudioSource {
    pub bytes: Arc<[u8]>,
}

A source of audio data

Fields

bytes: Arc<[u8]>

Raw data of the audio source.

The data must be one of the file formats supported by Bevy (wav, ogg, flac, or mp3). However, support for these file formats is not part of Bevy’s default feature set. In order to be able to use these file formats, you will have to enable the appropriate optional features.

It is decoded using rodio::decoder::Decoder. The decoder has conditionally compiled methods depending on the features enabled. If the format used is not enabled, then this will panic with an UnrecognizedFormat error.

Trait Implementations

impl AsRef<[u8]> for AudioSource

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for AudioSource

fn clone(&self) -> AudioSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioSource

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

Formats the value using the given formatter.

impl Decodable for AudioSource

type DecoderItem = <Decoder<Cursor<AudioSource>> as Iterator>::Item

The type of the audio samples. Usually a u16, i16 or f32, as those implement rodio::Sample. Other types can implement the rodio::Sample trait as well.

type Decoder = Decoder<Cursor<AudioSource>>

The type of the iterator of the audio samples, which iterates over samples of type Self::DecoderItem. Must be a rodio::Source so that it can provide information on the audio it is iterating over.

fn decoder(&self) -> Self::Decoder

Build and return a Self::Decoder of the implementing type

impl TypePath for AudioSource

where AudioSource: Any + Send + Sync,

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl VisitAssetDependencies for AudioSource

fn visit_dependencies(&self, visit: &mut impl FnMut(UntypedAssetId))

impl Asset for AudioSource