Wiki Page Content

Differences between revisions 11 and 12
Revision 11 as of 2010-10-12 00:58:12
Size: 1878
Editor: SheenaSmith
Comment: update content - pointers, structs; RV
Revision 12 as of 2012-06-04 17:21:19
Size: 1870
Editor: ChrisBush
Comment: Out variable audio_len value is not pointer (from Feedback)
Deletions are marked like this. Additions are marked like this.
Line 26: Line 26:
If this function succeeds it returns ^a pointer to an^ ,,the given,, [[SDL_AudioSpec]] ^structure^ filled with the audio data format of the wave data, fills '''audio_buf''' with a pointer to a malloc()'d buffer containing the audio data, and fills '''audio_len''' with a pointer to the length of that audio buffer (in bytes). This function, if successfully called, returns a pointer to an [[SDL_AudioSpec]] structure filled with the audio data format of the wave source data. '''audio_buf''' is filled with a pointer to a malloc()'d buffer containing the audio data, and '''audio_len''' is filled with the length of that audio buffer in bytes.

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 -or- an SDL_AudioSpec structure representing the desired output format

audio_buf

specifies the audio buffer

audio_len

specifies the length of the audio buffer in bytes

Return Value

This function, if successfully called, returns a pointer to an SDL_AudioSpec structure filled with the audio data format of the wave source data. audio_buf is filled with a pointer to a malloc()'d buffer containing the audio data, and audio_len is filled with the length of that audio buffer in bytes.

This function returns NULL 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