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

SDL_GetAudioStreamFormat

Query the current format of an audio stream.

Header File

Syntax

int SDL_GetAudioStreamFormat(SDL_AudioStream *stream,
                         SDL_AudioSpec *src_spec,
                         SDL_AudioSpec *dst_spec);

Function Parameters

stream	the SDL_AudioStream to query.
src_spec	Where to store the input audio format; ignored if NULL.
dst_spec	Where to store the output audio format; ignored if NULL.

Return Value

Returns 0 on success, or -1 on error.

Thread Safety

It is safe to call this function from any thread, as it holds a stream-specific mutex while running.

Version

This function is available since SDL 3.0.0.

CategoryAPI, CategoryAPIFunction, CategoryAudio