Struct MusicSwitch 

#[non_exhaustive]
pub struct MusicSwitch {
    pub out_ms: u32,
    pub in_ms: u32,
    pub overlap: bool,
}

How one music track gives way to the next (ADR-0054): the old one fades out over out_ms, and the new one fades in over in_ms, starting as the old one begins to fade (overlap, a crossfade) or once it has stopped. Build it with new, after_fade or crossfade (ADR-0039).

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.

out_ms: u32

How long the old track fades out, in milliseconds.

in_ms: u32

How long the new track fades in, in milliseconds (0: it starts at full gain).

overlap: bool

Whether the new track starts when the old one begins to fade (a crossfade), or after it has stopped.

Implementations

impl MusicSwitch

pub const fn new(out_ms: u32, in_ms: u32, overlap: bool) -> MusicSwitch

A fade-out of out_ms, a fade-in of in_ms, overlapping or not.

pub const fn after_fade(out_ms: u32) -> MusicSwitch

The old track fades out over out_ms, then the new one starts at full gain: the engine’s switch before crossfades.

pub const fn crossfade(ms: u32) -> MusicSwitch

A crossfade: the new track fades in over ms while the old one fades out over the same time.

Trait Implementations

impl Clone for MusicSwitch

fn clone(&self) -> MusicSwitch

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for MusicSwitch

impl Debug for MusicSwitch

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

Formats the value using the given formatter.

impl Eq for MusicSwitch

impl PartialEq for MusicSwitch

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for MusicSwitch