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_AudioMSToFrames

Convert milliseconds to sample frames for a MIX_Audio's format.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

Sint64 MIX_AudioMSToFrames(MIX_Audio *audio, Sint64 ms);

Function Parameters

MIX_Audio * audio the audio to query.
Sint64 ms the milliseconds to convert to audio-specific sample frames.

Return Value

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

Remarks

This calculates time based on the audio's initial format, even if the format would change mid-stream.

If ms 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.