SDL3_mixer

This page is under development.

SDL3_mixer.MIX_AudioFramesToMS(audio: LP_MIX_Audio, frames: c_int64) → c_int64

Convert sample frames for a MIX_Audio’s format to milliseconds.

SDL3_mixer.MIX_AudioMSToFrames(audio: LP_MIX_Audio, ms: c_int64) → c_int64

Convert milliseconds to sample frames for a MIX_Audio’s format.

SDL3_mixer.MIX_CreateAudioDecoder(path: c_char_p, props: SDL_PropertiesID) → LP_MIX_AudioDecoder

Create a MIX_AudioDecoder from a path on the filesystem.

SDL3_mixer.MIX_CreateAudioDecoder_IO(io: LP_SDL_IOStream, closeio: c_bool, props: SDL_PropertiesID) → LP_MIX_AudioDecoder

Create a MIX_AudioDecoder from an SDL_IOStream.

SDL3_mixer.MIX_CreateGroup(mixer: LP_MIX_Mixer) → LP_MIX_Group

Create a mixing group.

SDL3_mixer.MIX_CreateMixer(spec: LP_SDL_AudioSpec) → LP_MIX_Mixer

Create a mixer that generates audio to a memory buffer.

SDL3_mixer.MIX_CreateMixerDevice(devid: SDL_AudioDeviceID, spec: LP_SDL_AudioSpec) → LP_MIX_Mixer

Create a mixer that plays sound directly to an audio device.

SDL3_mixer.MIX_CreateSineWaveAudio(mixer: LP_MIX_Mixer, hz: c_int, amplitude: c_float, ms: c_int64) → LP_MIX_Audio

Create a MIX_Audio that generates a sinewave.

SDL3_mixer.MIX_CreateTrack(mixer: LP_MIX_Mixer) → LP_MIX_Track

Create a new track on a mixer.

SDL3_mixer.MIX_DecodeAudio(audiodecoder: LP_MIX_AudioDecoder, buffer: c_void_p, buflen: c_int, spec: LP_SDL_AudioSpec) → c_int

Decode more audio from a MIX_AudioDecoder.

SDL3_mixer.MIX_DestroyAudio(audio: LP_MIX_Audio) → None

Destroy the specified audio.

SDL3_mixer.MIX_DestroyAudioDecoder(audiodecoder: LP_MIX_AudioDecoder) → None

Destroy the specified audio decoder.

SDL3_mixer.MIX_DestroyGroup(group: LP_MIX_Group) → None

Destroy a mixing group.

SDL3_mixer.MIX_DestroyMixer(mixer: LP_MIX_Mixer) → None

Free a mixer.

SDL3_mixer.MIX_DestroyTrack(track: LP_MIX_Track) → None

Destroy the specified track.

SDL3_mixer.MIX_FramesToMS(sample_rate: c_int, frames: c_int64) → c_int64

Convert sample frames, at a specific sample rate, to milliseconds.

SDL3_mixer.MIX_Generate(mixer: LP_MIX_Mixer, buffer: c_void_p, buflen: c_int) → c_int

Generate mixer output when not driving an audio device.

SDL3_mixer.MIX_GetAudioDecoder(index: c_int) → c_char_p

Report the name of a specific audio decoders.

SDL3_mixer.MIX_GetAudioDecoderFormat(audiodecoder: LP_MIX_AudioDecoder, spec: LP_SDL_AudioSpec) → c_bool

Query the initial audio format of a MIX_AudioDecoder.

SDL3_mixer.MIX_GetAudioDecoderProperties(audiodecoder: LP_MIX_AudioDecoder) → SDL_PropertiesID

Get the properties associated with a MIX_AudioDecoder.

SDL3_mixer.MIX_GetAudioDuration(audio: LP_MIX_Audio) → c_int64

Get the length of a MIX_Audio’s playback in sample frames.

SDL3_mixer.MIX_GetAudioFormat(audio: LP_MIX_Audio, spec: LP_SDL_AudioSpec) → c_bool

Query the initial audio format of a MIX_Audio.

SDL3_mixer.MIX_GetAudioProperties(audio: LP_MIX_Audio) → SDL_PropertiesID

Get the properties associated with a MIX_Audio.

SDL3_mixer.MIX_GetGroupMixer(group: LP_MIX_Group) → LP_MIX_Mixer

Get the MIX_Mixer that owns a MIX_Group.

SDL3_mixer.MIX_GetGroupProperties(group: LP_MIX_Group) → SDL_PropertiesID

Get the properties associated with a group.

SDL3_mixer.MIX_GetMixerFormat(mixer: LP_MIX_Mixer, spec: LP_SDL_AudioSpec) → c_bool

Get the audio format a mixer is generating.

SDL3_mixer.MIX_GetMixerFrequencyRatio(mixer: LP_MIX_Mixer) → c_float

Get a mixer’s master frequency ratio.

SDL3_mixer.MIX_GetMixerGain(mixer: LP_MIX_Mixer) → c_float

Get a mixer’s master gain control.

SDL3_mixer.MIX_GetMixerProperties(mixer: LP_MIX_Mixer) → SDL_PropertiesID

Get the properties associated with a mixer.

SDL3_mixer.MIX_GetNumAudioDecoders() → c_int

Report the number of audio decoders available for use.

SDL3_mixer.MIX_GetTaggedTracks(mixer: LP_MIX_Mixer, tag: c_char_p, count: LP_c_int) → LP_LP_MIX_Track

Get all tracks with a specific tag.

SDL3_mixer.MIX_GetTrack3DPosition(track: LP_MIX_Track, position: LP_MIX_Point3D) → c_bool

Get a track’s current position in 3D space.

SDL3_mixer.MIX_GetTrackAudio(track: LP_MIX_Track) → LP_MIX_Audio

Query the MIX_Audio assigned to a track.

SDL3_mixer.MIX_GetTrackAudioStream(track: LP_MIX_Track) → LP_SDL_AudioStream

Query the SDL_AudioStream assigned to a track.

SDL3_mixer.MIX_GetTrackFadeFrames(track: LP_MIX_Track) → c_int64

Query whether a given track is fading.

SDL3_mixer.MIX_GetTrackFrequencyRatio(track: LP_MIX_Track) → c_float

Query the frequency ratio of a track.

SDL3_mixer.MIX_GetTrackGain(track: LP_MIX_Track) → c_float

Get a track’s gain control.

SDL3_mixer.MIX_GetTrackLoops(track: LP_MIX_Track) → c_int

Query how many loops remain for a given track.

SDL3_mixer.MIX_GetTrackMixer(track: LP_MIX_Track) → LP_MIX_Mixer

Get the MIX_Mixer that owns a MIX_Track.

SDL3_mixer.MIX_GetTrackPlaybackPosition(track: LP_MIX_Track) → c_int64

Get the current input position of a playing track.

SDL3_mixer.MIX_GetTrackProperties(track: LP_MIX_Track) → SDL_PropertiesID

Get the properties associated with a track.

SDL3_mixer.MIX_GetTrackRemaining(track: LP_MIX_Track) → c_int64

Return the number of sample frames remaining to be mixed in a track.

SDL3_mixer.MIX_GetTrackTags(track: LP_MIX_Track, count: LP_c_int) → LP_c_char_p

Get the tags currently associated with a track.

SDL3_mixer.MIX_Init() → c_bool

Initialize the SDL_mixer library.

SDL3_mixer.MIX_LoadAudio(mixer: LP_MIX_Mixer, path: c_char_p, predecode: c_bool) → LP_MIX_Audio

Load audio for playback from a file.

SDL3_mixer.MIX_LoadAudioNoCopy(mixer: LP_MIX_Mixer, data: c_void_p, datalen: c_size_t, free_when_done: c_bool) → LP_MIX_Audio

Load audio for playback from a memory buffer without making a copy.

SDL3_mixer.MIX_LoadAudioWithProperties(props: SDL_PropertiesID) → LP_MIX_Audio

Load audio for playback through a collection of properties.

SDL3_mixer.MIX_LoadAudio_IO(mixer: LP_MIX_Mixer, io: LP_SDL_IOStream, predecode: c_bool, closeio: c_bool) → LP_MIX_Audio

Load audio for playback from an SDL_IOStream.

SDL3_mixer.MIX_LoadRawAudio(mixer: LP_MIX_Mixer, data: c_void_p, datalen: c_size_t, spec: LP_SDL_AudioSpec) → LP_MIX_Audio

Load raw PCM data from a memory buffer.

SDL3_mixer.MIX_LoadRawAudioNoCopy(mixer: LP_MIX_Mixer, data: c_void_p, datalen: c_size_t, spec: LP_SDL_AudioSpec, free_when_done: c_bool) → LP_MIX_Audio

Load raw PCM data from a memory buffer without making a copy.

SDL3_mixer.MIX_LoadRawAudio_IO(mixer: LP_MIX_Mixer, io: LP_SDL_IOStream, spec: LP_SDL_AudioSpec, closeio: c_bool) → LP_MIX_Audio

Load raw PCM data from an SDL_IOStream.

SDL3_mixer.MIX_LockMixer(mixer: LP_MIX_Mixer) → None

Lock a mixer by obtaining its internal mutex.

SDL3_mixer.MIX_MSToFrames(sample_rate: c_int, ms: c_int64) → c_int64

Convert milliseconds to sample frames at a specific sample rate.

SDL3_mixer.MIX_PauseAllTracks(mixer: LP_MIX_Mixer) → c_bool

Pause all currently-playing tracks.

SDL3_mixer.MIX_PauseTag(mixer: LP_MIX_Mixer, tag: c_char_p) → c_bool

Pause all tracks with a specific tag.

SDL3_mixer.MIX_PauseTrack(track: LP_MIX_Track) → c_bool

Pause a currently-playing track.

SDL3_mixer.MIX_PlayAudio(mixer: LP_MIX_Mixer, audio: LP_MIX_Audio) → c_bool

Play a MIX_Audio from start to finish without any management.

SDL3_mixer.MIX_PlayTag(mixer: LP_MIX_Mixer, tag: c_char_p, options: SDL_PropertiesID) → c_bool

Start (or restart) mixing all tracks with a specific tag for playback.

SDL3_mixer.MIX_PlayTrack(track: LP_MIX_Track, options: SDL_PropertiesID) → c_bool

Start (or restart) mixing a track for playback.

SDL3_mixer.MIX_Quit() → None

Deinitialize the SDL_mixer library.

SDL3_mixer.MIX_ResumeAllTracks(mixer: LP_MIX_Mixer) → c_bool

Resume all currently-paused tracks.

SDL3_mixer.MIX_ResumeTag(mixer: LP_MIX_Mixer, tag: c_char_p) → c_bool

Resume all tracks with a specific tag.

SDL3_mixer.MIX_ResumeTrack(track: LP_MIX_Track) → c_bool

Resume a currently-paused track.

SDL3_mixer.MIX_SetGroupPostMixCallback(group: LP_MIX_Group, cb: CFunctionType, userdata: c_void_p) → c_bool

Set a callback that fires when a mixer group has completed mixing.

SDL3_mixer.MIX_SetMixerFrequencyRatio(mixer: LP_MIX_Mixer, ratio: c_float) → c_bool

Set a mixer’s master frequency ratio.

SDL3_mixer.MIX_SetMixerGain(mixer: LP_MIX_Mixer, gain: c_float) → c_bool

Set a mixer’s master gain control.

SDL3_mixer.MIX_SetPostMixCallback(mixer: LP_MIX_Mixer, cb: CFunctionType, userdata: c_void_p) → c_bool

Set a callback that fires when all mixing has completed.

SDL3_mixer.MIX_SetTagGain(mixer: LP_MIX_Mixer, tag: c_char_p, gain: c_float) → c_bool

Set the gain control of all tracks with a specific tag.

SDL3_mixer.MIX_SetTrack3DPosition(track: LP_MIX_Track, position: LP_MIX_Point3D) → c_bool

Set a track’s position in 3D space.

SDL3_mixer.MIX_SetTrackAudio(track: LP_MIX_Track, audio: LP_MIX_Audio) → c_bool

Set a MIX_Track’s input to a MIX_Audio.

SDL3_mixer.MIX_SetTrackAudioStream(track: LP_MIX_Track, stream: LP_SDL_AudioStream) → c_bool

Set a MIX_Track’s input to an SDL_AudioStream.

SDL3_mixer.MIX_SetTrackCookedCallback(track: LP_MIX_Track, cb: CFunctionType, userdata: c_void_p) → c_bool

Set a callback that fires when the mixer has transformed a track’s audio.

SDL3_mixer.MIX_SetTrackFrequencyRatio(track: LP_MIX_Track, ratio: c_float) → c_bool

Change the frequency ratio of a track.

SDL3_mixer.MIX_SetTrackGain(track: LP_MIX_Track, gain: c_float) → c_bool

Set a track’s gain control.

SDL3_mixer.MIX_SetTrackGroup(track: LP_MIX_Track, group: LP_MIX_Group) → c_bool

Assign a track to a mixing group.

SDL3_mixer.MIX_SetTrackIOStream(track: LP_MIX_Track, io: LP_SDL_IOStream, closeio: c_bool) → c_bool

Set a MIX_Track’s input to an SDL_IOStream.

SDL3_mixer.MIX_SetTrackLoops(track: LP_MIX_Track, num_loops: c_int) → c_bool

Change the number of times a currently-playing track will loop.

SDL3_mixer.MIX_SetTrackOutputChannelMap(track: LP_MIX_Track, chmap: LP_c_int, count: c_int) → c_bool

Set the current output channel map of a track.

SDL3_mixer.MIX_SetTrackPlaybackPosition(track: LP_MIX_Track, frames: c_int64) → c_bool

Seek a playing track to a new position in its input.

SDL3_mixer.MIX_SetTrackRawCallback(track: LP_MIX_Track, cb: CFunctionType, userdata: c_void_p) → c_bool

Set a callback that fires when a MIX_Track has initial decoded audio.

SDL3_mixer.MIX_SetTrackRawIOStream(track: LP_MIX_Track, io: LP_SDL_IOStream, spec: LP_SDL_AudioSpec, closeio: c_bool) → c_bool

Set a MIX_Track’s input to an SDL_IOStream providing raw PCM data.

SDL3_mixer.MIX_SetTrackStereo(track: LP_MIX_Track, gains: LP_MIX_StereoGains) → c_bool

Force a track to stereo output, with optionally left/right panning.

SDL3_mixer.MIX_SetTrackStoppedCallback(track: LP_MIX_Track, cb: CFunctionType, userdata: c_void_p) → c_bool

Set a callback that fires when a MIX_Track is stopped.

SDL3_mixer.MIX_StopAllTracks(mixer: LP_MIX_Mixer, fade_out_ms: c_int64) → c_bool

Halt all currently-playing tracks, possibly fading out over time.

SDL3_mixer.MIX_StopTag(mixer: LP_MIX_Mixer, tag: c_char_p, fade_out_ms: c_int64) → c_bool

Halt all tracks with a specific tag, possibly fading out over time.

SDL3_mixer.MIX_StopTrack(track: LP_MIX_Track, fade_out_frames: c_int64) → c_bool

Halt a currently-playing track, possibly fading out over time.

SDL3_mixer.MIX_TagTrack(track: LP_MIX_Track, tag: c_char_p) → c_bool

Assign an arbitrary tag to a track.

SDL3_mixer.MIX_TrackFramesToMS(track: LP_MIX_Track, frames: c_int64) → c_int64

Convert sample frames for a track’s current format to milliseconds.

SDL3_mixer.MIX_TrackMSToFrames(track: LP_MIX_Track, ms: c_int64) → c_int64

Convert milliseconds to sample frames for a track’s current format.

SDL3_mixer.MIX_TrackPaused(track: LP_MIX_Track) → c_bool

Query if a track is currently paused.

SDL3_mixer.MIX_TrackPlaying(track: LP_MIX_Track) → c_bool

Query if a track is currently playing.

SDL3_mixer.MIX_UnlockMixer(mixer: LP_MIX_Mixer) → None

Unlock a mixer previously locked by a call to MIX_LockMixer().

SDL3_mixer.MIX_UntagTrack(track: LP_MIX_Track, tag: c_char_p) → None

Remove an arbitrary tag from a track.

SDL3_mixer.MIX_Version() → c_int

Get the version of SDL_mixer that is linked against your program.