(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_LoadWAV

Loads a WAV from a file path.

Header File

Syntax

SDL_bool SDL_LoadWAV(const char *path, SDL_AudioSpec *spec, Uint8 **audio_buf, Uint32 *audio_len);

Function Parameters

const char *	path	the file path of the WAV file to open.
SDL_AudioSpec *	spec	a pointer to an SDL_AudioSpec that will be set to the WAVE data's format details on successful return.
Uint8 **	audio_buf	a pointer filled with the audio data, allocated by the function.
Uint32 *	audio_len	a pointer filled with the length of the audio data buffer in bytes.

Return Value

(SDL_bool) Returns SDL_TRUE on success. audio_buf will be filled with a pointer to an allocated buffer containing the audio data, and audio_len is filled with the length of that audio buffer in bytes.

This function returns SDL_FALSE if the .WAV file cannot be opened, uses an unknown data format, or is corrupt; call SDL_GetError() for more information.

When the application is done with the data returned in audio_buf, it should call SDL_free() to dispose of it.

Remarks

This is a convenience function that is effectively the same as:

SDL_LoadWAV_IO(SDL_IOFromFile(path, "rb"), SDL_TRUE, spec, audio_buf, audio_len);

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL 3.0.0.