Struct amethyst::audio::AudioContext

pub struct AudioContext { /* fields omitted */ }

A context for loading audio files

Methods

impl AudioContext

fn new() -> AudioContext

Creates a new audio context.

Trait Implementations

impl Context for AudioContext

type Asset = Source

The asset type this context can produce.

type Data = Vec<u8>

The Data type the asset can be created from.

type Error = NoError

The error that may be returned from create_asset.

type Result = Result<Self::Asset, Self::Error>

The result type for loading an asset. This can also be a future (or anything that implements IntoFuture).

fn category(&self) -> &str

A small keyword for which category these assets belongs to.

fn create_asset(&self, data: Vec<u8>, _: &ThreadPool) -> Result<Source, NoError>

Provides the conversion from the data format to the actual asset.

fn update(&self, spec: &AssetSpec, asset: AssetFuture<Source>)

Updates an asset after it's been reloaded.

fn cache(&self, _spec: AssetSpec, _asset: AssetFuture<Self::Asset>)

Notifies about an asset load. This is can be used to cache the asset. To return a cached asset, see the retrieve function.

fn retrieve(&self, _spec: &AssetSpec) -> Option<AssetFuture<Self::Asset>>

Returns Some cached value if possible, otherwise None.

fn clear(&self)

Gives a hint that several assets may have been released recently.

fn clear_all(&self)

Request for clearing the whole cache.