(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_GetAudioDeviceSpec

Get the preferred audio format of a specific audio device.

Header File

Syntax

int SDL_GetAudioDeviceSpec(int index,
                           int iscapture,
                           SDL_AudioSpec *spec);

Function Parameters

int	index	the index of the audio device; valid values range from 0 to SDL_GetNumAudioDevices() - 1.
int	iscapture	non-zero to query the list of recording devices, zero to query the list of output devices.
SDL_AudioSpec *	spec	The SDL_AudioSpec to be initialized by this function.

Return Value

(int) Returns 0 on success, nonzero on error.

Remarks

This function is only valid after a successfully initializing the audio subsystem. The values returned by this function reflect the latest call to SDL_GetNumAudioDevices(); re-call that function to redetect available hardware.

spec will be filled with the sample rate, sample format, and channel count.

Version

This function is available since SDL 2.0.16.