Struct MusicMgr

pub struct MusicMgr {

    soundtrack: SoundtrackCollection<SoundtrackItem>,
    began_playing: Option<ClockTime>,
    song_end: Option<ClockTime>,
    is_gap: bool,
    gap_length: f32,
    gap_time: f64,
    last_track: String,
    last_combat_track: String,
    last_interrupt_attempt: Option<ClockTime>,
    last_activity: MusicState,
    current_track: String,
    current_artist: String,
    track_length: f32,
    loop_points: Option<(f32, f32)>,
}

Provides methods to control music playback

Fields

soundtrack: SoundtrackCollection<SoundtrackItem>

Collection of all the tracks

began_playing: Option<ClockTime>

Instant at which the current track began playing

song_end: Option<ClockTime>

Instant at which the current track should stop

is_gap: bool

Currently staying silent for gap between tracks

gap_length: f32

Time until the next track should be played after a track ends

gap_time: f64

Time remaining for gap

last_track: String

The title of the last track played. Used to prevent a track being played twice in a row

last_combat_track: String

last_interrupt_attempt: Option<ClockTime>

Time of the last interrupt (to avoid rapid switching)

last_activity: MusicState

The previous track’s activity kind, for transitions

current_track: String

current_artist: String

track_length: f32

loop_points: Option<(f32, f32)>

Implementations

impl MusicMgr

pub fn new(calendar: &Calendar) -> Self

pub fn maintain( &mut self, audio: &mut AudioFrontend, state: &State, client: &Client, )

Checks whether the previous track has completed. If so, sends a request to play the next (random) track

fn play_random_track( &mut self, audio: &mut AudioFrontend, state: &State, client: &Client, music_state: &MusicState, rng: &mut ThreadRng, ) -> Result<MusicState, String>

fn generate_silence_between_tracks( &self, spacing_multiplier: f32, client: &Client, music_state: &MusicState, rng: &mut ThreadRng, ) -> f32

fn get_current_day_period(is_dark: bool) -> DayPeriod

pub fn current_track(&self) -> String

pub fn current_artist(&self) -> String

pub fn reset_track(&mut self, audio: &mut AudioFrontend)

fn load_soundtrack_items( calendar: &Calendar, ) -> SoundtrackCollection<SoundtrackItem>

Loads default soundtrack if no events are active. Otherwise, attempts to compile and load all active event soundtracks, falling back to default if they are empty.