(This function is part of SDL_mixer, a separate library from SDL.)

MIX_LoadAudio

Load audio for playback from a file.

Header File

Syntax

MIX_Audio * MIX_LoadAudio(MIX_Mixer *mixer, const char *path, bool predecode);

Function Parameters

MIX_Mixer *	mixer	a mixer this audio is intended to be used with. May be NULL.
const char *	path	the path on the filesystem to load data from.
bool	predecode	if true, data will be fully uncompressed before returning.

Return Value

(MIX_Audio *) Returns an audio object that can be used to make sound on a mixer, or NULL on failure; call SDL_GetError() for more information.

Remarks

This is equivalent to calling:

MIX_LoadAudio_IO(mixer, SDL_IOFromFile(path, "rb"), predecode, true);

This function loads data from a path on the filesystem. There is also a version that loads from an SDL_IOStream (MIX_LoadAudio_IO()), and one that accepts properties for ultimate control (MIX_LoadAudioWithProperties()).

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.