SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


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

Header File

Defined in <SDL3/SDL_audio.h>


int SDL_FlushAudioStream(SDL_AudioStream *stream);

Function Parameters

SDL_AudioStream * stream the audio stream to flush.

Return Value

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


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.

Thread Safety

It is safe to call this function from any thread.


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryAudio

[ edit | delete | history | feedback | raw ]

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.