SDL_GetAudioRecordingDevices(3)

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

💖 SDL_GetAudioRecordingDevices 💖

okay bestie, welcome to the SDL3 functions corner of the manual, this one's all about SDL_GetAudioRecordingDevices and it's literally the glow-up your mic setup has been waiting for ✨

🌸 NAME 🌸

SDL_GetAudioRecordingDevices — get a list of currently-connected audio recording devices. yes, ALL of them. the whole roster. 💅

🎀 SYNOPSIS 🎀

#include <SDL3/SDL_audio.h>

SDL_AudioDeviceID * SDL_GetAudioRecordingDevices(int *count);

🦋 DESCRIPTION 🦋

so here's the tea: this function hands you a list of every available device that records audio — think microphones, headsets, that one USB thing you bought at 2am, all of them. in SDL-speak these are called "recording" devices 🎤

if what you actually want is the stuff that plays sound — speakers, headphones, the vibe-makers — then you want SDL_GetAudioPlaybackDevices() instead. different function, different list, don't mix them up bestie 🙈

also important, no cap: this only returns a list of physical devices. it will not include any of the device IDs that came out of SDL_OpenAudioDevice(). those are yours, not the system's, iykyk.

and if this function returns NULL, which is how it signals an error, then *count will be set to zero. zero. nada. the vibe check failed 😭

✨ FUNCTION PARAMETERS ✨

  • count — a pointer that gets filled in with the number of devices returned. it may be NULL, so if you truly don't care how many there are, you can just... not ask 🫶

👑 RETURN VALUE 👑

returns a 0 terminated array of device instance IDs, or NULL on failure. if it's NULL you should call SDL_GetError() for more info — that's where the actual explanation lives.

and listen, this is the part everyone forgets: when you're done with it, free it with SDL_free(). it is not going to clean itself up. main character energy does not extend to memory management 💀

🌈 THREAD SAFETY 🌈

it is safe to call this function from any thread. go off, multithreaded queen 👑

⭐ AVAILABILITY ⭐

this function is available since SDL 3.2.0. so if you're on something older... no it isn't, babe 💖

🍓 SEE ALSO 🍓

and that's the whole page!! brought to you by Simple Directmedia Layer, running SDL 3.4.18 — mwah, free the array, call SDL_GetError(), and stay iconic 🧚💜

📦 where this page comes from