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

SDL_GetAudioStreamData

Get converted/resampled data from the stream.

Header File

Syntax

int SDL_GetAudioStreamData(SDL_AudioStream *stream, void *buf, int len);

Function Parameters

SDL_AudioStream *	stream	the stream the audio is being requested from.
void *	buf	a buffer to fill with audio data.
int	len	the maximum number of bytes to fill.

Return Value

(int) Returns the number of bytes read from the stream or -1 on failure; call SDL_GetError() for more information.

Remarks

The input/output data format/channels/samplerate is specified when creating the stream, and can be changed after creation by calling SDL_SetAudioStreamFormat.

Note that any conversion and resampling necessary is done during this call, and SDL_PutAudioStreamData simply queues unconverted data for later. This is different than SDL2, where that work was done while inputting new data to the stream and requesting the output just copied the converted data.

Thread Safety

It is safe to call this function from any thread, but if the stream has a callback set, the caller might need to manage extra locking.

Version

This function is available since SDL 3.1.3.