(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_CloseAudioDevice

Close a previously-opened audio device.

Header File

Syntax

void SDL_CloseAudioDevice(SDL_AudioDeviceID devid);

Function Parameters

SDL_AudioDeviceID

devid

an audio device id previously returned by SDL_OpenAudioDevice().

Remarks

The application should close open audio devices once they are no longer needed.

This function may block briefly while pending audio data is played by the hardware, so that applications don't drop the last buffer of data they supplied if terminating immediately afterwards.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

Code Examples

extern SDL_AudioSpec want;
SDL_AudioDeviceID devid = SDL_OpenAudioDevice(SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK, &want);
if (devid != 0) {
    SDL_ResumeAudioDevice(devid);
    SDL_Delay(5000);  // let device play for 5 seconds
    SDL_CloseAudioDevice(devid);
}