📦 libsdl3-mixer-doc

110 pages

M

MIX_Audio(3type)An opaque object that represents audio data.✨
MIX_AudioDecoder(3type)An opaque object that represents an audio decoder.✨
MIX_AudioFramesToMS(3)Convert sample frames for a MIX_Audio's format to milliseconds.✨
MIX_AudioMSToFrames(3)Convert milliseconds to sample frames for a MIX_Audio's format.✨
MIX_CreateAudioDecoder(3)Create a MIX_AudioDecoder from a path on the filesystem.✨
MIX_CreateAudioDecoder_IO(3)Create a MIX_AudioDecoder from an SDL_IOStream.✨
MIX_CreateGroup(3)Create a mixing group.✨
MIX_CreateMixer(3)Create a mixer that generates audio to a memory buffer.✨
MIX_CreateMixerDevice(3)Create a mixer that plays sound directly to an audio device.✨
MIX_CreateSineWaveAudio(3)Create a MIX_Audio that generates a sinewave.✨
MIX_CreateTrack(3)Create a new track on a mixer.✨
MIX_DecodeAudio(3)Decode more audio from a MIX_AudioDecoder.✨
MIX_DestroyAudio(3)Destroy the specified audio.✨
MIX_DestroyAudioDecoder(3)Destroy the specified audio decoder.✨
MIX_DestroyGroup(3)Destroy a mixing group.✨
MIX_DestroyMixer(3)Free a mixer.✨
MIX_DestroyTrack(3)Destroy the specified track.✨
MIX_FramesToMS(3)Convert sample frames, at a specific sample rate, to milliseconds.✨
MIX_Generate(3)Generate mixer output when not driving an audio device.✨
MIX_GetAudioDecoder(3)Report the name of a specific audio decoders.✨
MIX_GetAudioDecoderFormat(3)Query the initial audio format of a MIX_AudioDecoder.✨
MIX_GetAudioDecoderProperties(3)Get the properties associated with a MIX_AudioDecoder.✨
MIX_GetAudioDuration(3)Get the length of a MIX_Audio's playback in sample frames.✨
MIX_GetAudioFormat(3)Query the initial audio format of a MIX_Audio.✨
MIX_GetAudioProperties(3)Get the properties associated with a MIX_Audio.✨
MIX_GetGroupMixer(3)Get the MIX_Mixer that owns a MIX_Group.✨
MIX_GetGroupProperties(3)Get the properties associated with a group.✨
MIX_GetMixerFormat(3)Get the audio format a mixer is generating.✨
MIX_GetMixerFrequencyRatio(3)Get a mixer's master frequency ratio.✨
MIX_GetMixerGain(3)Get a mixer's master gain control.✨
MIX_GetMixerProperties(3)Get the properties associated with a mixer.✨
MIX_GetNumAudioDecoders(3)Report the number of audio decoders available for use.✨
MIX_GetTaggedTracks(3)Get all tracks with a specific tag.✨
MIX_GetTrack3DPosition(3)Get a track's current position in 3D space.✨
MIX_GetTrackAudio(3)Query the MIX_Audio assigned to a track.✨
MIX_GetTrackAudioStream(3)Query the SDL_AudioStream assigned to a track.✨
MIX_GetTrackFadeFrames(3)Query whether a given track is fading.✨
MIX_GetTrackFrequencyRatio(3)Query the frequency ratio of a track.✨
MIX_GetTrackGain(3)Get a track's gain control.✨
MIX_GetTrackLoops(3)Query how many loops remain for a given track.✨
MIX_GetTrackMixer(3)Get the MIX_Mixer that owns a MIX_Track.✨
MIX_GetTrackPlaybackPosition(3)Get the current input position of a playing track.✨
MIX_GetTrackProperties(3)Get the properties associated with a track.✨
MIX_GetTrackRemaining(3)Return the number of sample frames remaining to be mixed in a track.✨
MIX_GetTrackTags(3)Get the tags currently associated with a track.✨
MIX_Group(3type)An opaque object that represents a grouping of tracks.✨
MIX_GroupMixCallback(3type)A callback that fires when a MIX_Group has completed mixing.✨
MIX_Init(3)Initialize the SDL_mixer library.✨
MIX_LoadAudio(3)Load audio for playback from a file.✨
MIX_LoadAudio_IO(3)Load audio for playback from an SDL_IOStream.✨
MIX_LoadAudioNoCopy(3)Load audio for playback from a memory buffer without making a copy.✨
MIX_LoadAudioWithProperties(3)Load audio for playback through a collection of properties.✨
MIX_LoadRawAudio(3)Load raw PCM data from a memory buffer.✨
MIX_LoadRawAudio_IO(3)Load raw PCM data from an SDL_IOStream.✨
MIX_LoadRawAudioNoCopy(3)Load raw PCM data from a memory buffer without making a copy.✨
MIX_LockMixer(3)Lock a mixer by obtaining its internal mutex.✨
MIX_Mixer(3type)An opaque object that represents a mixer.✨
MIX_MSToFrames(3)Convert milliseconds to sample frames at a specific sample rate.✨
MIX_PauseAllTracks(3)Pause all currently-playing tracks.✨
MIX_PauseTag(3)Pause all tracks with a specific tag.✨
MIX_PauseTrack(3)Pause a currently-playing track.✨
MIX_PlayAudio(3)Play a MIX_Audio from start to finish without any management.✨
MIX_PlayTag(3)Start (or restart) mixing all tracks with a specific tag for playback.✨
MIX_PlayTrack(3)Start (or restart) mixing a track for playback.✨
MIX_Point3D(3type)3D coordinates for MIX_SetTrack3DPosition.✨
MIX_PostMixCallback(3type)A callback that fires when all mixing has completed.✨
MIX_Quit(3)Deinitialize the SDL_mixer library.✨
MIX_ResumeAllTracks(3)Resume all currently-paused tracks.✨
MIX_ResumeTag(3)Resume all tracks with a specific tag.✨
MIX_ResumeTrack(3)Resume a currently-paused track.✨
MIX_SetGroupPostMixCallback(3)Set a callback that fires when a mixer group has completed mixing.✨
MIX_SetMixerFrequencyRatio(3)Set a mixer's master frequency ratio.✨
MIX_SetMixerGain(3)Set a mixer's master gain control.✨
MIX_SetPostMixCallback(3)Set a callback that fires when all mixing has completed.✨
MIX_SetTagGain(3)Set the gain control of all tracks with a specific tag.✨
MIX_SetTrack3DPosition(3)Set a track's position in 3D space.✨
MIX_SetTrackAudio(3)Set a MIX_Track's input to a MIX_Audio.✨
MIX_SetTrackAudioStream(3)Set a MIX_Track's input to an SDL_AudioStream.✨
MIX_SetTrackCookedCallback(3)Set a callback that fires when the mixer has transformed a track's audio.✨
MIX_SetTrackFrequencyRatio(3)Change the frequency ratio of a track.✨
MIX_SetTrackGain(3)Set a track's gain control.✨
MIX_SetTrackGroup(3)Assign a track to a mixing group.✨
MIX_SetTrackIOStream(3)Set a MIX_Track's input to an SDL_IOStream.✨
MIX_SetTrackLoops(3)Change the number of times a currently-playing track will loop.✨
MIX_SetTrackOutputChannelMap(3)Set the current output channel map of a track.✨
MIX_SetTrackPlaybackPosition(3)Seek a playing track to a new position in its input.✨
MIX_SetTrackRawCallback(3)Set a callback that fires when a MIX_Track has initial decoded audio.✨
MIX_SetTrackRawIOStream(3)Set a MIX_Track's input to an SDL_IOStream providing raw PCM data.✨
MIX_SetTrackStereo(3)Force a track to stereo output, with optionally left/right panning.✨
MIX_SetTrackStoppedCallback(3)Set a callback that fires when a MIX_Track is stopped.✨
MIX_StereoGains(3type)A set of per-channel gains for tracks using MIX_SetTrackStereo().✨
MIX_StopAllTracks(3)Halt all currently-playing tracks, possibly fading out over time.✨
MIX_StopTag(3)Halt all tracks with a specific tag, possibly fading out over time.✨
MIX_StopTrack(3)Halt a currently-playing track, possibly fading out over time.✨
MIX_TagTrack(3)Assign an arbitrary tag to a track.✨
MIX_Track(3type)An opaque object that represents a source of sound output to be mixed.✨
MIX_TrackFramesToMS(3)Convert sample frames for a track's current format to milliseconds.✨
MIX_TrackMixCallback(3type)A callback that fires when a MIX_Track is mixing at various stages.✨
MIX_TrackMSToFrames(3)Convert milliseconds to sample frames for a track's current format.✨
MIX_TrackPaused(3)Query if a track is currently paused.✨
MIX_TrackPlaying(3)Query if a track is currently playing.✨
MIX_TrackStoppedCallback(3type)A callback that fires when a MIX_Track is stopped.✨
MIX_UnlockMixer(3)Unlock a mixer previously locked by a call to MIX_LockMixer().✨
MIX_UntagTrack(3)Remove an arbitrary tag from a track.✨
MIX_Version(3)Get the version of SDL_mixer that is linked against your program.✨

S

SDL_MIXER_MAJOR_VERSION(3)The current major version of SDL_mixer headers.✨
SDL_MIXER_MICRO_VERSION(3)The current micro (or patchlevel) version of the SDL_mixer headers.✨
SDL_MIXER_MINOR_VERSION(3)The current minor version of the SDL_mixer headers.✨
SDL_MIXER_VERSION(3)This is the current version number macro of the SDL_mixer headers.✨
SDL_MIXER_VERSION_ATLEAST(3)This macro will evaluate to true if compiled with SDL_mixer at least X.Y.Z.✨