@@ -482,9 +482,11 @@ extern SDL_DECLSPEC Mix_Music * SDLCALL Mix_LoadMUS(const char *file);
482
482
* fly. Also, crucially, there are as many channels for chunks as the app can
483
483
* allocate, but SDL_mixer only offers a single "music" channel.
484
484
*
485
- * If `closeio` is true, the IOStream will be closed before returning, whether
486
- * this function succeeds or not. SDL_mixer reads everything it needs from the
487
- * IOStream during this call in any case.
485
+ * If `closeio` is true, the SDL_IOStream will be closed when SDL_mixer is
486
+ * done with it, which will be before this function call returns if there is
487
+ * an error, or perhaps much later if the music is streaming for some time.
488
+ * The app should not attempt to use the stream again, as it may become
489
+ * invalid without warning.
488
490
*
489
491
* As a convenience, there is a function to read files from disk without
490
492
* having to deal with SDL_IOStream: `Mix_LoadMUS("filename.mp3")` will manage
@@ -542,9 +544,11 @@ extern SDL_DECLSPEC Mix_Music * SDLCALL Mix_LoadMUS_IO(SDL_IOStream *src, bool c
542
544
* - `MUS_OPUS` (Opus files)
543
545
* - `MUS_WAVPACK` (WavPack files)
544
546
*
545
- * If `closeio` is true, the IOStream will be closed before returning, whether
546
- * this function succeeds or not. SDL_mixer reads everything it needs from the
547
- * IOStream during this call in any case.
547
+ * If `closeio` is true, the SDL_IOStream will be closed when SDL_mixer is
548
+ * done with it, which will be before this function call returns if there is
549
+ * an error, or perhaps much later if the music is streaming for some time.
550
+ * The app should not attempt to use the stream again, as it may become
551
+ * invalid without warning.
548
552
*
549
553
* As a convenience, there is a function to read files from disk without
550
554
* having to deal with SDL_IOStream: `Mix_LoadMUS("filename.mp3")` will manage
0 commit comments