(This function is part of SDL_mixer, a separate library from SDL.)

Mix_HaltMusic

Halt playing of the music stream.

Header File

Defined in <SDL_mixer.h>

Syntax

int Mix_HaltMusic(void);

Return Value

(int) Returns zero, regardless of whether any music was halted.

Remarks

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.

Version

This function is available since SDL_mixer 2.0.0.

---

CategoryAPI, CategoryAPIFunction

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.