audio_sound_get_gain


Description

This function will return the current gain value for the given sound. The sound can either be one referenced from an index for an individual sound being played which has been stored in a variable when using the audio_play_sound or audio_play_sound_at functions, or an actual sound asset from the resource tree. Gain is usually calculated as a value from 0 to 1, but on some platforms you can have a gain of greater than 1, although a value of 1 is considered "full volume" and anything greater may introduce audio clipping.


Syntax:

audio_sound_get_gain(index);


Argument Description
index The index of the sound to get the gain of.


Returns:

Real


Example:

if audio_sound_get_gain(snd_Music) != 1
   {
   audio_sound_gain(snd_Music, 1, 0);
   }

The above code will change the gain of the audio played from the sound indexed as "snd_Music" if its gain is not equal to 1.