Struct rusty_audio::Audio

pub struct Audio { /* fields omitted */ }

A simple 4-track audio system to load/decode audio files from disk to play later. Supported formats are: MP3, WAV, Vorbis and Flac.

Implementations

impl Audio

pub fn new() -> Self

Create a new sound subsystem. You only need one of these – you can use it to load and play any number of audio clips.

pub fn disabled(&self) -> bool

If no sound device was detected, the audio subsystem will run in a disabled mode that doesn’t actually do anything. This method indicates whether audio is disabled.

pub fn add(&mut self, name: &'static str, path: &str)

Add an audio clip to play. Audio clips will be decoded and buffered during this call so the first call to .play() is not staticky if you compile in debug mode. name is what you will refer to this clip as when you need to play it. Files known to be supported by the underlying library (rodio) at the time of this writing are MP3, WAV, Vorbis and Flac.

pub fn play(&mut self, name: &str)

Play an audio clip that has already been loaded. name is the name you chose when you added the clip to the Audio system. If you forgot to load the clip first, this will crash.

pub fn wait(&self)

Block until no sounds are playing. Convenient for keeping a thread alive until all sounds have played.

Trait Implementations

impl Default for Audio

fn default() -> Audio

Returns the “default value” for a type.