Scroll to navigation

Mix_GroupChannel(3) SDL_mixer3 FUNCTIONS Mix_GroupChannel(3)

NAME

Mix_GroupChannel - Assign a tag to a channel.

SYNOPSIS

#include "SDL3_mixer/SDL_mixer.h"
int 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

the channel to set the tag on.
an arbitrary value to assign a channel.

RETURN VALUE

Returns non-zero on success, zero on error (no such channel).

AVAILABILITY

This function is available since SDL_mixer 3.0.0.

SDL_mixer 3.0.0 SDL_mixer