Struct Sound 

pub struct Sound(/* private fields */);

A sound object.

This is a wrapper around the dos_like_sys::sound_t struct.

Implementations

impl Sound

pub fn load_wav(path: impl AsRef<str>) -> Result<Sound, FileError>

Loads a new sound from a file.

This is equivalent to the module’s load_wav function.

pub fn create_sound(channels: u32, sample_rate: u32, samples: &[u16]) -> Sound

Creates a new sound from a buffer.

Note that this copies the samples internally, so there is effectively no lifetime dependency with the buffer.

Only 1 or 2 channels are supported. The sample rate is a number in Hz, between 1000 and 44100. The number of samples should also not be zero.

Panic

Panics if the given parameters are invalid for a sound.

pub fn play(&self, channel: u8, loop_: bool, volume: u8)

Plays this sound.

Trait Implementations

impl Debug for Sound

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

Formats the value using the given formatter.

impl Send for Sound