SDL_ResumeAudioStreamDevice(3)

SDL_ResumeAudioStreamDevice3

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

Usage

#include "SDL3/SDL.h"

bool SDL_ResumeAudioStreamDevice(SDL_AudioStream *stream);

Header file

Defined in SDL3/SDL_audio.h

Overview

This function unpauses audio processing for a given device that has previously been paused. Once unpaused, any bound audio streams will begin to progress again, and audio can be generated.

Remember, SDL_OpenAudioDeviceStream
opens device in a paused state, so this function call is required for audio playback to begin on such device.

Function parameters

stream

the audio stream associated with the audio device to resume.

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.