Struct crankstart::sound::sampleplayer::SamplePlayer

pub struct SamplePlayer { /* private fields */ }

Note: Make sure you hold on to a SamplePlayer until the sample has played as much as you want, because dropping it will stop playback.

Implementations

impl SamplePlayer

pub fn set_sample(&mut self, audio_sample: &AudioSample) -> Result<()>

Sets the sound effect to be played by this player.

pub fn play(&self, repeat_count: c_int, playback_speed: f32) -> Result<()>

Play the sample ‘repeat_count’ times; if 0, play until stop is called; if -1, play forward, backward, forward, etc. (See set_play_range to change which part is looped.) ‘playback_speed’ is how fast the sample plays; 1.0 is normal speed, 0.5 is down an octave, 2.0 is up one, etc. A negative rate plays the sample in reverse.

pub fn stop(&self) -> Result<()>

Can be used to stop a sample early, or stop one that’s repeating endlessly because ‘repeat’ was set to 0.

pub fn set_paused(&self, paused: bool) -> Result<()>

Pause or resume playback.

pub fn is_playing(&self) -> Result<bool>

Returns whether the player is currently playing the sample.

pub fn set_play_range(&self, start: c_int, end: c_int) -> Result<()>

Sets the start and end position, in frames, when looping a sample with repeat_count -1.

pub fn get_offset(&self) -> Result<f32>

Returns the current offset into the sample, in seconds, increasing as it plays. This is not adjusted for rate.

pub fn set_offset(&self, offset: f32) -> Result<()>

Set how far into the sample to start playing, in seconds. This is not adjusted for rate.

pub fn get_volume(&self) -> Result<(f32, f32)>

Gets the current volume of the left and right audio channels, out of 1.

pub fn set_volume(&self, left: f32, right: f32) -> Result<()>

Sets the volume of the left and right audio channels, out of 1.

pub fn get_rate(&self) -> Result<f32>

Gets the current playback speed. Returns 1 unless the value was changed by set_rate - it still returns 1 if the rate is changed with the argument to play.

pub fn set_rate(&self, playback_speed: f32) -> Result<()>

Sets the playback speed of the player after a sample has started playing. 1.0 is normal, 0.5 is down an octave, 2.0 is up one, etc. A negative rate plays the sample in reverse.

pub fn get_length(&self) -> Result<f32>

Returns the length of the assigned sample, in seconds.

Trait Implementations

impl Debug for SamplePlayer

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

Formats the value using the given formatter.

impl Drop for SamplePlayer

fn drop(&mut self)

Executes the destructor for this type.