Struct PlaybackSettings 

pub struct PlaybackSettings {
    pub mode: PlaybackMode,
    pub volume: Volume,
    pub speed: f32,
    pub paused: bool,
    pub muted: bool,
    pub spatial: bool,
    pub spatial_scale: Option<SpatialScale>,
    pub start_position: Option<Duration>,
    pub duration: Option<Duration>,
}

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.

muted: bool

Whether to create the sink in muted state or not.

This is useful for audio that should be initially muted. You can still set the initial volume and it is applied when the audio is unmuted.

spatial: bool

Enables spatial audio for this source.

See also: SpatialListener.

Note: Bevy does not currently support HRTF or any other high-quality 3D sound rendering features. Spatial audio is implemented via simple left-right stereo panning.

spatial_scale: Option<SpatialScale>

Optional scale factor applied to the positions of this audio source and the listener, overriding the default value configured on AudioPlugin::default_spatial_scale.

start_position: Option<Duration>

The point in time in the audio clip where playback should start. If set to None, it will play from the beginning of the clip.

If the playback mode is set to Loop, each loop will start from this position.

duration: Option<Duration>

How long the audio should play before stopping. If set, the clip will play for at most the specified duration. If set to None, it will play for as long as it can.

If the playback mode is set to Loop, each loop will last for this duration.

Implementations

impl PlaybackSettings

pub const ONCE: PlaybackSettings

Will play the associated audio source once.

Note: It is not possible to reuse an AudioPlayer after it has finished playing and the underlying AudioSink or SpatialAudioSink has been drained.

To replay a sound, the audio components provided by AudioPlayer must be removed and added again.

pub const LOOP: PlaybackSettings

Will play the associated audio source in a loop.

pub const DESPAWN: PlaybackSettings

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

pub const REMOVE: PlaybackSettings

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 muted(self) -> PlaybackSettings

Helper to start muted.

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.

pub const fn with_spatial(self, spatial: bool) -> PlaybackSettings

Helper to enable or disable spatial audio.

pub const fn with_spatial_scale( self, spatial_scale: SpatialScale, ) -> PlaybackSettings

Helper to use a custom spatial scale.

pub const fn with_start_position( self, start_position: Duration, ) -> PlaybackSettings

Helper to use a custom playback start position.

pub const fn with_duration(self, duration: Duration) -> PlaybackSettings

Helper to use a custom playback duration.

Trait Implementations

impl Clone for PlaybackSettings

fn clone(&self) -> PlaybackSettings

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for PlaybackSettings

where PlaybackSettings: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

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 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_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace 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 Debug for PlaybackSettings

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

Formats the value using the given formatter.

impl Default for PlaybackSettings

fn default() -> PlaybackSettings

Returns the “default value” for a type.

impl FromReflect for PlaybackSettings

fn from_reflect( reflect: &(dyn PartialReflect + 'static), ) -> Option<PlaybackSettings>

Constructs a concrete instance of Self from a reflected value.

fn take_from_reflect( reflect: Box<dyn PartialReflect>, ) -> Result<Self, Box<dyn PartialReflect>>

Attempts to downcast the given value to Self using, constructing the value using from_reflect if that fails.

impl GetTypeRegistration for PlaybackSettings

fn get_type_registration() -> TypeRegistration

Returns the default TypeRegistration for this type.

fn register_type_dependencies(registry: &mut TypeRegistry)

Registers other types needed by this type.

impl PartialReflect for PlaybackSettings

fn get_represented_type_info(&self) -> Option<&'static TypeInfo>

Returns the TypeInfo of the type represented by this value.

fn try_apply( &mut self, value: &(dyn PartialReflect + 'static), ) -> Result<(), ApplyError>

Tries to apply a reflected value to this value.

fn reflect_kind(&self) -> ReflectKind

Returns a zero-sized enumeration of “kinds” of type.

fn reflect_ref(&self) -> ReflectRef<'_>

Returns an immutable enumeration of “kinds” of type.

fn reflect_mut(&mut self) -> ReflectMut<'_>

Returns a mutable enumeration of “kinds” of type.

fn reflect_owned(self: Box<PlaybackSettings>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<PlaybackSettings>, ) -> Result<Box<dyn Reflect>, Box<dyn PartialReflect>>

Attempts to cast this type to a boxed, fully-reflected value.

fn try_as_reflect(&self) -> Option<&(dyn Reflect + 'static)>

Attempts to cast this type to a fully-reflected value.

fn try_as_reflect_mut(&mut self) -> Option<&mut (dyn Reflect + 'static)>

Attempts to cast this type to a mutable, fully-reflected value.

fn into_partial_reflect(self: Box<PlaybackSettings>) -> Box<dyn PartialReflect>

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &(dyn PartialReflect + 'static)

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut (dyn PartialReflect + 'static)

Casts this type to a mutable, reflected value.

fn reflect_partial_eq( &self, value: &(dyn PartialReflect + 'static), ) -> Option<bool>

Returns a “partial equality” comparison result.

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

Debug formatter for the value.

fn reflect_clone(&self) -> Result<Box<dyn Reflect>, ReflectCloneError>

Attempts to clone Self using reflection.

fn apply(&mut self, value: &(dyn PartialReflect + 'static))

Applies a reflected value to this value.

fn to_dynamic(&self) -> Box<dyn PartialReflect>

Converts this reflected value into its dynamic representation based on its kind.

fn reflect_clone_and_take<T>(&self) -> Result<T, ReflectCloneError>

where T: 'static, Self: Sized + TypePath,

For a type implementing PartialReflect, combines reflect_clone and take in a useful fashion, automatically constructing an appropriate ReflectCloneError if the downcast fails.

fn reflect_hash(&self) -> Option<u64>

Returns a hash of the value (which includes the type).

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for PlaybackSettings

fn into_any(self: Box<PlaybackSettings>) -> Box<dyn Any>

Returns the value as a Box<dyn Any>.

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

Returns the value as a &dyn Any.

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

Returns the value as a &mut dyn Any.

fn into_reflect(self: Box<PlaybackSettings>) -> Box<dyn Reflect>

Casts this type to a boxed, fully-reflected value.

fn as_reflect(&self) -> &(dyn Reflect + 'static)

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut (dyn Reflect + 'static)

Casts this type to a mutable, fully-reflected value.

fn set(&mut self, value: Box<dyn Reflect>) -> Result<(), Box<dyn Reflect>>

Performs a type-checked assignment of a reflected value to this value.

impl Struct for PlaybackSettings

fn field(&self, name: &str) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field named name as a &dyn PartialReflect.

fn field_mut( &mut self, name: &str, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field named name as a &mut dyn PartialReflect.

fn field_at(&self, index: usize) -> Option<&(dyn PartialReflect + 'static)>

Returns a reference to the value of the field with index index as a &dyn PartialReflect.

fn field_at_mut( &mut self, index: usize, ) -> Option<&mut (dyn PartialReflect + 'static)>

Returns a mutable reference to the value of the field with index index as a &mut dyn PartialReflect.

fn name_at(&self, index: usize) -> Option<&str>

Returns the name of the field with index index.

fn field_len(&self) -> usize

Returns the number of fields in the struct.

fn iter_fields(&self) -> FieldIter<'_>

Returns an iterator over the values of the reflectable fields for this struct.

fn to_dynamic_struct(&self) -> DynamicStruct

Creates a new DynamicStruct from this struct.

fn get_represented_struct_info(&self) -> Option<&'static StructInfo>

Will return None if TypeInfo is not available.

impl TypePath for PlaybackSettings

fn type_path() -> &'static str

Returns the fully qualified path of the underlying type.

fn short_type_path() -> &'static str

Returns a short, pretty-print enabled path to the type.

fn type_ident() -> Option<&'static str>

Returns the name of the type, or None if it is anonymous.

fn crate_name() -> Option<&'static str>

Returns the name of the crate the type is in, or None if it is anonymous.

fn module_path() -> Option<&'static str>

Returns the path to the module the type is in, or None if it is anonymous.

impl Typed for PlaybackSettings

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for PlaybackSettings