Man page - sdl_clearaudiostream(3)

Packages contains this manual

Manual

SDL_ClearAudioStream

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
FUNCTION PARAMETERS
RETURN VALUE
THREAD SAFETY
AVAILABILITY
SEE ALSO

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

SEE ALSO

• (3), SDL_GetAudioStreamAvailable (3), • (3), SDL_GetAudioStreamData (3), • (3), SDL_GetAudioStreamQueued (3), • (3), SDL_PutAudioStreamData (3)