Audio

Overview

The audio module provides methods for playing back project's audio files.

Plays an audio file from your project's audio directory,

audio::play(name: &str);

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to play.

Returns true if the given audio track is currently being played.

audio::is_playing(name: &str) -> bool

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset check.

Pauses the given audio track.

audio::pause(name: &str)

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to pause.

Stops the given audio track and resets its progress to the beginning.

audio::stop(name: &str)

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to stop.

Gets the current volume of the sound identified by name, expressed as a percentage (0.0 to 1.0).

audio::get_volume(name: &str) -> f32

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to get the volume of.

Sets the volume of the sound identified by name, using a 0.0 to 1.0 linear scale.

audio::set_volume(name: &str, volume: f32)

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to set the volume of.
`volume`	`f32`		Percentage of max volume (between 0.0-1.0)

Mutes the sound identified by name.

audio::mute(name: &str)

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to mute.

Returns true if the sound identified by name is currently muted.

audio::is_muted(name: &str) -> bool

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to check if muted.

Resets the sound's volume to the last volume before it was muted.

audio::unmute(name: &str)

Param	Type	Default	Description
`name`	`&str`		The name of the audio asset to unmute.