SDL_PauseAudioStreamDevice(3)

SDL_PauseAudioStreamDevice3

Use this function to pause audio playback on the audio device associated with an audio stream.

Usage

#include "SDL3/SDL.h"

bool SDL_PauseAudioStreamDevice(SDL_AudioStream *stream);

Header file

Defined in SDL3/SDL_audio.h

Overview

This function pauses audio processing for a given device. Any bound audio streams will not progress, and no audio will be generated. Pausing one device does not prevent other unpaused devices from running.

Pausing a device can be useful to halt all audio without unbinding all the audio streams. This might be useful while a game is paused, or a level is loading, etc.

Function parameters

stream

the audio stream associated with the audio device to pause.

Return value

Returns true on success or false on failure; call

SDL_GetError () for more information.

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.