NAME¶

Mix_GroupChannel - Assign a tag to a channel.

HEADER FILE¶

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

bool Mix_GroupChannel(int which, int tag);

DESCRIPTION¶

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 channel's current tag; you may only have one tag per channel.

You may not specify MAX_CHANNEL_POST for a channel.

FUNCTION PARAMETERS¶

which

the channel to set the tag on.

tag

an arbitrary value to assign a channel.

RETURN VALUE¶

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

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.