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


Query the current format of an audio stream.

Header File

Defined in <SDL3/SDL_audio.h>


int 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

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


This function is available since SDL 3.0.0.

See Also

CategoryAPI, CategoryAPIFunction, CategoryAudio

[ edit | delete | history | feedback | raw ]

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