(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_GetAudioCaptureDevices

Get a list of currently-connected audio capture devices.

Header File

Syntax

SDL_AudioDeviceID* SDL_GetAudioCaptureDevices(int *count);

Function Parameters

count

a pointer filled in with the number of devices returned. NULL is allowed.

Return Value

Returns a 0 terminated array of device instance IDs which should be freed with SDL_free(), or NULL on error; call SDL_GetError() for more details.

Remarks

This returns of list of available devices that record audio, like a microphone ("capture" devices). If you want devices that play sound, perhaps to speakers or headphones ("output" devices), use SDL_GetAudioOutputDevices() instead.

This only returns a list of physical devices; it will not have any device IDs returned by SDL_OpenAudioDevice().

If this function returns NULL, to signify an error, *count will be set to zero.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.