Struct veloren_voxygen::audio::AudioFrontend

pub struct AudioFrontend {

    pub stream: Option<OutputStream>,
    audio_stream: Option<OutputStreamHandle>,
    music_channels: Vec<MusicChannel>,
    ambient_channels: Vec<AmbientChannel>,
    sfx_channels: Vec<SfxChannel>,
    ui_channels: Vec<UiChannel>,
    sfx_volume: f32,
    ambience_volume: f32,
    music_volume: f32,
    master_volume: f32,
    music_spacing: f32,
    listener: Listener,
    pub subtitles_enabled: bool,
    pub subtitles: VecDeque<Subtitle>,
    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

Fields

stream: Option<OutputStream>

audio_stream: Option<OutputStreamHandle>

music_channels: Vec<MusicChannel>

ambient_channels: Vec<AmbientChannel>

sfx_channels: Vec<SfxChannel>

ui_channels: Vec<UiChannel>

sfx_volume: f32

ambience_volume: f32

music_volume: f32

master_volume: f32

music_spacing: f32

listener: Listener

subtitles_enabled: bool

subtitles: VecDeque<Subtitle>

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

Construct with given device

pub fn no_audio() -> Self

Construct in no-audio mode for debugging

pub fn maintain(&mut self, dt: Duration)

Drop any unused music channels, and update their faders

fn get_sfx_channel(&mut self) -> Option<&mut SfxChannel>

Retrive an empty sfx channel from the list

fn get_ui_channel(&mut self) -> Option<&mut UiChannel>

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

fn get_music_channel( &mut self, next_channel_tag: MusicChannelTag ) -> Option<&mut MusicChannel>

Retrieve a music channel from the channel list. This inspects the MusicChannelTag to determine whether we are transitioning between music types and acts accordingly. For example transitioning between TitleMusic and Exploration should fade out the title channel and fade in a new Exploration channel.

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

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

Play an sfx file given the position, SfxEvent, and whether it is underwater or not

pub fn emit_filtered_sfx( &mut self, trigger_item: Option<(&SfxEvent, &SfxTriggerItem)>, position: Vec3<f32>, volume: Option<f32>, freq: Option<u32>, underwater: bool )

Play a sfx file given its position, SfxEvent, and volume with a low-pass filter at the given frequency

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

Plays a sfx using a non-spatial sink at the given volume; doesn’t need a position Passing no volume will default to 1.0

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

fn play_ambient( &mut self, channel_tag: AmbientChannelTag, sound: &str, volume: Option<f32> )

Plays a file at a given volume in the channel with a given tag

fn new_ambient_channel(&mut self, channel_tag: AmbientChannelTag)

Adds a new ambient channel of the given tag at zero volume

fn get_ambient_channel( &mut self, channel_tag: AmbientChannelTag ) -> Option<&mut AmbientChannel>

Retrieves the channel currently having the given tag If no channel with the given tag is found, returns None

fn get_ambient_channel_index( &self, channel_tag: AmbientChannelTag ) -> Option<usize>

Retrieves the index of the channel having the given tag in the array of ambient channels This is used for times when borrowing becomes difficult If no channel with the given tag is found, returns None

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

pub fn get_listener(&self) -> &Listener

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_sfx_volume(&self) -> f32

Retrieves the current setting for sfx volume

pub fn get_ambience_volume(&self) -> f32

Retrieves the current setting for ambience volume

pub fn get_music_volume(&self) -> f32

Retrieves the current setting for music volume

pub fn sfx_enabled(&self) -> bool

pub fn ambience_enabled(&self) -> bool

pub fn music_enabled(&self) -> bool

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

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

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

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 master volume in all channels

pub fn stop_all_ambience(&mut self)

pub fn stop_all_music(&mut self)

pub fn stop_all_sfx(&mut self)