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<Decibels>) -> TweenCommand<'_, FadeIn>

Set the volume in Decibels

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

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

Set panning

The default value is 0.0 Values up to 1.0 pan to the right Values down to -1.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> Component for AudioChannel<T>

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

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,