SDL_GetAudioRecordingDevices(3)

SDL_GetAudioRecordingDevices3

Get a list of currently-connected audio recording devices.

Usage

#include "SDL3/SDL.h"

SDL_AudioDeviceID * SDL_GetAudioRecordingDevices(int *count);

Header file

Defined in SDL3/SDL_audio.h

Overview

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

SDL_GetAudioPlaybackDevices () 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.

Function parameters

count

a pointer filled in with the number of devices returned, may be NULL.

Return value

( SDL_AudioDeviceID
*) Returns a 0 terminated array of device instance IDs, or NULL on failure; call

SDL_GetError () for more information. This should be freed with SDL_free () when it is no longer needed.

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.