audio_group_unload

Unload an audio group from memory.

Syntax:

audio_group_unload(groupID);


Argument Description
groupID The index of the audio group to unload (as defined in the Global Game Settings Audio Groups Tab)


Returns: Boolean


Description

This function will unload all the sounds that are flagged as belonging to the given Audio Group into memory. The function will return true if unloading is initiated and false if the group ID is invalid, or it has already been flagged for unloading. Note that any audio currently being played when this function is called will be stopped.


Example:

if audio_group_is_loaded(audiogroup_level1)
   {
   audio_group_unload(audiogroup_level1);
   }

The above code checks to see if an audio group has been loaded and if it has it unloads it.


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