Wiki Page Content

Differences between revisions 1 and 6 (spanning 5 versions)
Revision 1 as of 2009-11-17 18:20:09
Size: 1751
Editor: SheenaSmith
Comment: create page, add content
Revision 6 as of 2009-11-24 21:25:34
Size: 1744
Editor: SheenaSmith
Comment: add categories
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 22: Line 22:
||'''audio_buf'''||the audio buffer||
||'''audio_len'''||the length of the audio buffer in bytes||
||'''audio_buf'''||specifies the audio buffer||
||'''audio_len'''||specifies the length of the audio buffer in bytes||
Line 32: Line 32:
For example, to load a WAVE file, you could do:
\code
SDL_LoadWAV_RW(SDL_RWFromFile("sample.wav", "rb"), 1, ...);
\endcode
You can add your code example here
Line 47: Line 43:

----
[[CategoryAPI]], [[CategoryAudio]]

SDL_LoadWAV_RW

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

Syntax

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

Function Parameters

src

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

freesrc

non-zero to automatically free the data source

spec

specifies the target audio format; see SDL_AudioSpec for more info

audio_buf

specifies the audio buffer

audio_len

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

You can add your code example here

Remarks

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.


CategoryAPI, CategoryAudio

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

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