Get the global sound and music volume for a specific listener.



Argument Description
listenerIndex The index of the listener to get the gain of.

Returns: Real


With this function you can get the absolute value for the global volume of all sounds and music for a specific listener. The default listener index is 0, but you can use the function audio_get_listener_info to get the different indices available for the target platform. The gain value returned is based on a linear scale from 0 (silent) to 1 (full volume).


var num = audio_get_listener_count();
for( var i = 0; i < num; ++i;)
   var info = audio_get_listener_info(i);
   var ind = info[? "index"];
   if audio_get_master_gain(ind) != 1
      audio_set_master_gain(info[? "index"], 1);

The above code loops through the available listeners, checking to see if their gain is 1 or not, and if it is not it sets it to 1 for each of them.

Back: Audio
Next: audio_channel_num
© Copyright YoYo Games Ltd. 2018 All Rights Reserved