Struct veloren_voxygen::audio::AudioFrontend

pub struct AudioFrontend {
    inner: Option<AudioFrontendInner>,
    pub subtitles_enabled: bool,
    pub subtitles: VecDeque<Subtitle>,
    volumes: Volumes,
    music_spacing: f32,
    pub combat_music_enabled: bool,
    mtm: AssetHandle<MusicTransitionManifest>,
}

Holds information about the system audio devices and internal channels used for sfx and music playback. An instance of AudioFrontend is used by Voxygen’s GlobalState to provide access to devices and playback control in-game

TODO: Use a listener struct (like the one commented out above) instead of keeping all listener data in the AudioFrontend struct. Will be helpful when we do more with spatial audio.

Fields

inner: Option<AudioFrontendInner>

subtitles_enabled: bool

subtitles: VecDeque<Subtitle>

volumes: Volumes

music_spacing: f32

combat_music_enabled: bool

mtm: AssetHandle<MusicTransitionManifest>

Implementations

impl AudioFrontend

pub fn new( num_sfx_channels: usize, num_ui_channels: usize, subtitles: bool, combat_music_enabled: bool, ) -> Self

pub fn no_audio() -> Self

Construct in no-audio mode for debugging

pub fn maintain(&mut self)

Drop any unused music channels

pub fn get_clock(&self) -> Option<&ClockHandle>

pub fn get_clock_time(&self) -> Option<ClockTime>

pub fn get_num_active_channels(&self) -> ActiveChannels

Returns [music channels, ambience channels, sfx channels, ui channels]

fn play_music(&mut self, sound: &str, channel_tag: MusicChannelTag, length: f32)

Play a music file with the given tag. Pass in the length of the track in seconds.

pub fn set_loop(&mut self, channel_tag: MusicChannelTag, sound_loops: bool)

Turn on or off looping

pub fn set_loop_points( &mut self, channel_tag: MusicChannelTag, start: f32, end: f32, )

Loops music from start point to end point in seconds

pub fn set_ambience_master_filter(&mut self, frequency: u32)

Set the cutoff of the filter affecting all spatial sfx

pub fn get_sfx_file<'a>( trigger_item: Option<(&'a SfxEvent, &'a SfxTriggerItem)>, ) -> Option<(&'a str, f32, Option<&'a str>)>

Find sound based on given trigger_item. Randomizes if multiple sounds are found. Errors if no sounds are found. Returns (file, threshold, subtitle)

pub fn set_sfx_master_filter(&mut self, frequency: u32)

Set the cutoff of the filter affecting all spatial sfx

pub fn emit_sfx( &mut self, trigger_item: Option<(&SfxEvent, &SfxTriggerItem)>, position: Vec3<f32>, volume: Option<f32>, )

Play an sfx file given the position and SfxEvent at the given volume (default 1.0)

pub fn emit_ui_sfx( &mut self, trigger_item: Option<(&SfxEvent, &SfxTriggerItem)>, volume: Option<f32>, )

Plays a sfx non-spatially at the given volume (default 1.0); doesn’t need a position

pub fn emit_subtitle( &mut self, subtitle: Option<&str>, position: Option<Vec3<f32>>, duration: f32, )

Push a subtitle to the subtitle queue

pub fn play_ambience_looping( &mut self, channel_tag: AmbienceChannelTag, sound: &str, )

Plays an ambience sound that loops in the channel with a given tag

pub fn play_ambience_oneshot( &mut self, channel_tag: AmbienceChannelTag, trigger_item: Option<(&SfxEvent, &SfxTriggerItem)>, volume: Option<f32>, delay: Option<f32>, )

Plays an ambience sound once at the given volume after the given delay. Make sure it uses a channel tag that does not change the volume of its channel. Currently, ambience oneshots use the Sfx file system

pub fn set_listener_pos(&mut self, pos: Vec3<f32>, ori: Vec3<f32>)

pub fn get_listener(&mut self) -> Option<&mut ListenerHandle>

pub fn get_listener_pos(&self) -> Vec3<f32>

pub fn get_listener_ori(&self) -> Vec3<f32>

pub fn play_title_music(&mut self)

Switches the playing music to the title music, which is pinned to a specific sound file (veloren_title_tune.ogg)

pub fn get_music_volume(&self) -> f32

Retrieves the current setting for music volume

pub fn get_ambience_volume(&self) -> f32

Retrieves the current setting for ambience volume

pub fn get_sfx_volume(&self) -> f32

Retrieves the current setting for sfx volume

pub fn music_enabled(&self) -> bool

Returns false if volume is 0 or the mute is on

pub fn ambience_enabled(&self) -> bool

Returns false if volume is 0 or the mute is on

pub fn sfx_enabled(&self) -> bool

Returns false if volume is 0 or the mute is on

pub fn set_music_volume(&mut self, music_volume: f32)

pub fn set_ambience_volume(&mut self, ambience_volume: f32)

pub fn set_sfx_volume(&mut self, sfx_volume: f32)

Sets the volume for both spatial sfx and UI (might separate these controls later)

pub fn set_music_spacing(&mut self, multiplier: f32)

pub fn set_subtitles(&mut self, enabled: bool)

pub fn set_master_volume(&mut self, master_volume: f32)

Updates volume of the master track

pub fn stop_all_ambience(&mut self)

pub fn stop_all_music(&mut self)

pub fn stop_all_sfx(&mut self)

pub fn get_num_music_channels(&self) -> usize

pub fn get_num_ambience_channels(&self) -> usize