SDL_AudioStreamDevicePaused - Man Page

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

Header File

Defined in SDL3/SDL_audio.h

Synopsis

#include "SDL3/SDL.h"

bool SDL_AudioStreamDevicePaused(SDL_AudioStream *stream);

Description

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.

See Also

·(3), SDL_PauseAudioStreamDevice(3), ·(3), SDL_ResumeAudioStreamDevice(3)

Info

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS