NAME¶

Mix_HaltMusic - Halt playing of the music stream.

SYNOPSIS¶

#include "SDL3_mixer/SDL_mixer.h"

int Mix_HaltMusic(void);

DESCRIPTION¶

This will stop further playback of music until a new music object is started there.

Any halted music will call any callback specified by

Mix_HookMusicFinished () before this function returns.

RETURN VALUE¶

Returns zero, regardless of whether any music was halted.

AVAILABILITY¶

This function is available since SDL_mixer 3.0.0.