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

SDL_PutAudioStreamData

Add data to the stream.

Header File

Syntax

bool SDL_PutAudioStreamData(SDL_AudioStream *stream, const void *buf, int len);

Function Parameters

SDL_AudioStream *	stream	the stream the audio data is being added to.
const void *	buf	a pointer to the audio data to add.
int	len	the number of bytes to write to the stream.

Return Value

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

Remarks

This data must match the format/channels/samplerate specified in the latest call to SDL_SetAudioStreamFormat, or the format specified when creating the stream if it hasn't been changed.

Note that this call simply copies the unconverted data for later. This is different than SDL2, where data was converted during the Put call and the Get call would just dequeue the previously-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.