.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL_mixer's wiki page for Mix_HaltGroup:
.\"   https://wiki.libsdl.org/SDL_mixer/Mix_HaltGroup
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\"  revision 3~git20240319~12fb85e+ds-1
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20Mix_HaltGroup
.\" SDL_mixer can be found at https://libsdl.org/projects/SDL_mixer
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH Mix_HaltGroup 3 "SDL_mixer 3.0.0" "SDL_mixer" "SDL_mixer3 FUNCTIONS"
.SH NAME
Mix_HaltGroup \- Halt playing of a group of channels by arbitrary tag\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3_mixer/SDL_mixer.h\(dq
.PP
.BI "int Mix_HaltGroup(int tag);
.fi
.SH DESCRIPTION
This will stop further playback on all channels with a specific tag, until
a new chunk is started there\[char46]

A tag is an arbitrary number that can be assigned to several mixer
channels, to form groups of channels\[char46]

The default tag for a channel is -1\[char46]

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

.BR Mix_ChannelFinished
() before this function returns\[char46]

.SH FUNCTION PARAMETERS
.TP
.I tag
an arbitrary value, assigned to channels, to search for\[char46]
.SH RETURN VALUE
Returns zero, whether any channels were halted or not\[char46]

.SH AVAILABILITY
This function is available since SDL_mixer 3\[char46]0\[char46]0\[char46]