Scroll to navigation

MIX_TrackPlaying(3) SDL_mixer3 FUNCTIONS MIX_TrackPlaying(3)

NAME

MIX_TrackPlaying - Query if a track is currently playing.

HEADER FILE

Defined in SDL3_mixer/SDL_mixer.h

SYNOPSIS

#include "SDL3_mixer/SDL_mixer.h"
bool MIX_TrackPlaying(MIX_Track *track);

DESCRIPTION

If this returns true, the track is currently contributing to the mixer's output (it's "playing"). It is not stopped nor paused.

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-playing tracks.

FUNCTION PARAMETERS

the track to query.

RETURN VALUE

Returns true if playing, false otherwise.

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL_mixer 3.0.0.

SEE ALSO

(3), MIX_PlayTrack(3), (3), MIX_PauseTrack(3), (3), MIX_ResumeTrack(3), (3), MIX_StopTrack(3), (3), MIX_TrackPaused(3)

SDL_mixer 3.1.0 SDL_mixer