Skip to main content

Crate sdl_mixer_sys

Crate sdl_mixer_sys 

Source

Modules§

constants
Generated constants

Structs§

MIX_Audio
MIX_AudioDecoder
MIX_Group
MIX_Mixer
MIX_Point3D
3D coordinates for MIX_SetTrack3DPosition.
MIX_StereoGains
A set of per-channel gains for tracks using MIX_SetTrackStereo().
MIX_Track

Constants§

MIX_DURATION_INFINITE
MIX_DURATION_UNKNOWN
MIX_PROP_AUDIO_DECODER_STRING
MIX_PROP_AUDIO_LOAD_CLOSEIO_BOOLEAN
MIX_PROP_AUDIO_LOAD_IOSTREAM_POINTER
MIX_PROP_AUDIO_LOAD_PREDECODE_BOOLEAN
MIX_PROP_AUDIO_LOAD_PREFERRED_MIXER_POINTER
MIX_PROP_AUDIO_LOAD_SKIP_METADATA_TAGS_BOOLEAN
MIX_PROP_METADATA_ALBUM_STRING
MIX_PROP_METADATA_ARTIST_STRING
MIX_PROP_METADATA_COPYRIGHT_STRING
MIX_PROP_METADATA_DURATION_FRAMES_NUMBER
MIX_PROP_METADATA_DURATION_INFINITE_BOOLEAN
MIX_PROP_METADATA_TITLE_STRING
MIX_PROP_METADATA_TOTAL_TRACKS_NUMBER
MIX_PROP_METADATA_TRACK_NUMBER
MIX_PROP_METADATA_YEAR_NUMBER
MIX_PROP_MIXER_DEVICE_NUMBER
MIX_PROP_PLAY_APPEND_SILENCE_FRAMES_NUMBER
MIX_PROP_PLAY_APPEND_SILENCE_MILLISECONDS_NUMBER
MIX_PROP_PLAY_FADE_IN_FRAMES_NUMBER
MIX_PROP_PLAY_FADE_IN_MILLISECONDS_NUMBER
MIX_PROP_PLAY_FADE_IN_START_GAIN_FLOAT
MIX_PROP_PLAY_HALT_WHEN_EXHAUSTED_BOOLEAN
MIX_PROP_PLAY_LOOPS_NUMBER
MIX_PROP_PLAY_LOOP_START_FRAME_NUMBER
MIX_PROP_PLAY_LOOP_START_MILLISECOND_NUMBER
MIX_PROP_PLAY_MAX_FRAME_NUMBER
MIX_PROP_PLAY_MAX_MILLISECONDS_NUMBER
MIX_PROP_PLAY_START_FRAME_NUMBER
MIX_PROP_PLAY_START_MILLISECOND_NUMBER
MIX_PROP_PLAY_START_ORDER_NUMBER
SDL_MIXER_MAJOR_VERSION
SDL_MIXER_MICRO_VERSION
SDL_MIXER_MINOR_VERSION

Functions§

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

Type Aliases§

MIX_GroupMixCallback
A callback that fires when a MIX_Group has completed mixing.
MIX_PostMixCallback
A callback that fires when all mixing has completed.
MIX_TrackMixCallback
A callback that fires when a MIX_Track is mixing at various stages.
MIX_TrackStoppedCallback
A callback that fires when a MIX_Track is stopped.