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

SDL_ClearAudioStream

Clear any pending data in the stream.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

int SDL_ClearAudioStream(SDL_AudioStream *stream);

Function Parameters

Return Value

Returns 0 on success or a negative error code 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.0.0.

See Also

• SDL_GetAudioStreamAvailable
• SDL_GetAudioStreamData
• SDL_GetAudioStreamQueued
• SDL_PutAudioStreamData

CategoryAPI, CategoryAPIFunction, CategoryAudio