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

SDL_ResumeAudioDevice

Use this function to unpause audio playback on a specified device.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

bool SDL_ResumeAudioDevice(SDL_AudioDeviceID dev);

Function Parameters

SDL_AudioDeviceID dev a device opened by SDL_OpenAudioDevice().

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

This function unpauses audio processing for a given device that has previously been paused with SDL_PauseAudioDevice(). Once unpaused, any bound audio streams will begin to progress again, and audio can be generated.

Unlike in SDL2, audio devices start in an unpaused state, since an app has to bind a stream before any audio will flow. Unpausing an unpaused device is a legal no-op.

Physical devices can not be paused or unpaused, only logical devices created through SDL_OpenAudioDevice() can be.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.1.3.

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.