SDL_GetAudioStreamFormat(3)

✨ NAME ✨

SDL_GetAudioStreamFormat — bestie, this is the lil function that lets you peek at the current format of an audio stream. Like, "hey stream, what ARE you right now?" 💖

(also hi, this is a page from the SDL3 FUNCTIONS manual, iykyk 👑)

---

🎀 SYNOPSIS 🎀

okay so first you gotta bring in the header:

#include <SDL3/SDL_audio.h>

and then the function itself, no cap:

bool SDL_GetAudioStreamFormat(SDL_AudioStream *stream, SDL_AudioSpec *src_spec, SDL_AudioSpec *dst_spec);

---

🦋 FUNCTION PARAMETERS 🦋

• stream — the SDL_AudioStream you wanna interrogate. the main character of this whole operation 💅
• src_spec — where you want the input audio format stored. if it's NULL, it's just ignored — no drama, no error, it simply does not care 🙈
• dst_spec — where you want the output audio format stored. same deal: NULL means ignored, bye bye 🎀

---

⭐ RETURN VALUE ⭐

• returns true when it slays (success) ✅
• returns false when it does NOT slay (failure) 😭

and if it fails? call SDL_GetError() for more info, that's your group chat receipts fr fr 💀

---

🧚 THREAD SAFETY 🧚

good news bestie: it is safe to call this function from any thread. the way it does that is by holding a stream-specific mutex while it runs, so nobody's stepping on anybody's toes. iconic behavior honestly 🫶

---

🌸 AVAILABILITY 🌸

this function has been available since SDL 3.2.0. so if you're on something older… babe. update. 💜

---

🌈 SEE ALSO 🌈

• SDL_SetAudioStreamFormat(3) — the one that actually changes the format, if peeking isn't enough for you 👑

---

ok that's the whole page, you ate that, periodt ✨ go format some audio bestie 🎧💖

kisses from the Simple Directmedia Layer girlies — this was the SDL 3.4.18 era, and yes this page is literally titled SDL_GetAudioStreamFormat(3) again at the bottom like a lil signature 🎀 byeeeee 💅