API Reference / Audio / audSetMusicVolume

audSetMusicVolume

Sets the volume of playing music. Takes music (music handle from audLoadMusic), volume (0.0 to 1.0). Returns nothing.

Audio

Parameters & Returns

Parameters

music Int
volume Double

Returns

Void

Quick Summary

Sets the volume of playing music. Takes music (music handle from audLoadMusic), volume (0.0 to 1.0). Returns nothing.

Technical Exegesis...

Sets the music's volume, from 0.0 (silent) to 1.0 (full). It takes effect straight away. Set it after audPlayMusic: a new play starts at full volume.

The music functions (audStopMusic, audPauseMusic, audResumeMusic, audSetMusicVolume, audSetMusicPan, audMusicPlaying) take the music handle from audLoadMusic and act on that music's latest audPlayMusic or audPlayMusic3D. The channel audPlayMusic returned works too. This is the same on every target.

Example

Example.bam 
audPlayMusic(music)
audSetMusicVolume(music, 0.5)
Since: 1.0 Status: Stable
← Back to Audio