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


Get the preferred audio format of a specific audio device.


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

Function Parameters

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

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


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.


This function is available since SDL 3.0.0.


[ 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.