SDL_GetAudioStreamFormat(3)

SDL_GetAudioStreamFormat3

Query the current format of an audio stream.

Usage

#include "SDL3/SDL.h"

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

Header file

Defined in SDL3/SDL_audio.h

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 true on success or false on failure; call

SDL_GetError () for more information.

Thread safety

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

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.