BramReuling/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-06-27 16:28:40 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

audio: SDL_GetAudioStreamQueued now returns bytes, not frames.

Browse source 
Reference #8266.
This commit is contained in:
Ryan C. Gordon 2023-09-20 14:15:19 -04:00
parent 703aefbce0
commit a4541a255e
No known key found for this signature in database
GPG key ID: FA148B892AB48044
3 changed files with 13 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

13
include/SDL3/SDL_audio.h
View file

@ -860,12 +860,13 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *stream)
/**
* Get the number of sample frames currently queued.
* Get the number of bytes currently queued.
*
* Since audio streams can change their input format at any time, even if
* there is still data queued in a different format, this reports the queued
* _sample frames_, so if you queue two stereo samples in float32 format and
* then queue five mono samples in Sint16 format, this will return 6.
* Note that audio streams can change their input format at any time, even if
* there is still data queued in a different format, so the returned byte
* count will not necessarily match the number of _sample frames_ available.
* Users of this API should be aware of format changes they make when feeding
* a stream and plan accordingly.
*
* Queued data is not converted until it is consumed by
* SDL_GetAudioStreamData, so this value should be representative of the exact
@ -878,7 +879,7 @@ extern DECLSPEC int SDLCALL SDL_GetAudioStreamAvailable(SDL_AudioStream *stream)
* clamped.
*
* \param stream The audio stream to query
* \returns the number of sample frames queued.
* \returns the number of bytes queued.
*
* \threadsafety It is safe to call this function from any thread.
*