SDL_AudioStreamDevicePaused(3)

SDL_AudioStreamDevicePaused3

Use this function to query if an audio device associated with a stream is paused.

Usage

#include "SDL3/SDL.h"

bool SDL_AudioStreamDevicePaused(SDL_AudioStream *stream);

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.

Function parameters

stream

the audio stream associated with the audio device to query.

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.