Struct veloren_voxygen::audio::channel::MusicChannel

pub struct MusicChannel {
    tag: MusicChannelTag,
    track: Option<TrackHandle>,
    source: Option<AnySoundHandle>,
    length: f32,
    loop_data: (bool, LoopPoint, LoopPoint),
}

A MusicChannel is designed to play music which is always heard at the player’s position.

Fields

tag: MusicChannelTag

track: Option<TrackHandle>

source: Option<AnySoundHandle>

length: f32

loop_data: (bool, LoopPoint, LoopPoint)

Implementations

impl MusicChannel

pub fn new(manager: &mut AudioManager, parent_track: TrackId) -> Self

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

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

pub fn set_length(&mut self, length: f32)

pub fn get_loop_data(&self) -> (bool, LoopPoint, LoopPoint)

pub fn set_loop_data(&mut self, loops: bool, start: LoopPoint, end: LoopPoint)

Sets whether the sound loops, and the start and end points of the loop

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 set_volume(&mut self, volume: f32)

Set the volume of the current channel.

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

Fade to a given amplitude over a given duration, optionally after a delay

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

Fade to silence over a given duration and stop, optionally after a delay Use fade_to() if this fade is temporary

pub fn is_done(&self) -> bool

Returns true if the sound has stopped playing (whether by fading out or by finishing)

pub fn get_tag(&self) -> MusicChannelTag

pub fn get_track(&self) -> Option<&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) -> Option<&mut TrackHandle>

Get a mutable reference to the channel’s track

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

pub fn get_length(&self) -> f32