Enum MusicCommand 

pub enum MusicCommand {
    Load {
        cue: String,
    },
    #[non_exhaustive]
    Start {
        cue: String,
        gain: f32,
    },
    Gain {
        cue: String,
        gain: f32,
    },
    Stop {
        cue: String,
    },
}

What the platform must do to the music this frame. A track is loaded, started, has its volume changed and is stopped, which also unloads it.

Variants

Load

Start loading cue’s file; it will be started soon.

Fields

cue: String

The music cue.

#[non_exhaustive]

Start

Play cue (loaded earlier) from the start at gain, looped if the manifest says so. If it isn’t loaded yet, play it once it is. Build it with MusicCommand::start (ADR-0039).

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

cue: String

The music cue.

gain: f32

The gain it starts at (0–1, a multiplier on its manifest volume): 1 for a track that starts at full gain, 0 for one that fades in.

Gain

Set cue’s gain (0–1, a multiplier on its manifest volume).

Fields

cue: String

The music cue.

gain: f32

The new gain.

Stop

Stop cue and free it (also cancels a load).

Fields

cue: String

The music cue.

Implementations

impl MusicCommand

pub fn start(cue: impl Into<String>, gain: f32) -> Self

A Start of cue at gain.

Trait Implementations

impl Clone for MusicCommand

fn clone(&self) -> MusicCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MusicCommand

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

Formats the value using the given formatter.

impl PartialEq for MusicCommand

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for MusicCommand

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for MusicCommand