MIX_GetAudioDecoderFormat(3)

📦
version 3.2.4 · 2 versions
, in fedora 44

💖 MIX_GetAudioDecoderFormat 💖

okay so bestie, we're in the SDL_mixer3 functions section, and today's main character is MIX_GetAudioDecoderFormat(3). she's giving "let me peek at your initial audio format real quick" energy and honestly? we're obsessed. 🎀

✨ NAME ✨

MIX_GetAudioDecoderFormat — ask a MIX_AudioDecoder what its initial audio format is. that's it, that's the vibe check. 💅

🌸 SYNOPSIS 🌸

#include <SDL3_mixer/SDL_mixer.h>

bool MIX_GetAudioDecoderFormat(MIX_AudioDecoder *audiodecoder, SDL_AudioSpec *spec);

like, she takes two things and gives you back a bool. no cap. ✨

🦋 DESCRIPTION 🦋

so here's the tea, bestie. some audio files can <em>change format in the middle</em>. some of them explicitly support doing that, and then there's the more common little gremlin example: two MP3 files concatenated together. 😭

and in many cases, SDL_mixer will correctly handle these sort of files! she's talented like that. but — and this is the important part — this function will only report the initial format a file uses. just the opening act. the first fit. not the whole character arc. 👑

🫶 FUNCTION PARAMETERS 🫶

  • audiodecoder — the audio decoder you wanna query. the one we're asking. 💜
  • spec — on success, the audio format details get stored in here. she fills this in for you. so cute.

⭐ RETURN VALUE ⭐

Returns true on success, or false on failure. and if it fails? call SDL_GetError() for more info, because she <em>will</em> tell you what went wrong. 📣

🌈 THREAD SAFETY 🌈

It is safe to call this function from any thread. yes bestie, any thread. go wild. 🧚

🎀 AVAILABILITY 🎀

This function is available since SDL_mixer 3.0.0. she's been here. she's iconic. she's not new. 💅

lowkey reminder: this only ever gives you the initial format, so if your file is doing a format glow-up halfway through, don't come for her — she told you upfront. 🙈

that's the whole page, bestie, ate and left no crumbs. this was MIX_GetAudioDecoderFormat(3) from SDL_mixer 3.2.4 — mwah, love u, go read your audio specs. 💖✨🦋

📦 where this page comes from