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


Get converted/resampled data from the stream.

Header File

Defined in <SDL3/SDL_audio.h>


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


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.


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.