Struct AudioSourceComponent 

pub struct AudioSourceComponent {

    pub audio_ref: Option<String>,
    pub volume: f32,
    pub looping: bool,
    pub playing: bool,
    pub paused: bool,
    pub spatial: bool,
    pub bus: AudioBus,
    pub min_distance: f32,
    pub max_distance: f32,
    pub reverb_zones: Vec<(String, f32)>,
    pub random_clips: Vec<String>,
    pub random_pick: bool,
    pub playback_rate: f64,
}

Fields

audio_ref: Option<String>

volume: f32

looping: bool

playing: bool

paused: bool

When true while playing is also true, the running sound is held at its current position. Clearing it resumes from where it stopped, unlike playing = false, which frees the sound and restarts from the beginning.

spatial: bool

bus: AudioBus

min_distance: f32

max_distance: f32

reverb_zones: Vec<(String, f32)>

random_clips: Vec<String>

Optional list of additional clip paths. When non-empty and random_pick is true, the audio system selects one of audio_ref + random_clips at random each time playback transitions from stopped to playing. Useful for footstep packs, random stingers, or one-shot scares.

random_pick: bool

When true, the source treats audio_ref plus random_clips as a pool and chooses one at random when starting playback.

playback_rate: f64

Playback rate factor applied when the sound starts. 1.0 plays at the original pitch and speed. 2.0 plays an octave higher and twice as fast. 0.5 plays an octave lower and at half speed.

Implementations

impl AudioSource

pub fn new(audio_ref: impl Into<String>) -> AudioSource

pub fn with_volume(self, volume: f32) -> AudioSource

pub fn with_looping(self, looping: bool) -> AudioSource

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

pub fn with_bus(self, bus: AudioBus) -> AudioSource

pub fn with_distance(self, min: f32, max: f32) -> AudioSource

pub fn with_reverb(self, reverb: bool) -> AudioSource

pub fn with_reverb_zone( self, zone: impl Into<String>, send_decibels: f32, ) -> AudioSource

pub fn playing(self) -> AudioSource

pub fn with_paused(self, paused: bool) -> AudioSource

pub fn with_playback_rate(self, rate: f64) -> AudioSource

Trait Implementations

impl Clone for AudioSource

fn clone(&self) -> AudioSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioSource

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

Formats the value using the given formatter.

impl Default for AudioSource

fn default() -> AudioSource

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioSource

fn deserialize<__D>( __deserializer: __D, ) -> Result<AudioSource, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for AudioSource

fn eq(&self, other: &AudioSource) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Schema for AudioSource

fn schema() -> Value

impl Serialize for AudioSource

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AudioSource