Struct Sound

pub struct Sound { /* private fields */ }

A sound that can be played by the runtime.

Internally stores data as an array of 32 bit floating point values that range from -1.0 to 1.0

Implementations

impl Sound

pub fn from_data(sample_rate: i32, samples: &[f32]) -> Self

Create a sound from a slice of existing data

Arguments

• sample_rate - the number of samples per second
• data - slice of existing data

pub fn with_buffer_size(sample_rate: i32, sample_count: i32) -> Self

Create a blank/silent sound

Arguments

• sample_rate - the number of samples per second
• sample_count - the number of samples

pub fn with_buffer_sized_to_step( sample_rate: i32, steps_per_second: i32, ) -> Self

Create a sound with the number of samples needed to cover a specific step time

Arguments

• sample_rate - the number of samples per second
• steps_per_second - the number of steps per second

pub fn set_sample(&mut self, index: i32, sample: f32)

Sets a value of the sample

Arguments

• `index’ sample index
• sample - sample value

pub fn sample_rate(&self) -> i32

Gets the sample rate of the sound

pub fn sample_count(&self) -> i32

Gets the number of samples stored in this sound

pub fn samples(&self) -> &[f32]

Gets a reference to the raw sample data

pub fn samples_mut(&mut self) -> &mut [f32]

Gets a mutable reference to the raw sample data

pub fn sample(&self, start: i32, length: i32) -> Self

Creates a new sound by sampling a section of this one

Arguments

• `start’ sample start index
• length - length of the sample

Trait Implementations

impl Clone for Sound

fn clone(&self) -> Sound

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Sound

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sound

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Sound

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.