Struct bevy_kira_components::sources::audio_file::source::AudioFileHandle

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

Handle to an existing audio file. Access this component in your systems to manipulate the audio in real time (see the spatial example to see how to do so).

Implementations

impl AudioFileHandle

pub fn playback_state(&self) -> PlaybackState

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn position(&self) -> f64

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn set_playback_rate( &mut self, rate: impl Into<Value<PlaybackRate>>, tween: Tween )

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn set_panning(&mut self, panning: impl Into<Value<f64>>, tween: Tween)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn set_loop_region(&mut self, region: impl Into<Region>)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

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

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn pause(&mut self, tween: Tween)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn resume(&mut self, tween: Tween)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn resume_at(&mut self, start_time: StartTime, tween: Tween)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn stop(&mut self, tween: Tween)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn seek_to(&mut self, position: f64)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

pub fn seek_by(&mut self, amount: f64)

Forwarded call to [StaticSoundHandle] or [StreamingSoundHandle].

Note: Documentation cannot be provided directly due to limitations with docs in macros.

impl AudioFileHandle

pub fn toggle(&mut self, tween: Tween)

Convenience method to toggling the playback state of an audio file.

This is a simple wrapper around Self::pause and Self::resume, which are called depending on the current playback state.

Note that Kira has a special “stopped” state, which means the file has completely finished playing, and cannot be resumed (an error will be logged if that’s the case).