Struct kira::sound::SoundSettings

pub struct SoundSettings {
    pub id: Option<SoundId>,
    pub default_track: TrackIndex,
    pub cooldown: Option<f64>,
    pub semantic_duration: Option<f64>,
    pub default_loop_start: Option<f64>,
    pub groups: GroupSet,
}

Settings for a Sound.

Fields

id: Option<SoundId>

The unique identifier for the sound.

default_track: TrackIndex

The track instances of this sound will play on by default.

cooldown: Option<f64>

Whether the sound should have a “cool off” period after playing before it can be played again, and if so, the duration of that cool off period.

This is useful to avoid situations where the same sound is played multiple times at the exact same point in time, resulting in the sound being louder than normal.

semantic_duration: Option<f64>

How long the sound is musically.

For example, a recording of a 2-bar drum fill in an echoey cathedral may have 5 seconds of actual drumming and then 10 seconds of reverberations from the building. So even though the audio is 15 seconds long, you might say the music only lasts for 5 seconds.

If set, the semantic duration of the sound will be used as the default end point when looping the sound.

default_loop_start: Option<f64>

Whether the sound should be looped by default, and if so, the point an instance should jump back to when it reaches the end.

groups: GroupSet

The groups this sound belongs to.

Implementations

impl SoundSettings

pub fn new() -> Self

Creates a new SoundSettings with the default settings.

pub fn id(self, id: impl Into<SoundId>) -> Self

Sets the unique identifier for the sound.

pub fn default_track<T: Into<TrackIndex>>(self, track: T) -> Self

Sets the track instances of this sound will play on by default.

pub fn cooldown(self, cooldown: f64) -> Self

Sets the cooldown time of the sound.

pub fn semantic_duration(self, semantic_duration: f64) -> Self

Sets the semantic duration of the sound.

pub fn default_loop_start(self, default_loop_start: f64) -> Self

Sets the default loop start point of the sound.

pub fn groups(self, groups: impl Into<GroupSet>) -> Self

Sets the group this sound belongs to.

Trait Implementations

impl Clone for SoundSettings

fn clone(&self) -> SoundSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SoundSettings

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

Formats the value using the given formatter.

impl Default for SoundSettings

fn default() -> Self

Returns the “default value” for a type.