Skip to main content

MIX_CreateAudioDecoder_IO

Function MIX_CreateAudioDecoder_IO 

Source
pub unsafe extern "C" fn MIX_CreateAudioDecoder_IO(
    io: *mut SDL_IOStream,
    closeio: bool,
    props: SDL_PropertiesID,
) -> *mut MIX_AudioDecoder
Expand description

Create a MIX_AudioDecoder from an SDL_IOStream.

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.

Parameter: io the i/o stream from which to load data.

Parameter: closeio if true, close the i/o stream when done with it.

Parameter: props decoder-specific properties. May be zero.

Returns: an audio decoder, ready to decode.

Thread Safety: It is safe to call this function from any thread.

Available Since: This function is available since SDL_mixer 3.0.0.

See Also: MIX_CreateAudioDecoder_IO

See Also: MIX_DecodeAudio

See Also: MIX_DestroyAudioDecoder