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

MIX_TrackFramesToMS

Convert sample frames for a track's current format to milliseconds.

Header File

Syntax

Sint64 MIX_TrackFramesToMS(MIX_Track *track, Sint64 frames);

Function Parameters

MIX_Track *	track	the track to query.
Sint64	frames	the track-specific sample frames to convert to milliseconds.

Return Value

(Sint64) Returns Converted number of milliseconds, or -1 for errors/no input; call SDL_GetError() for details.

Remarks

This calculates time based on the track's current input format, which can change when its input does, and also if that input changes formats mid-stream (for example, if decoding a file that is two MP3s concatenated together).

Sample frames are more precise than milliseconds, so out of necessity, this function will approximate by rounding down to the closest full millisecond.

On various errors (MIX_Init() was not called, the track is NULL), this returns -1. If the track has no input, this returns -1. If frames is < 0, this returns -1.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.