SDL_GetAudioStreamData(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

✨ SDL_GetAudioStreamData ✨

okay bestie, gather round, because this is a page from the SDL3 FUNCTIONS manual and it's literally the one that hands you your audio 💖

💅 NAME

SDL_GetAudioStreamData — grab the converted/resampled data out of the stream 🎧✨

🌸 SYNOPSIS

#include <SDL3/SDL_audio.h>

int SDL_GetAudioStreamData(SDL_AudioStream *stream, void *buf, int len);

🦋 DESCRIPTION

So here's the tea: the input/output data format, channels and samplerate? Those get set the moment you create the stream, and if you wanna change your mind later you can just call SDL_SetAudioStreamFormat. slay, flexible 💅

ngl the important part is when the work happens: any conversion and resampling that needs doing gets done during this very call. Meanwhile SDL_PutAudioStreamData just queues up unconverted data for later, no thoughts, head empty 🫶. This is different than SDL2, where the conversion/resampling work happened while you were inputting new data, and requesting output just copied the already-converted data. so yeah, that's the glow-up ✨

🎀 FUNCTION PARAMETERS

  • stream — the stream you're requesting audio from, your main character 🎤
  • buf — a buffer to fill with audio data, hand it over and it gets fed 🍓
  • len — the maximum number of bytes to fill. it's a cap, not a promise, bestie 💀

👑 RETURN VALUE

Returns the number of bytes read from the stream, or -1 on failure 😭. If it flops, call SDL_GetError() for more info — she'll tell you what went wrong, fr fr.

🔥 THREAD SAFETY

It's safe to call this function from any thread 🧚 — but if the stream has a callback set, the caller might need to manage extra locking. so like, keep an eye on that, iykyk 🔒

⭐ AVAILABILITY

This function is available since SDL 3.2.0. old enough to be iconic, new enough to be cute 💜

🌈 SEE ALSO

Simple Directmedia Layer said it, SDL 3.4.18 stamped it, and that's the whole vibe check — SDL_GetAudioStreamData(3), periodt 💖🦋✨

📦 where this page comes from