MIX_CreateAudioDecoder_IO(3)

💖 MIX_CreateAudioDecoder_IO — the SDL_mixer3 glow-up 💖

okay bestie, we're in the SDL_mixer3 FUNCTIONS section and today's main character is MIX_CreateAudioDecoder_IO(3). it literally makes you a MIX_AudioDecoder out of an SDL_IOStream. no cap. ✨

---

🌸 NAME 🌸

MIX_CreateAudioDecoder_IO — create a MIX_AudioDecoder from an SDL_IOStream. that's the whole vibe. 🦋

---

✨ SYNOPSIS ✨

#include <SDL3_mixer/SDL_mixer.h>

MIX_AudioDecoder * MIX_CreateAudioDecoder_IO(SDL_IOStream *io, bool closeio, SDL_PropertiesID props);

look at that signature. iconic. 💅

---

🎀 DESCRIPTION 🎀

so here's the tea: most apps do NOT need this. SDL_mixer's usual interfaces will decode audio as needed, they got you. 🙌

BUT. if you wanna decode an audio file into a memory buffer without playing it? that's the moment. this interface is giving exactly that energy. it's for when you just want the decoded data and you're not trying to make any noise. 🤫

this function lets you specify properties too, which is intended to supply file-specific settings — like where to find SoundFonts for a MIDI file, etc. most of the properties available to MIX_LoadAudioWithProperties() apply here, too. and in most cases, the caller should pass a zero to specify no extra properties. zero. nothing. quiet luxury. 🤌

okay now pay attention because this one matters: if closeio is true, then io will be closed when this decoder is done with it. and if this function fails and closeio is true, then io will be closed before this function returns. so it's closed either way, bestie. plan accordingly. 💀

when you're done with the audio decoder, it can be destroyed with MIX_DestroyAudioDecoder(). clean up after yourself, it's the rule. 🧹

one more thing: this function requires SDL_mixer to have been initialized with a successful call to MIX_Init(). but — plot twist — it does NOT need an actual MIX_Mixer to have been created. decoder stays unbothered. un-mixed. unstoppable. 👑

---

🌈 FUNCTION PARAMETERS 🌈

• io — the i/o stream from which to load data. your source of truth, your supply. 🍓
• closeio — if true, close the i/o stream when done with it. (yes, that close. the one from above. bye bye stream 👋)
• props — decoder-specific properties. may be zero. zero is a perfectly valid slay. ✨

---

⭐ RETURN VALUE ⭐

returns an audio decoder, ready to decode. it arrives prepped, primped, and prepared. periodt. 💅

---

🧚 THREAD SAFETY 🧚

it is safe to call this function from any thread. any. thread. no exclusivity drama, no jealousy, no locks in your feelings. 🫶

---

💜 AVAILABILITY 💜

this function is available since SDL_mixer 3.0.0. it's been here, it's been thriving. 👑

---

🔥 SEE ALSO 🔥

• MIX_CreateAudioDecoder_IO(3)
• MIX_DecodeAudio(3)
• MIX_DestroyAudioDecoder(3)

go read those too, iykyk. 📚

---

and that's the whole page, bestie — brought to you by SDL_mixer 3.2.4, the version that ate and left no crumbs. mwah. 🎀💖✨🌸🦋