Struct SoundHandle 

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

Wraps a Sound so it can be returned to the user after play.

This type can be cheaply cloned, and it will share the same data.

Implementations

impl SoundHandle

pub fn new(sound: Sound) -> Self

Make a new SoundHandle from a Sound.

pub fn guard(&self) -> MutexGuard<'_, Sound>

Lock the Sound for modification. Returns a MutexGuard.

pub fn loop_enabled(&self) -> bool

Delegate to the underlying Sound.

impl SoundHandle

pub fn sample_rate(&self) -> u32

Delegate to the underlying Sound’s method.

pub fn duration(&self) -> Duration

Delegate to the underlying Sound’s method.

pub fn duration_seconds(&self) -> f64

Delegate to the underlying Sound’s method.

pub fn push_frame_to_resampler(&self)

Delegate to the underlying Sound’s method.

pub fn is_playing_backwards(&self) -> bool

Delegate to the underlying Sound’s method.

pub fn update_position(&self)

Delegate to the underlying Sound’s method.

pub fn finished(&self) -> bool

Delegate to the underlying Sound’s method.

pub fn next_frame(&self, sample_rate: u32) -> Option<Frame>

Delegate to the underlying Sound’s method.

pub fn reset(&self)

Delegate to the underlying Sound’s method.

pub fn set_playback_rate(&self, playback_rate: PlaybackRate) -> PlaybackRate

Delegate to the underlying Sound’s method.

pub fn playback_rate(&self) -> PlaybackRate

Delegate to the underlying Sound’s method.

pub fn base_playback_rate(&self) -> PlaybackRate

Delegate to the underlying Sound’s method.

pub fn set_volume(&self, volume: f32) -> f32

Delegate to the underlying Sound’s method.

pub fn volume(&self) -> f32

Delegate to the underlying Sound’s method.

pub fn base_volume(&self) -> f32

Delegate to the underlying Sound’s method.

pub fn seek_to_index(&self, index: usize)

Delegate to the underlying Sound’s method.

pub fn seek_to_end(&self)

Delegate to the underlying Sound’s method.

pub fn seek_by(&self, seconds: f64)

Delegate to the underlying Sound’s method.

pub fn seek_to(&self, seconds: f64)

Delegate to the underlying Sound’s method.

pub fn reverse(&self)

Delegate to the underlying Sound’s method.

pub fn add_command(&self, command: Command)

Delegate to the underlying Sound’s method.

pub fn set_loop_index(&self, loop_region: RangeInclusive<usize>)

Delegate to the underlying Sound’s method.

pub fn set_loop_enabled(&self, enabled: bool) -> bool

Delegate to the underlying Sound’s method.

pub fn set_loop(&self, loop_region: RangeInclusive<f64>)

Delegate to the underlying Sound’s method.

pub fn loop_start(&self) -> usize

Delegate to the underlying Sound’s method.

pub fn loop_end(&self) -> usize

Delegate to the underlying Sound’s method.

pub fn loop_start_secs(&self) -> f64

Delegate to the underlying Sound’s method.

pub fn loop_end_secs(&self) -> f64

Delegate to the underlying Sound’s method.

pub fn index(&self) -> usize

Delegate to the underlying Sound’s method.

pub fn base_index(&self) -> usize

Delegate to the underlying Sound’s method.

pub fn outputting_silence(&self) -> bool

Delegate to the underlying Sound’s method.

pub fn pause(&self)

Delegate to the underlying Sound’s method.

pub fn paused(&self) -> bool

Delegate to the underlying Sound’s method.

pub fn resume(&self)

Delegate to the underlying Sound’s method.

pub fn set_panning(&self, panning: f32) -> f32

Delegate to the underlying Sound’s method.

pub fn panning(&self) -> f32

Delegate to the underlying Sound’s method.

Trait Implementations

impl Clone for SoundHandle

fn clone(&self) -> SoundHandle

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SoundHandle

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

Formats the value using the given formatter.

impl From<Sound> for SoundHandle

fn from(sound: Sound) -> Self

Converts to this type from the input type.