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

MIX_TrackLooping

Query whether a given track is looping.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

bool MIX_TrackLooping(MIX_Track *track);

Function Parameters

MIX_Track *

track

the track to query.

Return Value

(bool) Returns true if looping, false otherwise.

Remarks

This specifically checks if the track is not stopped (paused or playing), and there is at least one loop remaining. If a track was looping but is on its final iteration of the loop, this will return false.

On various errors (MIX_Init() was not called, the track is NULL), this returns false, but there is no mechanism to distinguish errors from non-looping tracks.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.

---

CategoryAPI, CategoryAPIFunction, CategorySDLMixer

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