Struct veloren_voxygen::audio::channel::AmbienceChannel

pub struct AmbienceChannel {
    tag: AmbienceChannelTag,
    target_volume: f32,
    track: TrackHandle,
    filter: FilterHandle,
    source: Option<AnySoundHandle>,
    pub looping: bool,
}

An AmbienceChannel uses a non-positional audio sink designed to play sounds which are always heard at the camera’s position.

Fields

tag: AmbienceChannelTag

target_volume: f32

track: TrackHandle

filter: FilterHandle

source: Option<AnySoundHandle>

looping: bool

Implementations

impl AmbienceChannel

pub fn new( tag: AmbienceChannelTag, init_volume: f32, manager: &mut AudioManager, parent_track: TrackId, looping: bool, ) -> Result<Self, ResourceLimitReached>

pub fn set_source(&mut self, source_handle: Option<AnySoundHandle>)

pub fn stop(&mut self, duration: Option<f32>, delay: Option<f32>)

Stop whatever is playing on this channel with an optional fadeout and delay

pub fn fade_to(&mut self, volume: f32, duration: f32)

Set the channel to a volume, fading over a given duration

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

Set the cutoff for the lowpass filter on this channel

pub fn set_looping(&mut self, loops: bool)

Set whether this channel’s sound loops or not

pub fn get_source(&mut self) -> Option<&mut AnySoundHandle>

pub fn get_track(&self) -> &TrackHandle

Get an immutable reference to the channel’s track for purposes of setting the output destination of a sound

pub fn get_track_mut(&mut self) -> &mut TrackHandle

Get a mutable reference to the channel’s track

pub fn get_target_volume(&self) -> f32

Get the volume of this channel. The volume may be in the process of being faded to.

pub fn get_tag(&self) -> AmbienceChannelTag

pub fn set_tag(&mut self, tag: AmbienceChannelTag)

pub fn is_active(&self) -> bool

pub fn is_stopped(&self) -> bool

Trait Implementations

impl Debug for AmbienceChannel

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

Formats the value using the given formatter.