SDL_ClearAudioStream(3)

SDL_ClearAudioStream3

Clear any pending data in the stream.

Usage

#include "SDL3/SDL.h"

bool SDL_ClearAudioStream(SDL_AudioStream *stream);

Header file

Defined in SDL3/SDL_audio.h

Overview

This drops any queued data, so there will be nothing to read from the stream until more is added.

Function parameters

stream

the audio stream to clear.

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.