SDL Wiki
[ front page | index | search | recent changes | git repo | offline html ]
(This function is part of SDL_mixer, a separate library from SDL.)

MIX_LoadAudioWithProperties

Load audio for playback through a collection of properties.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

MIX_Audio * MIX_LoadAudioWithProperties(SDL_PropertiesID props);

Function Parameters

SDL_PropertiesID props a set of properties on how to load audio.

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

Please see MIX_LoadAudio_IO() for a description of what the various LoadAudio functions do. This function uses properties to dictate how it operates, and exposes functionality the other functions don't provide.

These are the supported properties:

Specific decoders might accept additional custom properties, such as where to find soundfonts for MIDI playback, etc.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategorySDLMixer


[ edit | delete | history | feedback | raw ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.