NAME

       SDL_SetAudioStreamPutCallback - Set a callback that runs when data is added to an audio stream.

HEADER FILE

       Defined in SDL3/SDL_audio.h

SYNOPSIS

       #include "SDL3/SDL.h"

       bool SDL_SetAudioStreamPutCallback(SDL_AudioStream *stream, SDL_AudioStreamCallback callback, void *userdata);

DESCRIPTION

       This callback is called _after_ the data is added to the stream, giving the callback the chance to obtain
       it immediately.

       The callback can (optionally) call

       SDL_GetAudioStreamData () to obtain audio from the stream during this call.

       The  callback's  approx_request  argument  is  how many bytes of _converted_ data (in the stream's output
       format) was provided by the caller, although this may underestimate a little for safety. This value might
       be less than what is currently available in the stream, if data was already there, and might be less than
       the caller provided if the stream needs to keep a buffer to aid in resampling. Which means  the  callback
       may be provided with zero bytes, and a different amount on each call.

       The callback may call

       SDL_GetAudioStreamAvailable
        to  see  the  total amount currently available to read from the stream, instead of the total provided by
       the current call.

       The callback is not required to obtain all data. It is allowed to read less or none at all. Anything  not
       read now simply remains in the stream for later access.

       Clearing or flushing an audio stream does not call this callback.

       This  function obtains the stream's lock, which means any existing callback (get or put) in progress will
       finish running before setting the new callback.

       Setting a NULL function turns off the callback.

FUNCTION PARAMETERS

       stream the audio stream to set the new callback on.

       callback
              the new callback function to call when data is added to the stream.

       userdata
              an opaque pointer provided to the callback for its own personal use.

RETURN VALUE

       Returns true on success or false on failure; call

       SDL_GetError () for more information. This only fails if stream is NULL.

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_SetAudioStreamGetCallback(3)

Simple Directmedia Layer                            SDL 3.2.8                   SDL_SetAudioStreamPutCallback(3)