SDL_AudioDevicePaused(3)

SDL_AudioDevicePaused3

Use this function to query if an audio device is paused.

Usage

#include "SDL3/SDL.h"

bool SDL_AudioDevicePaused(SDL_AudioDeviceID devid);

Header file

Defined in SDL3/SDL_audio.h

Overview

Unlike in SDL2, audio devices start in an _unpaused_ state, since an app has to bind a stream before any audio will flow.

Physical devices can not be paused or unpaused, only logical devices created through SDL_OpenAudioDevice () can be. Physical and invalid device IDs will report themselves as unpaused here.

Function parameters

devid

a device opened by SDL_OpenAudioDevice ().

Return value

Returns true if device is valid and paused, false otherwise.

Thread safety

It is safe to call this function from any thread.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.