Struct bevy::audio::PlaybackSettings

pub struct PlaybackSettings {
    pub mode: PlaybackMode,
    pub volume: Volume,
    pub speed: f32,
    pub paused: bool,
}

Expand description

Initial settings to be used when audio starts playing. If you would like to control the audio while it is playing, query for the AudioSink or SpatialAudioSink components. Changes to this component will not be applied to already-playing audio.

Fields§

§mode: PlaybackMode

The desired playback behavior.

§volume: Volume

Volume to play at.

§speed: f32

Speed to play at.

§paused: bool

Create the sink in paused state. Useful for “deferred playback”, if you want to prepare the entity, but hear the sound later.

Implementations§

§

impl PlaybackSettings

pub const ONCE: PlaybackSettings = PlaybackSettings{ mode: PlaybackMode::Once, volume: Volume::Relative(VolumeLevel(1.0)), speed: 1.0, paused: false,}

Will play the associated audio source once.

pub const LOOP: PlaybackSettings = PlaybackSettings{ mode: PlaybackMode::Loop, volume: Volume::Relative(VolumeLevel(1.0)), speed: 1.0, paused: false,}

Will play the associated audio source in a loop.

pub const DESPAWN: PlaybackSettings = PlaybackSettings{ mode: PlaybackMode::Despawn, volume: Volume::Relative(VolumeLevel(1.0)), speed: 1.0, paused: false,}

Will play the associated audio source once and despawn the entity afterwards.

pub const REMOVE: PlaybackSettings = PlaybackSettings{ mode: PlaybackMode::Remove, volume: Volume::Relative(VolumeLevel(1.0)), speed: 1.0, paused: false,}

Will play the associated audio source once and remove the audio components afterwards.

pub const fn paused(self) -> PlaybackSettings

Helper to start in a paused state.

pub const fn with_volume(self, volume: Volume) -> PlaybackSettings

Helper to set the volume from start of playback.

pub const fn with_speed(self, speed: f32) -> PlaybackSettings

Helper to set the speed from start of playback.

Trait Implementations§

§

impl Clone for PlaybackSettings

§

fn clone(&self) -> PlaybackSettings

Returns a copy of the value. Read more

1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

§

impl Component for PlaybackSettingswhere PlaybackSettings: Send + Sync + 'static,

§

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either TableStorage or SparseStorage.

§

impl Debug for PlaybackSettings

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter. Read more

§

impl Default for PlaybackSettings

§

fn default() -> PlaybackSettings

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

§

impl Copy for PlaybackSettings

Auto Trait Implementations§

§

impl UnwindSafe for PlaybackSettings

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.

source §

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

source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source §

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

source §

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

Mutably borrows from an owned value. Read more

§

impl<C> Bundle for Cwhere C: Component,

§

fn component_ids( components: &mut Components, storages: &mut Storages, ids: &mut impl FnMut(ComponentId) )

§

unsafe fn from_components<T, F>(ctx: &mut T, func: &mut F) -> Cwhere F: for<'a> FnMut(&'a mut T) -> OwningPtr<'a, Aligned>,

§

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, 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.

§

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

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

§

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.

§

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.

§

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

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + 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.

§