Struct SoundData 

pub struct SoundData { /* private fields */ }

Decoded PCM audio kept in memory: interleaved f32 samples.

You normally never touch this directly; the engine loads files for you. It is public so you can generate sounds in code and register them with Audio::register.

Implementations

impl SoundData

pub fn from_samples( samples: Vec<f32>, channels: usize, sample_rate: u32, ) -> Self

Creates sound data from interleaved samples in the range -1.0..=1.0.

Panics

If channels is 0 or sample_rate is 0.

pub fn tone(frequency: f32, seconds: f32, volume: f32) -> Self

Generates a sine tone with short fades, handy for prototypes and beeps. frequency is the pitch in hertz (440 = A, 880 = one octave higher), seconds the length and volume the linear loudness from 0.0 to 1.0.

pub fn generate(seconds: f32, f: impl FnMut(f32) -> f32) -> Self

Generates mono sound from a function of time in seconds. Adds 5 ms fades at both ends to avoid clicks.

pub fn duration(&self) -> f32

Length in seconds.

pub fn channels(&self) -> usize

Number of channels (1 = mono, 2 = stereo).

pub fn sample_rate(&self) -> u32

Sample rate in Hz.

pub fn load(path: impl AsRef<Path>) -> Result<Self>

Loads and decodes a sound file (wav, ogg, mp3, flac, aiff, m4a/aac, …).

Trait Implementations

impl Clone for SoundData

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundData

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

Formats the value using the given formatter.

impl From<Synth> for SoundData

fn from(synth: Synth) -> Self

Converts to this type from the input type.