Man page - sdl_audiodevicepaused(3)

Packages contains this manual

Package: libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:

Manual

SDL_AudioDevicePaused

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
THREAD SAFETY
AVAILABILITY
SEE ALSO

NAME

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

HEADER FILE

Defined in SDL3/SDL_audio.h

SYNOPSIS

#include "SDL3/SDL.h"

bool SDL_AudioDevicePaused(SDL_AudioDeviceID devid);

DESCRIPTION

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.