• SDL_mixer

A Note from the "author"

Please contribute to this list. The most important thing to do right now IMHO is to fill in the broken pages. - Donny Viszneki

What's on this page?

On this page is a full list of all functions and data types (or perhaps not, you could add some if they are missing,) provided by the SDL_mixer library. There are also a few other things here (or not here, again, you could add things if you felt they were missing.) Here are the other things, followed by the data types of SDL_mixer, and the function list, sorted first by simplicity, and then by usefulness (as deemed by me, for now) followed by the full function list. Functions are also loosely grouped by what they do exactly.

SDL_mixer Documentation

Contents

• SDL_mixer_Overview

• SDL_mixer_Getting_Started

  • SDL_mixer_Includes_and_Compiling

• SDL_mixer_Glossary

SDL_Mixer Data Types

• Mix_Music - Represents a real-time decoded (if necessary) music stream (I think)

• Mix_Chunk - Represents a sound sample loaded in memory

• Mix_MusicType

• Mix_Fading

• Mix_EffectFunc_t

• Mix_EffectDone_t

• SDL_mixer_Defines. - A list of defines usable in SDL_mixer

Abridged Function List

Basic Functions

• Mix_PlayChannel(int channel, Mix_Chunk *chunk, int loops) - Play a Mix_Chunk

• Mix_OpenAudio(int frequency, Uint16 format, int channels, int chunksize) - SDL_Mixer wrapper for SDL_OpenAudio

• Mix_CloseAudio(void) - SDL_Mixer wrapper for SDL_CloseAudio

• Mix_LoadWAV(char *filename) - Load sound sample; many formats supported; uses SDL_RWops

• Mix_FreeChunk(Mix_Chunk *chunk) - Free a Mix_Chunk from memory

• Mix_Pause(int channels) - Pause specified channel; pass -1 to this function to pause all channels

• Mix_Resume(int channels) - As Mix_Pause but resumes instead of pauses

• Mix_HaltChannel(int channels) - Again, specify the channel or -1 for all channels

Less Basic Functions

• Mix_VolumeChunk(Mix_Chunk *chunk, int volume) - Set or get the volume of a Mix_Chunk

• Mix_Volume(int channel, int volume) - Set the volume of an SDL_Mixer Channel

• Mix_VolumeMusic(int volume) - Set the volume of ONLY the designated music track

• Mix_FadeInChannel(int channel, Mix_Chunk *chunk, int loops, int ms) - Same as Mix_PlayChannel but with a fade-in

• Mix_FadeOutChannel(int channel, int ms) - Fades out and halts whatever is playing on the specified channel over ms milliseconds

• Mix_ChannelFinished(void (*channel_finished)(int channel)) - Sets the callback function for when a channel finishes with its chunk

Obscure Functions

• Mix_LoadWAV_RW(SDL_RWops *src, int freesrc) - Loads a sound sample from memory in an SDL_RWops structure

• Mix_QuickLoad_WAV(Uint8 *mem) - Load a wave file of the mixer format from a memory buffer

• Mix_QuickLoad_RAW(Uint8 *mem, Uint32 len) - Load raw audio data of the mixer format from a memory buffer

• Mix_ExpireChannel(int channel, int ticks) - Like Mix_FadeOutChannel, but without a fade-out

• Mix_AllocateChannels(int numchans) - Set or get the number of channels that currently exist

SDL_mixer Full API Reference

1. General

   • Mix_Linked_Version

   • Mix_OpenAudio - SDL_Mixer wrapper for SDL_OpenAudio

   • Mix_CloseAudio - SDL_Mixer wrapper for SDL_CloseAudio

   • Mix_SetError

   • Mix_GetError

   • Mix_QuerySpec

2. Samples

   • Mix_LoadWAV - Load sound sample; many formats supported; uses SDL_RWops

   • Mix_LoadWAV_RW - Loads a sound sample from memory in an SDL_RWops structure

   • Mix_QuickLoad_WAV - Load a wave file of the mixer format from a memory buffer

   • Mix_QuickLoad_RAW - Load raw audio data of the mixer format from a memory buffer

   • Mix_VolumeChunk - Set or get the volume of a Mix_Chunk

   • Mix_FreeChunk - Free a Mix_Chunk from memory

3. Channels

   • Mix_AllocateChannels - Set or get the number of channels that currently exist

   • Mix_Volume - Set the volume of an SDL_Mixer Channel

   • Mix_PlayChannel - Play a Mix_Chunk

   • Mix_PlayChannelTimed

   • Mix_FadeInChannel - Same as Mix_PlayChannel but with a fade-in

   • Mix_FadeInChannelTimed

   • Mix_Pause - Pause specified channel; pass -1 to this function to pause all channels

   • Mix_Resume - As Mix_Pause but resumes instead of pauses

   • Mix_HaltChannel - Again, specify the channel or -1 for all channels

   • Mix_ExpireChannel - Like Mix_FadeOutChannel, but without a fade-out

   • Mix_FadeOutChannel - Fades out and halts whatever is playing on the specified channel over ms milliseconds

   • Mix_ChannelFinished - Sets the callback function for when a channel finishes with its chunk

   • Mix_Playing

   • Mix_Paused

   • Mix_FadingChannel

   • Mix_GetChunk

4. Groups

   • Mix_ReserveChannels

   • Mix_GroupChannel

   • Mix_GroupChannels

   • Mix_GroupCount

   • Mix_GroupAvailable

   • Mix_GroupOldest

   • Mix_GroupNewer

   • Mix_FadeOutGroup

   • Mix_HaltGroup

5. Music

   • Mix_LoadMUS

   • Mix_FreeMusic

   • Mix_PlayMusic

   • Mix_FadeInMusic

   • Mix_FadeInMusicPos

   • Mix_HookMusic

   • Mix_VolumeMusic - Set the volume of ONLY the designated music track

   • Mix_PauseMusic

   • Mix_ResumeMusic

   • Mix_RewindMusic

   • Mix_SetMusicPosition

   • Mix_SetMusicCMD

   • Mix_HaltMusic

   • Mix_FadeOutMusic

   • Mix_HookMusicFinished

   • Mix_GetMusicType

   • Mix_PlayingMusic

   • Mix_PausedMusic

   • Mix_FadingMusic

   • Mix_GetMusicHookData

6. Effects

   • Mix_RegisterEffect

   • Mix_UnregisterEffect

   • Mix_UnregisterAllEffects

   • Mix_SetPostMix

   • Mix_SetPanning

   • Mix_SetDistance

   • Mix_SetPosition

   • Mix_SetReverseStereo

7. Types

   • Mix_Music - Represents a real-time decoded (if necessary) music stream (I think)

   • Mix_Chunk - Represents a sound sample loaded in memory

   • Mix_MusicType

   • Mix_Fading

   • Mix_EffectFunc_t

   • Mix_EffectDone_t

8. Defines

   • SDL_mixer_Defines - A list of defines usable in SDL_mixer