SDL_FlushAudioStream(3)

SDL_FlushAudioStream3

Tell the stream that you're done sending data, and anything being buffered should be converted/resampled and made available immediately.

Usage

#include "SDL3/SDL.h"

bool SDL_FlushAudioStream(SDL_AudioStream *stream);

Header file

Defined in SDL3/SDL_audio.h

Overview

It is legal to add more data to a stream after flushing, but there may be audio gaps in the output. Generally this is intended to signal the end of input, so the complete output becomes available.

Function parameters

stream

the audio stream to flush.

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.