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

MIX_PauseTag

Pause all tracks with a specific tag.

Header File

Syntax

bool MIX_PauseTag(MIX_Mixer *mixer, const char *tag);

Function Parameters

MIX_Mixer *	mixer	the mixer on which to pause tracks.
const char *	tag	the tag to use when searching for tracks.

Return Value

(bool) Returns true on success, false on error; call SDL_GetError() for details.

Remarks

A paused track is not considered "stopped," so its MIX_TrackStoppedCallback will not fire if paused, but it won't change state by default, generate audio, or generally make progress, until it is resumed.

This function makes all currently-playing tracks on the specified mixer, with a specific tag, move to a paused state. They can later be resumed.

Tracks that match the specified tag that aren't currently playing are ignored.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.