table of contents
SDL_ClearAudioStream(3) | SDL3 FUNCTIONS | SDL_ClearAudioStream(3) |
NAME¶
SDL_ClearAudioStream - Clear any pending data in the stream.
HEADER FILE¶
Defined in SDL3/SDL_audio.h
SYNOPSIS¶
#include "SDL3/SDL.h"
bool SDL_ClearAudioStream(SDL_AudioStream *stream);
DESCRIPTION¶
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.1.3.
SEE ALSO¶
•(3), SDL_GetAudioStreamAvailable(3), •(3), SDL_GetAudioStreamData(3), •(3), SDL_GetAudioStreamQueued(3), •(3), SDL_PutAudioStreamData(3)
SDL 3.1.6 | Simple Directmedia Layer |