Struct kira::sound::static_sound::StaticSoundSettings

#[non_exhaustive]
pub struct StaticSoundSettings {
    pub start_time: StartTime,
    pub start_position: f64,
    pub volume: Volume,
    pub playback_rate: PlaybackRate,
    pub panning: f64,
    pub reverse: bool,
    pub loop_behavior: Option<LoopBehavior>,
    pub track: TrackId,
    pub fade_in_tween: Option<Tween>,
}

Settings for a static sound.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

start_time: StartTime

When the sound should start playing.

start_position: f64

The initial playback position of the sound (in seconds).

volume: Volume

The volume of the sound.

playback_rate: PlaybackRate

The playback rate of the sound.

Changing the playback rate will change both the speed and the pitch of the sound.

panning: f64

The panning of the sound, where 0 is hard left and 1 is hard right.

reverse: bool

Whether the sound should play in reverse.

If set to true, the start position will be relative to the end of the sound.

loop_behavior: Option<LoopBehavior>

The looping behavior of the sound.

track: TrackId

The mixer track this sound should play on.

fade_in_tween: Option<Tween>

An optional fade-in from silence.

Implementations

impl StaticSoundSettings

pub fn new() -> Self

Creates a new StaticSoundSettings with the default settings.

pub fn start_time(self, start_time: impl Into<StartTime>) -> Self

Sets when the sound should start playing.

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

Sets the initial playback position of the sound (in seconds).

pub fn volume(self, volume: impl Into<Volume>) -> Self

Sets the volume of the sound.

pub fn playback_rate(self, playback_rate: impl Into<PlaybackRate>) -> Self

Sets the playback rate of the sound.

Changing the playback rate will change both the speed and the pitch of the sound.

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

Sets the panning of the sound, where 0 is hard left and 1 is hard right.

pub fn reverse(self, reverse: bool) -> Self

Sets whether the sound should play in reverse.

pub fn loop_behavior(
    self,
    loop_behavior: impl Into<Option<LoopBehavior>>
) -> Self

Sets the looping behavior of the sound.

pub fn track(self, track: impl Into<TrackId>) -> Self

Sets the mixer track this sound should play on.

pub fn fade_in_tween(self, fade_in_tween: impl Into<Option<Tween>>) -> Self

Sets the tween used to fade in the sound from silence.

Trait Implementations

impl Clone for StaticSoundSettings

fn clone(&self) -> StaticSoundSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StaticSoundSettings

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

Formats the value using the given formatter.

impl Default for StaticSoundSettings

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<StaticSoundSettings> for StaticSoundSettings

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for StaticSoundSettings

impl StructuralPartialEq for StaticSoundSettings