Struct bevy_kira_audio::Audio[−][src]

pub struct Audio { /* fields omitted */ }

Expand description

Bevy Audio Resource

Use this resource to play and control your audio


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

Implementations

[src]

impl Audio

[src]

pub fn play(&self, audio_source: Handle<AudioSource>)

Play audio in the default channel


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

[src]

pub fn play_looped(&self, audio_source: Handle<AudioSource>)

Play looped audio in the default channel


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

[src]

pub fn stop(&self)

Stop all audio in the default channel


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

[src]

pub fn pause(&self)

Pause all audio in the default channel


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

[src]

pub fn resume(&self)

Resume all audio in the default channel


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

[src]

pub fn set_volume(&self, volume: f32)

Set the volume for the default channel

The default value is 1


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

[src]

pub fn set_panning(&self, panning: f32)

Set panning for the default channel

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);
}

[src]

pub fn set_playback_rate(&self, playback_rate: f32)

Set playback rate for the default channel

The default value is 1


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

[src]

pub fn play_in_channel(
    &self, 
    audio_source: Handle<AudioSource>, 
    channel_id: &AudioChannel
)

Play audio in the given channel


fn my_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play_in_channel(asset_server.load("audio.mp3"), &AudioChannel::new("my-channel".to_owned()));
}

[src]

pub fn play_looped_in_channel(
    &self, 
    audio_source: Handle<AudioSource>, 
    channel_id: &AudioChannel
)

Play looped audio in the given channel


fn my_system(asset_server: Res<AssetServer>, audio: Res<Audio>) {
    audio.play_looped_in_channel(asset_server.load("audio.mp3"), &AudioChannel::new("my-channel".to_owned()));
}

[src]

pub fn stop_channel(&self, channel_id: &AudioChannel)

Stop audio in the given channel


fn my_system(audio: Res<Audio>) {
    audio.stop_channel(&AudioChannel::new("my-channel".to_owned()));
}

[src]

pub fn pause_channel(&self, channel_id: &AudioChannel)

Pause audio in the given channel


fn my_system(audio: Res<Audio>) {
    audio.pause_channel(&AudioChannel::new("my-channel".to_owned()));
}

[src]

pub fn resume_channel(&self, channel_id: &AudioChannel)

Resume audio in the given channel


fn my_system(audio: Res<Audio>) {
    audio.resume_channel(&AudioChannel::new("my-channel".to_owned()));
}

[src]

pub fn set_volume_in_channel(&self, volume: f32, channel_id: &AudioChannel)

Set the volume for the given channel

The default value is 1


fn my_system(audio: Res<Audio>) {
    audio.set_volume_in_channel(0.5, &AudioChannel::new("my-channel".to_owned()));
}

[src]

pub fn set_panning_in_channel(&self, panning: f32, channel_id: &AudioChannel)

Set panning for the given channel

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_in_channel(0.9, &AudioChannel::new("my-channel".to_owned()));
}

[src]

pub fn set_playback_rate_in_channel(
    &self, 
    playback_rate: f32, 
    channel_id: &AudioChannel
)

Set playback rate for the given channel

The default value is 1


fn my_system(audio: Res<Audio>) {
    audio.set_playback_rate_in_channel(2.0, &AudioChannel::new("my-channel".to_owned()));
}

Trait Implementations

[src]

impl Default for Audio

[src]

fn default() -> Audio

Returns the “default value” for a type. Read more

Auto Trait Implementations

impl !RefUnwindSafe for Audio

impl Send for Audio

impl Sync for Audio

impl Unpin for Audio

impl UnwindSafe for Audio

Blanket Implementations

[src]

impl<T> Any for T where
    T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
    T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> Downcast for T where
    T: Any,

pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

pub fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

impl<T> DowncastSync for T where
    T: Any + Send + Sync,

pub fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 'static + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

impl<T> FromWorld for T where
    T: Default,

pub fn from_world(_world: &mut World) -> T

Creates Self using data from the given [World]

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into<U> for T where
    U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> Component for T where
    T: 'static + Send + Sync,