Wiki Page Content

Differences between revisions 2 and 3
Revision 2 as of 2009-11-17 18:26:31
Size: 1771
Editor: SheenaSmith
Revision 3 as of 2009-11-19 06:00:45
Size: 1774
Editor: SheenaSmith
Comment: edit content
Deletions are marked like this. Additions are marked like this.
Line 19: Line 19:
||'''src'''||the data source for the wave file||
||'''freesrc'''||non-zero to automatically free the data source, 0 for no change||
||'''src'''||the data source for the wave file; see [[SDL_RWFromMem]]() for more info||
||'''freesrc'''||non-zero to automatically free the data source||
Line 33: Line 33:
Line 35: Line 34:


Use this function to load a WAVE from the data source, automatically freeing that source if freesrc is non-zero.


SDL_AudioSpec* SDL_LoadWAV_RW(SDL_RWops*     src,
                              int            freesrc,
                              SDL_AudioSpec* spec,
                              Uint8**        audio_buf,
                              Uint32*        audio_len)

Function Parameters


the data source for the wave file; see SDL_RWFromMem() for more info


non-zero to automatically free the data source


specifies the target audio format; see SDL_AudioSpec for more info


specifies the audio buffer


specifies the length of the audio buffer in bytes

Return Value

If this function succeeds, it returns the given SDL_AudioSpec, filled with the audio data format of the wave data, and sets *audio_buf to a malloc()'d buffer containing the audio data, and sets *audio_len to the length of that audio buffer, in bytes.

This function returns NULL and sets the SDL error message if the wave file cannot be opened, uses an unknown data format, or is corrupt. Call SDL_GetError() for more information.

Code Examples

For example, to load a WAVE file, you could do:
SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);


Currently raw and MS-ADPCM WAVE files are supported.

You need to free the audio buffer with SDL_FreeWAV() when you are done with it.

None: SDL_LoadWAV_RW (last edited 2018-10-30 02:25:29 by RyanGordon)

Please include your contact information if you'd like to receive a reply.