Struct Sound

pub struct Sound { /* private fields */ }

Sound

Implementations

impl Sound

pub fn frame_count(&self) -> u32

Total number of frames (considering channels)

pub fn from_file(filname: &str) -> Option<Self>

Load sound from file

pub fn from_wave(wave: &Wave) -> Option<Self>

Load sound from wave data

pub fn update(&mut self, data: &[u8], sample_count: u32)

Update sound buffer with new data

pub fn play(&self, _device: &mut AudioDevice)

Play a sound

pub fn stop(&self, _device: &mut AudioDevice)

Stop playing a sound

pub fn pause(&self, _device: &mut AudioDevice)

Pause a sound

pub fn resume(&self, _device: &mut AudioDevice)

Resume a paused sound

pub fn is_playing(&self, _device: &mut AudioDevice) -> bool

Check if a sound is currently playing

pub fn set_volume(&self, volume: f32, _device: &mut AudioDevice)

Set volume for a sound (1.0 is max level)

pub fn set_pitch(&self, pitch: f32, _device: &mut AudioDevice)

Set pitch for a sound (1.0 is base level)

pub fn set_pan(&self, pan: f32, _device: &mut AudioDevice)

Set pan for a sound (0.5 is center)

pub fn as_raw(&self) -> &Sound

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub fn as_raw_mut(&mut self) -> &mut Sound

Get the ‘raw’ ffi type Take caution when cloning so it doesn’t outlive the original

pub unsafe fn from_raw(raw: Sound) -> Self

Convert a ‘raw’ ffi object to a safe wrapper

Safety

• The raw object must be correctly initialized
• The raw object should be unique. Otherwise, make sure its clones don’t outlive the newly created object.

Trait Implementations

impl Debug for Sound

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

Formats the value using the given formatter.

impl Drop for Sound

fn drop(&mut self)

Executes the destructor for this type.