NAME¶

SDL_AudioStream - The opaque handle that represents an audio stream.

HEADER FILE¶

Defined in SDL3/SDL_audio.h

SYNOPSIS¶

#include "SDL3/SDL.h"

struct SDL_AudioStream;  /**< this is opaque to the outside world. */

DESCRIPTION¶

SDL_AudioStream
is an audio conversion interface.

• It can handle resampling data in chunks without generating artifacts,
when it doesn't have the complete buffer available.

• It can handle incoming data in any variable size.

• It can handle input/output format changes on the fly.

• You push data as you have it, and pull it when you need it

• It can also function as a basic audio data queue even if you just have
sound that needs to pass from one place to another.

• You can hook callbacks up to them when more data is added or requested,
to manage data on-the-fly.

Audio streams are the core of the SDL3 audio interface. You create one or more of them, bind them to an opened audio device, and feed data to them (or for recording, consume data from them).

AVAILABILITY¶

This struct is available since SDL 3.0.0.

SEE ALSO¶

SDL_CreateAudioStream(3)