ActionScript for Flash MX: The Definitive Guide, Second Edition

soundObject.setVolume(volume)

Arguments

volume

A number indicating the loudness of the sound controlled by soundObject, where 0 is no volume (mute). The larger volume's absolute value (regardless of whether volume is positive or negative), the louder the sounds controlled by soundObject will be. For example, -50 is the same volume as 50. The default value for volume is 100.

Description

The setVolume( ) method makes the sounds controlled by soundObject louder or softer. To entirely mute a sound, use a volume of 0. To make a sound louder, increase volume's absolute value. Values in the range of 100-200 are generally quite loud, but there is no predefined maximum.

Note that setVolume( ) affects all the sounds controlled by soundObject. If soundObject is a global sound, setVolume( ) affects all the sounds in a movie. If soundObject is tied to a clip or a main timeline, setVolume( ) affects all the sounds in that clip or timeline.

The volume set by setVolume( ) remains in effect until it is overridden by another setVolume( ) call. A setVolume( ) assignment affects all future sounds controlled by soundObject, even if soundObject is deleted.

Example

This first example simply sets the volume of a movie clip named theClip_mc:

var mySound = new Sound(theClip_mc); mySound.setVolume (65);

The following example shows how to make buttons that adjust a movie's volume level:

var globalSound = new Sound(); var maxVolume = 200; var minVolume = 0; var volumeIncrement = 20; volumeUp_btn.onRelease = function () { globalSound.setVolume(Math.min(globalSound.getVolume() + volumeIncrement, maxVolume)); } volumeDown_btn.onRelease = function () { globalSound.setVolume(Math.max(globalSound.getVolume() - volumeIncrement, minVolume)); }

See Also

Sound.getVolume( ), Sound.stop( ), Sound.stopAllSounds( )