Mix_GroupChannels

Assign several consecutive channels to the same tag.

Header File

bool Mix_GroupChannels(int from, int to, int tag);

int	from	the first channel to set the tag on.
int	to	the last channel to set the tag on, inclusive.
int	tag	an arbitrary value to assign a channel.

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

A tag is an arbitrary number that can be assigned to several mixer channels, to form groups of channels.

If 'tag' is -1, the tag is removed (actually -1 is the tag used to represent the group of all the channels).

This function replaces the requested channels' current tags; you may only have one tag per channel.

You may not specify MAX_CHANNEL_POST for a channel.

Note that this returns success and failure in the opposite way from Mix_GroupChannel(). We regret the API design mistake.

This function is available since SDL_mixer 3.0.0.