Scroll to navigation

SDL_GetAudioPlaybackDevices(3) SDL3 FUNCTIONS SDL_GetAudioPlaybackDevices(3)

NAME

SDL_GetAudioPlaybackDevices - Get a list of currently-connected audio playback devices.

HEADER FILE

Defined in SDL3/SDL_audio.h

SYNOPSIS

#include "SDL3/SDL.h"
SDL_AudioDeviceID * SDL_GetAudioPlaybackDevices(int *count);

DESCRIPTION

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

SDL_GetAudioRecordingDevices () 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

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 error; 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.1.3.

SEE ALSO

(3), SDL_OpenAudioDevice(3), (3), SDL_GetAudioRecordingDevices(3)

SDL 3.1.6 Simple Directmedia Layer