Struct kira::sound::static_sound::StaticSoundHandle

pub struct StaticSoundHandle { /* fields omitted */ }

Controls a static sound.

Implementations

impl StaticSoundHandle

pub fn state(&self) -> PlaybackState

Returns the current playback state of the sound.

pub fn position(&self) -> f64

Returns the current playback position of the sound (in seconds).

pub fn set_volume(
    &mut self,
    volume: impl Into<Volume>,
    tween: Tween
) -> Result<(), CommandError>

Sets the volume of the sound (as a factor of the original volume).

pub fn set_playback_rate(
    &mut self,
    playback_rate: impl Into<PlaybackRate>,
    tween: Tween
) -> Result<(), CommandError>

Sets the playback rate of the sound.

Changing the playback rate will change both the speed and pitch of the sound.

pub fn set_panning(
    &mut self,
    panning: f64,
    tween: Tween
) -> Result<(), CommandError>

Sets the panning of the sound, where 0.0 is hard left, 0.5 is center, and 1.0 is hard right.

pub fn pause(&mut self, tween: Tween) -> Result<(), CommandError>

Fades out the sound to silence with the given tween and then pauses playback.

pub fn resume(&mut self, tween: Tween) -> Result<(), CommandError>

Resumes playback and fades in the sound from silence with the given tween.

pub fn stop(&mut self, tween: Tween) -> Result<(), CommandError>

Fades out the sound to silence with the given tween and then stops playback.

Once the sound is stopped, it cannot be restarted.

pub fn seek_to(&mut self, position: f64) -> Result<(), CommandError>

Sets the playback position to the specified time in seconds.

pub fn seek_by(&mut self, amount: f64) -> Result<(), CommandError>

Moves the playback position by the specified amount of time in seconds.