Enum bevy_kira_components::sources::audio_file::source::AudioFile

pub enum AudioFile {
    Static(Arc<[u8]>, StaticSoundSettings),
    Streaming {
        path: PathBuf,
        settings: StreamingSoundSettings,
    },
}

Bevy [Asset] implementation that wraps audio data for [kira].

Streaming audio data is currently not possible over the internet, so when targeting the web, all audio sources need to be Static.

Variants

Static(Arc<[u8]>, StaticSoundSettings)

Static audio data, fully loaded in memory.

Streaming

Streaming audio data, pointing to a path on disk and loaded on demand.

Fields

path: PathBuf

Path to the audio file being read

settings: StreamingSoundSettings

Settings for the streaming audio file

Trait Implementations

impl AudioSource for AudioFile

type Error = PlaySoundError<AudioFileError>

Error type that encompasses possible errors that can happen when creating the audio source

type Handle = AudioFileHandle

Handle to the audio source, which allows control over the source from a non-audio thread.

type Settings = AudioFileSettings

Settings associated with this audio source, and passed in to the source for its creation.

fn create_handle( &self, manager: &mut AudioManager<AudioBackend>, asset_settings: &Self::Settings, output_destination: OutputDestination ) -> Result<Self::Handle, Self::Error>

Create an audio handle by calling the manager to play the sound data.

impl Clone for AudioFile

fn clone(&self) -> AudioFile

Returns a copy of the value.

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

Performs copy-assignment from source.

impl TypePath for AudioFile

where Self: 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 AudioFile

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

impl Asset for AudioFile