(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_ClearAudioStream

Clear any pending data in the stream.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

bool SDL_ClearAudioStream(SDL_AudioStream *stream);

Function Parameters

SDL_AudioStream *

stream

the audio stream to clear.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

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.

Version

This function is available since SDL 3.1.3.

See Also

• SDL_GetAudioStreamAvailable
• SDL_GetAudioStreamData
• SDL_GetAudioStreamQueued
• SDL_PutAudioStreamData

---

CategoryAPI, CategoryAPIFunction, CategoryAudio

[ 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.