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


Add data to the stream.

Header File

Defined in <SDL3/SDL_audio.h>


int 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

(int) Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.


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.


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryAudio

[ edit | delete | history | feedback | raw ]

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