Browse Source

Sync SDL3 wiki -> header

[ci skip]
SDL Wiki Bot 2 months ago
parent
commit
50b8c6cdfb
1 changed files with 3 additions and 0 deletions
  1. 3 0
      include/SDL3/SDL_audio.h

+ 3 - 0
include/SDL3/SDL_audio.h

@@ -1583,6 +1583,9 @@ extern SDL_DECLSPEC bool SDLCALL SDL_PauseAudioStreamDevice(SDL_AudioStream *str
  * previously been paused. Once unpaused, any bound audio streams will begin
  * to progress again, and audio can be generated.
  *
+ * Remember, SDL_OpenAudioDeviceStream opens device in an unpaused state, so
+ * this function call is required for audio playback to begin on such device.
+ *
  * \param stream the audio stream associated with the audio device to resume.
  * \returns true on success or false on failure; call SDL_GetError() for more
  *          information.