Struct bevy::audio::AudioSink

pub struct AudioSink { /* private fields */ }

Expand description

Asset controlling the playback of a sound

// Execution of this system should be controlled by a state or input,
// otherwise it would just toggle between play and pause every frame.
fn pause(
    audio_sinks: Res<Assets<AudioSink>>,
    music_controller: Local<Handle<AudioSink>>,
) {
    if let Some(sink) = audio_sinks.get(&*music_controller) {
        if sink.is_paused() {
            sink.play()
        } else {
            sink.pause()
        }
    }
}

Implementations

impl AudioSink

pub fn volume(&self) -> f32

Gets the volume of the sound.

The value 1.0 is the “normal” volume (unfiltered input). Any value other than 1.0 will multiply each sample by this value.

pub fn set_volume(&self, volume: f32)

Changes the volume of the sound.

The value 1.0 is the “normal” volume (unfiltered input). Any value other than 1.0 will multiply each sample by this value.

pub fn speed(&self) -> f32

Gets the speed of the sound.

The value 1.0 is the “normal” speed (unfiltered input). Any value other than 1.0 will change the play speed of the sound.

pub fn set_speed(&self, speed: f32)

Changes the speed of the sound.

The value 1.0 is the “normal” speed (unfiltered input). Any value other than 1.0 will change the play speed of the sound.

pub fn play(&self)

Resumes playback of a paused sink.

No effect if not paused.

pub fn pause(&self)

Pauses playback of this sink.

No effect if already paused. A paused sink can be resumed with play.

pub fn toggle(&self)

Toggles the playback of this sink.

Will pause if playing, and will be resumed if paused.

pub fn is_paused(&self) -> bool

Is this sink paused?

Sinks can be paused and resumed using pause, play, and toggle.

pub fn stop(&self)

Stops the sink.

It won’t be possible to restart it afterwards.

Trait Implementations

impl Drop for AudioSink

fn drop(&mut self)

Executes the destructor for this type. Read more

impl TypeUuid for AudioSink

const TYPE_UUID: Uuid = bevy_reflect::Uuid::from_bytes([139, 238, 87, 12, 87, 194, 79, 192, 140, 251, 152, 58, 34, 247, 217, 129])

Auto Trait Implementations

impl RefUnwindSafe for AudioSink

impl Send for AudioSink

impl Sync for AudioSink

impl Unpin for AudioSink

impl UnwindSafe for AudioSink

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T, U> AsBindGroupShaderType for Twhere
U: ShaderType,
&'a T: for<'a> Into,

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

Return the T ShaderType for self. When used in AsBindGroup derives, it is safe to assume that all images in self exist. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for Twhere
T: Any,

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

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

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

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 Twhere
T: Any + Send + Sync,

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

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

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T> Instrument for T

source

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

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

source

fn in_current_span(self) -> Instrumented<Self>ⓘ

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

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<T> TypeUuidDynamic for Twhere
T: TypeUuid,

fn type_uuid(&self) -> Uuid

Returns the UUID associated with this value’s type.

fn type_name(&self) -> &'static str

Returns the type name of this value’s type.

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

source

impl<T> WithSubscriber for T

source

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘwhere
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

source

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct bevy::audio::AudioSink

Implementations

impl AudioSink

pub fn volume(&self) -> f32

pub fn set_volume(&self, volume: f32)

pub fn speed(&self) -> f32

pub fn set_speed(&self, speed: f32)

pub fn play(&self)

pub fn pause(&self)

pub fn toggle(&self)

pub fn is_paused(&self) -> bool

pub fn stop(&self)

Trait Implementations

impl Drop for AudioSink

fn drop(&mut self)

impl TypeUuid for AudioSink

const TYPE_UUID: Uuid = bevy_reflect::Uuid::from_bytes([139, 238, 87, 12, 87, 194, 79, 192, 140, 251, 152, 58, 34, 247, 217, 129])

Auto Trait Implementations

impl RefUnwindSafe for AudioSink

impl Send for AudioSink

impl Sync for AudioSink

impl Unpin for AudioSink

impl UnwindSafe for AudioSink

Blanket Implementations

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

fn type_id(&self) -> TypeId

impl<T, U> AsBindGroupShaderType<U> for Twhere U: ShaderType, &'a T: for<'a> Into<U>,

fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast<T> for T

fn downcast(&self) -> &T

impl<T> Downcast for Twhere T: Any,

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

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

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

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

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

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

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

fn in_current_span(self) -> Instrumented<Self>ⓘ

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<T> TypeUuidDynamic for Twhere T: TypeUuid,

fn type_uuid(&self) -> Uuid

fn type_name(&self) -> &'static str

impl<T> Upcast<T> for T

fn upcast(&self) -> Option<&T>

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘwhere S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>ⓘ

impl<T> Asset for Twhere T: TypeUuid + AssetDynamic + TypeUuidDynamic,

impl<T> AssetDynamic for Twhere T: 'static + Send + Sync + TypeUuidDynamic,

impl<T> Event for Twhere T: 'static + Send + Sync,

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

impl<T, U> AsBindGroupShaderType<U> for Twhere
U: ShaderType,
&'a T: for<'a> Into<U>,

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

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

impl<T> Downcast for Twhere
T: Any,

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

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

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

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

impl<T> TypeUuidDynamic for Twhere
T: TypeUuid,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>ⓘwhere
S: Into<Dispatch>,

impl<T> Asset for Twhere
T: TypeUuid + AssetDynamic + TypeUuidDynamic,

impl<T> AssetDynamic for Twhere
T: 'static + Send + Sync + TypeUuidDynamic,

impl<T> Event for Twhere
T: 'static + Send + Sync,