(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetAudioStreamFormat

Query the current format of an audio stream.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

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

Function Parameters

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

Return Value

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

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetAudioStreamFormat

---

CategoryAPI, CategoryAPIFunction, CategoryAudio

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.