NAME¶

Mix_HaltChannel - Halt playing of a particular channel.

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

int Mix_HaltChannel(int channel);

DESCRIPTION¶

This will stop further playback on that channel until a new chunk is started there.

Specifying a channel of -1 will halt _all_ channels, except for any playing music.

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

Mix_ChannelFinished () before this function returns.

You may not specify MAX_CHANNEL_POST for a channel.

FUNCTION PARAMETERS¶

channel

channel to halt, or -1 to halt all channels.

RETURN VALUE¶

Returns 0 on success, or -1 on error.

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.