API Sound.SetVolume

<sidebar>API contents</sidebar> Sets the volume of playbacks for this sound

Parameters

HANDLE Sounds

The handle of the sound object to set the volume for

FLOAT Volume

A value from 0=off to 1=full

Return value

This call does not return a value

Detailed description

This sets the volume for all sounds played through the given channel. The effects are instant - a sound part way through being played will have its volume affected, as will any sounds being queued.

Examples

Calling in a calculation

• Add to a calculation icon:

  ::Sound.SetVolume(sounds, volume)

No additional examples