SDL_GetAudioStreamFormat - Man Page

Query the current format of an audio stream.

Header File

Defined in SDL3/SDL_audio.h

Synopsis

#include "SDL3/SDL.h"

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

See Also

·(3), SDL_SetAudioStreamFormat(3)

Referenced By

SDL_SetAudioStreamFormat(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS