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_CreateMixer

Create a mixer that generates audio to a memory buffer.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

MIX_Mixer * MIX_CreateMixer(const SDL_AudioSpec *spec);

Function Parameters

const SDL_AudioSpec * spec the audio format that mixer will generate.

Return Value

(MIX_Mixer *) Returns a mixer that can be used to generate audio, or NULL on failure; call SDL_GetError() for more information.

Remarks

Usually you want MIX_CreateMixerDevice() instead of this function. The mixer created here can be used with MIX_Generate() to produce more data on demand, as fast as desired.

An audio format must be specified. This is the format it will output in. This cannot be NULL.

Once a mixer is created, next steps are usually to load audio (through MIX_LoadAudio() and friends), create a track (MIX_CreateTrack()), and play that audio through that track.

When done with the mixer, it can be destroyed with MIX_DestroyMixer().

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.