Struct bevy::prelude::PlaybackSettings

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

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.

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.

Implementations

impl PlaybackSettings

pub const ONCE: PlaybackSettings = _

Will play the associated audio source once.

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

Examples found in repository

examples/audio/spatial_audio_2d.rs (line 45)

fn setup(
    mut commands: Commands,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<ColorMaterial>>,
    asset_server: Res<AssetServer>,
) {
    // Space between the two ears
    let gap = 400.0;

    // sound emitter
    commands.spawn((
        MaterialMesh2dBundle {
            mesh: meshes.add(Circle::new(15.0)).into(),
            material: materials.add(Color::BLUE),
            transform: Transform::from_translation(Vec3::new(0.0, 50.0, 0.0)),
            ..default()
        },
        Emitter::default(),
        AudioBundle {
            source: asset_server.load("sounds/Windless Slopes.ogg"),
            settings: PlaybackSettings::LOOP.with_spatial(true),
        },
    ));

    let listener = SpatialListener::new(gap);
    commands
        .spawn((SpatialBundle::default(), listener.clone()))
        .with_children(|parent| {
            // left ear
            parent.spawn(SpriteBundle {
                sprite: Sprite {
                    color: Color::RED,
                    custom_size: Some(Vec2::splat(20.0)),
                    ..default()
                },
                transform: Transform::from_xyz(-gap / 2.0, 0.0, 0.0),
                ..default()
            });

            // right ear
            parent.spawn(SpriteBundle {
                sprite: Sprite {
                    color: Color::GREEN,
                    custom_size: Some(Vec2::splat(20.0)),
                    ..default()
                },
                transform: Transform::from_xyz(gap / 2.0, 0.0, 0.0),
                ..default()
            });
        });

    // example instructions
    commands.spawn(
        TextBundle::from_section(
            "Up/Down/Left/Right: Move Listener\nSpace: Toggle Emitter Movement",
            TextStyle {
                font_size: 20.0,
                ..default()
            },
        )
        .with_style(Style {
            position_type: PositionType::Absolute,
            bottom: Val::Px(12.0),
            left: Val::Px(12.0),
            ..default()
        }),
    );

    // camera
    commands.spawn(Camera2dBundle::default());
}

examples/audio/spatial_audio_3d.rs (line 33)

fn setup(
    mut commands: Commands,
    asset_server: Res<AssetServer>,
    mut meshes: ResMut<Assets<Mesh>>,
    mut materials: ResMut<Assets<StandardMaterial>>,
) {
    // Space between the two ears
    let gap = 4.0;

    // sound emitter
    commands.spawn((
        PbrBundle {
            mesh: meshes.add(Sphere::new(0.2).mesh().uv(32, 18)),
            material: materials.add(Color::BLUE),
            transform: Transform::from_xyz(0.0, 0.0, 0.0),
            ..default()
        },
        Emitter::default(),
        AudioBundle {
            source: asset_server.load("sounds/Windless Slopes.ogg"),
            settings: PlaybackSettings::LOOP.with_spatial(true),
        },
    ));

    let listener = SpatialListener::new(gap);
    commands
        .spawn((SpatialBundle::default(), listener.clone()))
        .with_children(|parent| {
            // left ear indicator
            parent.spawn(PbrBundle {
                mesh: meshes.add(Cuboid::new(0.2, 0.2, 0.2)),
                material: materials.add(Color::RED),
                transform: Transform::from_translation(listener.left_ear_offset),
                ..default()
            });

            // right ear indicator
            parent.spawn(PbrBundle {
                mesh: meshes.add(Cuboid::new(0.2, 0.2, 0.2)),
                material: materials.add(Color::GREEN),
                transform: Transform::from_translation(listener.right_ear_offset),
                ..default()
            });
        });

    // light
    commands.spawn(DirectionalLightBundle {
        transform: Transform::from_xyz(4.0, 8.0, 4.0).looking_at(Vec3::ZERO, Vec3::Y),
        ..default()
    });

    // example instructions
    commands.spawn(
        TextBundle::from_section(
            "Up/Down/Left/Right: Move Listener\nSpace: Toggle Emitter Movement",
            TextStyle {
                font_size: 20.0,
                ..default()
            },
        )
        .with_style(Style {
            position_type: PositionType::Absolute,
            bottom: Val::Px(12.0),
            left: Val::Px(12.0),
            ..default()
        }),
    );

    // camera
    commands.spawn(Camera3dBundle {
        transform: Transform::from_xyz(0.0, 5.0, 5.0).looking_at(Vec3::ZERO, Vec3::Y),
        ..default()
    });
}

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

Helper to use a custom spatial scale.

Trait Implementations

impl Clone for PlaybackSettings

fn clone(&self) -> PlaybackSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component for PlaybackSettings

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

impl Default for PlaybackSettings

fn default() -> PlaybackSettings

Returns the “default value” for a type.

impl FromReflect for PlaybackSettings

where PlaybackSettings: Any + Send + Sync, PlaybackMode: FromReflect + TypePath, Volume: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<SpatialScale>: FromReflect + TypePath,

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

Constructs a concrete instance of Self from a reflected value.

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

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

impl GetTypeRegistration for PlaybackSettings

where PlaybackSettings: Any + Send + Sync, PlaybackMode: FromReflect + TypePath, Volume: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<SpatialScale>: FromReflect + TypePath,

fn get_type_registration() -> TypeRegistration

impl Reflect for PlaybackSettings

where PlaybackSettings: Any + Send + Sync, PlaybackMode: FromReflect + TypePath, Volume: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<SpatialScale>: FromReflect + TypePath,

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

Returns the TypeInfo of the type represented by this value.

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 reflected value.

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

Casts this type to a reflected value.

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

Casts this type to a mutable reflected value.

fn clone_value(&self) -> Box<dyn Reflect>

Clones the value as a Reflect trait object.

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

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

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

Applies 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 reflect_partial_eq(&self, value: &(dyn Reflect + 'static)) -> Option<bool>

Returns a “partial equality” comparison result.

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

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

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

Debug formatter for the value.

fn serializable(&self) -> Option<Serializable<'_>>

Returns a serializable version of the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Struct for PlaybackSettings

where PlaybackSettings: Any + Send + Sync, PlaybackMode: FromReflect + TypePath, Volume: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<SpatialScale>: FromReflect + TypePath,

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

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

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

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

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

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

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

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

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 clone_dynamic(&self) -> DynamicStruct

Clones the struct into a DynamicStruct.

impl TypePath for PlaybackSettings

where PlaybackSettings: Any + Send + Sync,

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

where PlaybackSettings: Any + Send + Sync, PlaybackMode: FromReflect + TypePath, Volume: FromReflect + TypePath, f32: FromReflect + TypePath, bool: FromReflect + TypePath, Option<SpatialScale>: FromReflect + TypePath,

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.

impl Copy for PlaybackSettings