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


Clear any pending data in the stream.

Header File

Defined in <SDL3/SDL_audio.h>


int SDL_ClearAudioStream(SDL_AudioStream *stream);

Function Parameters

SDL_AudioStream * stream the audio stream to clear.

Return Value

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


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

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.