Struct bevy_retrograde_audio::PlaySoundSettings

pub struct PlaySoundSettings {
    pub id: Option<InstanceId>,
    pub volume: Value<f64>,
    pub playback_rate: Value<f64>,
    pub panning: Value<f64>,
    pub start_position: f64,
    pub reverse: bool,
    pub fade_in_tween: Option<Tween>,
    pub loop_start: InstanceLoopStart,
    pub track: InstanceTrackIndex,
}

Settings for an instance.

Fields

id: Option<InstanceId>

The unique identifier for the instance.

volume: Value<f64>

The volume of the instance.

playback_rate: Value<f64>

The playback rate of the instance, as a factor of the original playback rate.

panning: Value<f64>

The panning of the instance (0 = hard left, 1 = hard right).

start_position: f64

The position to start playing the instance at (in seconds).

reverse: bool

Whether to play the instance in reverse.

fade_in_tween: Option<Tween>

Whether to fade in the instance from silence, and if so, the tween to use.

loop_start: InstanceLoopStart

Whether the instance should loop, and if so, the position it should jump back to when it reaches the end.

track: InstanceTrackIndex

Which track to play the instance on.

Implementations

impl InstanceSettings

pub fn new() -> InstanceSettings

Creates a new InstanceSettings with the default settings.

pub fn id(self, id: impl Into<InstanceId>) -> InstanceSettings

Sets the unique identifier for the instance.

pub fn volume<V>(self, volume: V) -> InstanceSettings where
    V: Into<Value<f64>>, 

Sets the volume of the instance.

pub fn playback_rate<P>(self, playback_rate: P) -> InstanceSettings where
    P: Into<Value<f64>>, 

Sets the playback rate of the instance.

pub fn panning<P>(self, panning: P) -> InstanceSettings where
    P: Into<Value<f64>>, 

Sets the panning of the instance.

pub fn start_position(self, start_position: f64) -> InstanceSettings

Sets where in the sound playback will start (in seconds).

pub fn reverse(self) -> InstanceSettings

Play the instance in reverse.

pub fn fade_in_tween(self, fade_in_tween: Tween) -> InstanceSettings

Sets the tween the instance will use to fade in from silence.

pub fn loop_start<S>(self, start: S) -> InstanceSettings where
    S: Into<InstanceLoopStart>, 

Sets the portion of the sound that should be looped.

pub fn track<T>(self, track: T) -> InstanceSettings where
    T: Into<InstanceTrackIndex>, 

Sets the track the instance will play on.

Trait Implementations

impl Clone for InstanceSettings

pub fn clone(&self) -> InstanceSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InstanceSettings

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

Formats the value using the given formatter.

impl Default for InstanceSettings

pub fn default() -> InstanceSettings

Returns the “default value” for a type.

impl Copy for InstanceSettings