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

MIX_CreateAudioDecoder_IO

Create a MIX_AudioDecoder from an SDL_IOStream.

Header File

Syntax

MIX_AudioDecoder * MIX_CreateAudioDecoder_IO(SDL_IOStream *io, bool closeio, SDL_PropertiesID props);

Function Parameters

SDL_IOStream *	io	the i/o stream from which to load data.
bool	closeio	if true, close the i/o stream when done with it.
SDL_PropertiesID	props	decoder-specific properties. May be zero.

Return Value

(MIX_AudioDecoder *) Returns an audio decoder, ready to decode.

Remarks

Most apps won't need this, as SDL_mixer's usual interfaces will decode audio as needed. However, if one wants to decode an audio file into a memory buffer without playing it, this interface offers that.

This function allows properties to be specified. This is intended to supply file-specific settings, such as where to find SoundFonts for a MIDI file, etc. In most cases, the caller should pass a zero to specify no extra properties.

If closeio is true, then io will be closed when this decoder is done with it. If this function fails and closeio is true, then io will be closed before this function returns.

When done with the audio decoder, it can be destroyed with MIX_DestroyAudioDecoder().

This function requires SDL_mixer to have been initialized with a successful call to MIX_Init(), but does not need an actual MIX_Mixer to have been created.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.