Struct AudioManifest 

#[non_exhaustive]
pub struct AudioManifest {
    pub music_fade_ms: u32,
    pub music_fade_in_ms: u32,
    pub music_overlap: bool,
    pub sounds: BTreeMap<String, SoundCue>,
    pub music: BTreeMap<String, MusicCue>,
    pub pools: BTreeMap<String, Vec<String>>,
    pub credits: BTreeMap<String, Credit>,
}

The validated audio manifest. Build it with default() and assign its fields (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.

music_fade_ms: u32

How long a music track fades out on a switch or a stop, in milliseconds (audio.md: 0.5 s, tunable): the default MusicSwitch’s out_ms.

music_fade_in_ms: u32

How long the next track fades in, in milliseconds (0, the file’s default: it starts at full gain): the default switch’s in_ms.

music_overlap: bool

Whether the next track starts as the old one begins to fade (a crossfade) rather than once it has stopped (false, the file’s default): the default switch’s overlap.

sounds: BTreeMap<String, SoundCue>

Sound cues by id.

music: BTreeMap<String, MusicCue>

Music cues by id.

pools: BTreeMap<String, Vec<String>>

Music pools by id: the music cues one is picked from.

credits: BTreeMap<String, Credit>

Credits by id.

Implementations

impl AudioManifest

pub const fn music_switch(&self) -> MusicSwitch

How one music track gives way to the next when a request names no switch: the manifest’s fade-out, fade-in and overlap.

Trait Implementations

impl AssetKind for AudioManifest

const NAME: &'static str = "audio manifest"

What messages call the kind, in lowercase words: "image", "palette".

impl Clone for AudioManifest

fn clone(&self) -> AudioManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AudioManifest

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

Formats the value using the given formatter.

impl Default for AudioManifest

fn default() -> AudioManifest

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for AudioManifest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AudioManifest

impl PartialEq for AudioManifest

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for AudioManifest

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 AudioManifest