Struct AudioChannel

pub struct AudioChannel<T> { /* private fields */ }

Channel to play and control audio

Add your own channels via add_audio_channel. By default, there is only the AudioChannel<MainTrack> channel.

Trait Implementations

impl<T> AudioControl for AudioChannel<T>

fn play(&self, audio_source: Handle<AudioSource>) -> PlayAudioCommand<'_>

Play audio

fn my_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play(asset_server.load("audio.mp3"));
}

fn stop(&self) -> TweenCommand<'_, FadeOut>

Stop all audio

fn my_system(audio: Res<Audio>) {
    audio.stop();
}

fn pause(&self) -> TweenCommand<'_, FadeOut>

Pause all audio

fn my_system(audio: Res<Audio>) {
    audio.pause();
}

fn resume(&self) -> TweenCommand<'_, FadeIn>

Resume all audio

fn my_system(audio: Res<Audio>) {
    audio.resume();
}

fn set_volume(&self, volume: impl Into<Volume>) -> TweenCommand<'_, FadeIn>

Set the volume

The default value is 1.

fn my_system(audio: Res<Audio>) {
    audio.set_volume(0.5);
}

fn set_panning(&self, panning: f64) -> TweenCommand<'_, FadeIn>

Set panning

The default value is 0.5 Values up to 1 pan to the right Values down to 0 pan to the left

fn my_system(audio: Res<Audio>) {
    audio.set_panning(0.9);
}

fn set_playback_rate(&self, playback_rate: f64) -> TweenCommand<'_, FadeIn>

Set playback rate

The default value is 1

fn my_system(audio: Res<Audio>) {
    audio.set_playback_rate(2.0);
}

fn state(&self, instance_handle: &Handle<AudioInstance>) -> PlaybackState

Get state for a playback instance.

fn is_playing_sound(&self) -> bool

Returns true if there is any sound in this channel that is in the state Playing, Pausing, or Stopping

If there are only Stopped, Paused, or Queued sounds, the method will return false. The same result is returned if there are no sounds in the channel at all.

impl<T> Default for AudioChannel<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Resource for AudioChannel<T>

where Self: Send + Sync + 'static,