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

SDL_GetAudioRecordingDevices

Get a list of currently-connected audio recording devices.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

SDL_AudioDeviceID* SDL_GetAudioRecordingDevices(int *count);

Function Parameters

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

Return Value

(SDL_AudioDeviceID *) 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 ("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.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryAudio


[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.