SDL Wiki
[ front page | index | search | recent changes | git repo | offline html ]
(This function is part of SDL_mixer, a separate library from SDL.)

MIX_FramesToMS

Convert sample frames, at a specific sample rate, to milliseconds.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

Sint64 MIX_FramesToMS(int sample_rate, Sint64 frames);

Function Parameters

int sample_rate the sample rate to use for conversion.
Sint64 frames the rate-specific sample frames to convert to milliseconds.

Return Value

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

Remarks

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

If sample_rate is <= 0, 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.

See Also


CategoryAPI, CategoryAPIFunction, CategorySDLMixer


[ edit | delete | history | feedback | raw ]

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