.\" 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_ExpireChannel:
.\"   https://wiki.libsdl.org/SDL_mixer/Mix_ExpireChannel
.\" 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_ExpireChannel
.\" 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_ExpireChannel 3 "SDL_mixer 3.0.0" "SDL_mixer" "SDL_mixer3 FUNCTIONS"
.SH NAME
Mix_ExpireChannel \- Change the expiration delay for a particular channel\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3_mixer/SDL_mixer.h\(dq
.PP
.BI "int Mix_ExpireChannel(int channel, int ticks);
.fi
.SH DESCRIPTION
The channel will halt after the 'ticks' milliseconds have elapsed, or
remove the expiration if 'ticks' is -1\[char46]

This overrides the value passed to the fourth parameter of

.BR Mix_PlayChannelTimed
()\[char46]

Specifying a channel of -1 will set an expiration for _all_ channels\[char46]

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

.BR Mix_ChannelFinished
() once the halt occurs\[char46]

Note that this function does not block for the number of ticks requested;
it just schedules the chunk to expire and notes the time for the mixer to
manage later, and returns immediately\[char46]

.SH FUNCTION PARAMETERS
.TP
.I channel
the channel to change the expiration time on\[char46]
.TP
.I ticks
number of milliseconds from now to let channel play before halting, -1 to not halt\[char46]
.SH RETURN VALUE
Returns the number of channels that changed expirations\[char46]

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