NAME¶

Mix_HaltGroup - Halt playing of a group of channels by arbitrary tag.

HEADER FILE¶

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

void Mix_HaltGroup(int tag);

DESCRIPTION¶

This will stop further playback on all channels with a specific tag, until a new chunk is started there.

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

The default tag for a channel is -1.

Any halted channels will have any currently-registered effects deregistered, and will call any callback specified by

Mix_ChannelFinished () before this function returns.

FUNCTION PARAMETERS¶

tag

an arbitrary value, assigned to channels, to search for.

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.