Tao.Sdl SDK Documentation

SdlMixer Methods

The methods of the SdlMixer class are listed below. For a complete list of SdlMixer class members, see the SdlMixer Members topic.

Public Static (Shared) Methods

Mix_AllocateChannels Dynamically change the number of channels managed by the mixer. If decreasing the number of channels, the upper channels are stopped. This function returns the new number of allocated channels.
Mix_ChannelFinished Set callback for when channel finishes playing
Mix_CloseAudio Close sound mixer
Mix_ExpireChannel Change the timed stoppage of a channel
Mix_FadeInChannel Play loop with fade in
Mix_FadeInChannelTimed Play loop with fade in and limit by time
Mix_FadeInMusic Play music, with looping, and fade in
Mix_FadeInMusicPos Play music from a start point, with looping, and fade in
Mix_FadeOutChannel Stop playing channel after timed fade out
Mix_FadeOutGroup Fade out a group over time
Mix_FadeOutMusic Stop music, with fade out
Mix_FadingChannel Get the fade status of a channel
Mix_FadingMusic Get status of current music fade activity
Mix_FreeChunk Free an audio chunk previously loaded
Mix_FreeMusic Free a Mix_Music
Mix_GetChunk Get the sample playing on a channel
Mix_GetError Get the current error string
Mix_GetMusicHookData Get a pointer to the user data for the current music hook
Mix_GetMusicType Find out the music format of a mixer music, or the currently playing music, if 'music' is NULL.
Mix_GetSynchroValue Synchro value is set by MikMod from modules while playing
Mix_GroupAvailable Get first inactive channel in group.
Mix_GroupChannel Add/remove channel to/from group
Mix_GroupChannels Assign several consecutive channels to a group
Mix_GroupCount Get number of channels in group.
Mix_GroupNewer Get youngest busy channel in group
Mix_GroupOldest Get oldest busy channel in group
Mix_HaltChannel Stop playing on a channel
Mix_HaltGroup Stop a group
Mix_HaltMusic Stop music playback
Mix_HookMusic Hook for a custom music player
Mix_HookMusicFinished Add your own callback when the music has finished playing. This callback is only called if the music finishes naturally.
Mix_Linked_Version Using this you can compare the runtime version to the version that you compiled with.
Mix_LoadMUS Load a music file into a Mix_Music
Mix_LoadMUS_RW Load a music file from an SDL_RWop object (Ogg and MikMod specific currently)
Mix_LoadWAV Load WAV from a file.
Mix_LoadWAV_RW Load a wave file or a music (.mod .s3m .it .xm) file
Mix_OpenAudio Open the mixer with a certain audio format
Mix_Pause Pause a particular channel
Mix_Paused Get the pause status of a channel
Mix_PausedMusic Test whether music is paused
Mix_PauseMusic Pause music
Mix_PlayChannel Play loop.
Mix_PlayChannelTimed Play loop and limit by time.
Mix_Playing Get the active playing status of a channel
Mix_PlayingMusic Test whether music is playing
Mix_PlayMusic Play music, with looping
Mix_QuerySpec Get output format.
Mix_QuickLoad_RAW Load raw audio data of the mixer format from a memory buffer
Mix_QuickLoad_WAV Load a wave file of the mixer format from a memory buffer
Mix_RegisterEffect Hook a processor to a channel
Mix_ReserveChannels Prevent channels from being used in default group
Mix_Resume Resume a paused channel
Mix_ResumeMusic Resume paused music
Mix_RewindMusic Rewind music to beginning
Mix_SetDistance Distance attenuation (volume)
Mix_SetError Set the current error string
Mix_SetMusicCMD Use external program for music playback
Mix_SetMusicPosition Set position of playback in stream.
Mix_SetPanning Stereo panning
Mix_SetPosition Panning(angular) and distance
Mix_SetPostMix Hook in a postmix processor
Mix_SetReverseStereo Swap stereo left and right
Mix_SetSynchroValue Synchro value is set by MikMod from modules while playing
Mix_UnregisterAllEffects Unhook all processors from a channel
Mix_UnregisterEffect Unhook a processor from a channel
MIX_VERSION This method can be used to fill a version structure with the compile-time version of the SDL_mixer library.
Mix_Volume Set the mix volume of a channel
Mix_VolumeChunk Set mix volume
Mix_VolumeMusic Set music volume

Public Instance Methods

Equals (inherited from Object) 
GetHashCode (inherited from Object) 
GetType (inherited from Object) 
ToString (inherited from Object) 

See Also

SdlMixer Class | Tao.Sdl Namespace