Struct SamplePlayer 

pub struct SamplePlayer {
    pub sample: Handle<AudioSample>,
    pub repeat_mode: RepeatMode,
    pub volume: Volume,
}

A component that queues sample playback.

Playing sounds

Playing a sound is very simple!

fn play_sound(mut commands: Commands, server: Res<AssetServer>) {
    commands.spawn(SamplePlayer::new(server.load("my_sample.wav")));
}

This queues playback in a SamplerPool. When no effects are applied, samples are played in the DefaultPool.

The SamplePlayer component includes two fields that cannot change during playback: repeat_mode and volume. Because SamplePlayer is immutable, these can only be changed by re-inserting, which subsequently stops and restarts playback. To update a sample’s volume dynamically, consider adding a VolumeNode as an effect.

Lifecycle

By default, entities with a SamplePlayer component are despawned when playback completes. If you insert SamplePlayer components on gameplay entities such as the player or enemies, you’ll probably want to set PlaybackSettings::on_complete to OnComplete::Remove or even OnComplete::Preserve.

#[derive(Component)]
struct Player;

fn play_sound_on_player(
    player: Single<Entity, With<Player>>,
    server: Res<AssetServer>,
    mut commands: Commands,
) {
    commands.entity(*player).insert((
        SamplePlayer::new(server.load("my_sample.wav")),
        PlaybackSettings::default().remove(),
    ));
}

Applying effects

Effects can be applied directly to a sample entity with SampleEffects.

fn play_with_effects(mut commands: Commands, server: Res<AssetServer>) {
    commands.spawn((
        SamplePlayer::new(server.load("my_sample.wav")),
        sample_effects![
            SpatialBasicNode::default(),
            LowPassNode { frequency: 500.0 }
        ],
    ));
}

In the above example, we connect a spatial and low-pass node in series with the sample player. Effects are arranged in the order they’re spawned, so the output of the spatial node is connected to the input of the low-pass node.

When you apply effects to a sample player, the node components are added using the SampleEffects relationships. If you want to access the effects in terms of the sample they’re applied to, you can break up your queries and use the EffectsQuery trait.

commands.spawn((
    // We'll look for sample player entities with the name "dynamic"
    Name::new("dynamic"),
    SamplePlayer::new(server.load("my_sample.wav")),
    sample_effects![VolumeNode::default()],
));

fn update_volume(
    sample_players: Query<(&Name, &SampleEffects)>,
    mut volume: Query<&mut VolumeNode>,
) -> Result {
    for (name, effects) in &sample_players {
        if name.as_str() == "dynamic" {
            // Once we've found the target entity, we can get at
            // its effects with `EffectsQuery`
            volume.get_effect_mut(effects)?.volume = Volume::Decibels(-6.0);
        }
    }

    Ok(())
}

Applying effects directly to a SamplePlayer is simple, but it has some tradeoffs, so you may find yourself gravitating towards manually defined SamplerPools as your requirements grow.

Supporting components

A SamplePlayer can be spawned with a number of components:

• Any component that implements PoolLabel
• PlaybackSettings
• SamplePriority
• SampleQueueLifetime
• SampleEffects

Altogether, that would look like:

commands.spawn((
    DefaultPool,
    SamplePlayer {
        sample: server.load("my_sample.wav"),
        repeat_mode: RepeatMode::PlayOnce,
        volume: Volume::UNITY_GAIN,
    },
    PlaybackSettings {
        play: Notify::new(true),
        play_from: PlayFrom::BEGINNING,
        speed: 1.0,
        on_complete: OnComplete::Despawn,
    },
    SamplePriority(0),
    SampleQueueLifetime(std::time::Duration::from_millis(100)),
    sample_effects![SpatialBasicNode::default()],
));

Once a sample has been queued in a pool, the Sampler component will be inserted, which provides information about the playhead position and playback status.

Fields

sample: Handle<AudioSample>

The sample to play.

repeat_mode: RepeatMode

Sets the sample’s RepeatMode.

Defaults to RepeatMode::PlayOnce.

The RepeatMode can only be configured once at the beginning of playback.

volume: Volume

Sets the volume of the sample.

Defaults to Volume::UNITY_GAIN.

This volume can only be configured once at the beginning of playback. For dynamic volume, consider routing to buses or applying VolumeNode as an effect.

Implementations

impl SamplePlayer

pub fn new(handle: Handle<AudioSample>) -> Self

Construct a new SamplePlayer.

fn play_sound(mut commands: Commands, server: Res<AssetServer>) {
    commands.spawn(SamplePlayer::new(server.load("my_sample.wav")));
}

This immediately queues up the sample for playback.

pub fn looping(self) -> Self

Enable looping playback.

fn play_sound(mut commands: Commands, server: Res<AssetServer>) {
    commands.spawn(SamplePlayer::new(server.load("my_sample.wav")).looping());
}

Looping can only be configured once at the beginning of playback.

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

Set the overall sample volume.

fn play_sound(mut commands: Commands, server: Res<AssetServer>) {
    commands.spawn(
        SamplePlayer::new(server.load("my_sample.wav")).with_volume(Volume::Decibels(-6.0)),
    );
}

This volume can only be configured once at the beginning of playback. For dynamic volume, consider routing to buses or applying VolumeNode as an effect.

Trait Implementations

impl Clone for SamplePlayer

fn clone(&self) -> SamplePlayer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for SamplePlayer

where Self: Send + Sync + 'static,

Required Components: PlaybackSettings, SamplePriority, SampleQueueLifetime, QueuedSample, Name.

A component’s Required Components are inserted whenever it is inserted. Note that this will also insert the required components of the required components, recursively, in depth-first order.

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

A constant indicating the storage type used for this component.

type Mutability = Immutable

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 relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

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 SamplePlayer

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

Formats the value using the given formatter.

impl Default for SamplePlayer

fn default() -> Self

Returns the “default value” for a type.

impl FromReflect for SamplePlayer

fn from_reflect(reflect: &dyn PartialReflect) -> Option<Self>

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 SamplePlayer

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 SamplePlayer

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) -> 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<Self>) -> ReflectOwned

Returns an owned enumeration of “kinds” of type.

fn try_into_reflect( self: Box<Self>, ) -> 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>

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

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

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

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

Casts this type to a boxed, reflected value.

fn as_partial_reflect(&self) -> &dyn PartialReflect

Casts this type to a reflected value.

fn as_partial_reflect_mut(&mut self) -> &mut dyn PartialReflect

Casts this type to a mutable, reflected value.

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

Returns a “partial equality” comparison result.

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 debug(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Debug formatter for the value.

fn is_dynamic(&self) -> bool

Indicates whether or not this type is a dynamic type.

impl Reflect for SamplePlayer

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

Returns the value as a Box<dyn Any>.

fn as_any(&self) -> &dyn Any

Returns the value as a &dyn Any.

fn as_any_mut(&mut self) -> &mut dyn Any

Returns the value as a &mut dyn Any.

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

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

fn as_reflect(&self) -> &dyn Reflect

Casts this type to a fully-reflected value.

fn as_reflect_mut(&mut self) -> &mut dyn Reflect

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 SamplePlayer

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

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>

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>

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>

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 SamplePlayer

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 SamplePlayer

fn type_info() -> &'static TypeInfo

Returns the compile-time info for the underlying type.