sdl3/sdl_mixer library

Classes

MixAudio

MixAudioDecoder

MixGroup

MixMixer

MixPoint3D

MixStereoGains

MixTrack

Extensions

MixAudioDecoderEx on MixAudioDecoder

MixAudioDecoderPointerEx on Pointer<MixAudioDecoder>

MixAudioPointerEx on Pointer<MixAudio>

MixGroupPointerEx on Pointer<MixGroup>

MixMixerEx on MixMixer

MixMixerPointerEx on Pointer<MixMixer>

MixTrackPointerEx on Pointer<MixTrack>

Functions

mixAudioFramesToMs(Pointer<MixAudio> audio, int frames) → int

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

mixAudioMsToFrames(Pointer<MixAudio> audio, int ms) → int

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

mixClearError() → bool

const Mix_ClearError = SDL_ClearError;

mixCreateAudioDecoder(String? path, int props) → Pointer<MixAudioDecoder>

Create a MIX_AudioDecoder from a path on the filesystem.

mixCreateAudioDecoderIo(Pointer<SdlIoStream> io, bool closeio, int props) → Pointer<MixAudioDecoder>

Create a MIX_AudioDecoder from an SDL_IOStream.

mixCreateGroup(Pointer<MixMixer> mixer) → Pointer<MixGroup>

Create a mixing group.

mixCreateMixer(Pointer<SdlAudioSpec> spec) → Pointer<MixMixer>

Create a mixer that generates audio to a memory buffer.

mixCreateMixerDevice(int devid, Pointer<SdlAudioSpec> spec) → Pointer<MixMixer>

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

mixCreateSineWaveAudio(Pointer<MixMixer> mixer, int hz, double amplitude) → Pointer<MixAudio>

Create a MIX_Audio that generates a sinewave.

mixCreateTrack(Pointer<MixMixer> mixer) → Pointer<MixTrack>

Create a new track on a mixer.

mixDecodeAudio(Pointer<MixAudioDecoder> audiodecoder, Pointer<NativeType> buffer, int buflen, Pointer<SdlAudioSpec> spec) → int

Decode more audio from a MIX_AudioDecoder.

mixDestroyAudio(Pointer<MixAudio> audio) → void

Destroy the specified audio.

mixDestroyAudioDecoder(Pointer<MixAudioDecoder> audiodecoder) → void

Destroy the specified audio decoder.

mixDestroyGroup(Pointer<MixGroup> group) → void

Destroy a mixing group.

mixDestroyMixer(Pointer<MixMixer> mixer) → void

Free a mixer.

mixDestroyTrack(Pointer<MixTrack> track) → void

Destroy the specified track.

mixFramesToMs(int sampleRate, int frames) → int

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

mixGenerate(Pointer<MixMixer> mixer, Pointer<NativeType> buffer, int buflen) → bool

Generate mixer output when not driving an audio device.

mixGetAudioDecoder(int index) → String?

Report the name of a specific audio decoders.

mixGetAudioDecoderFormat(Pointer<MixAudioDecoder> audiodecoder, Pointer<SdlAudioSpec> spec) → bool

Query the initial audio format of a MIX_AudioDecoder.

mixGetAudioDecoderProperties(Pointer<MixAudioDecoder> audiodecoder) → int

Get the properties associated with a MIX_AudioDecoder.

mixGetAudioDuration(Pointer<MixAudio> audio) → int

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

mixGetAudioFormat(Pointer<MixAudio> audio, Pointer<SdlAudioSpec> spec) → bool

Query the initial audio format of a MIX_Audio.

mixGetAudioProperties(Pointer<MixAudio> audio) → int

Get the properties associated with a MIX_Audio.

mixGetError() → String?

const Mix_GetError = SDL_GetError;

mixGetGroupMixer(Pointer<MixGroup> group) → Pointer<MixMixer>

Get the MIX_Mixer that owns a MIX_Group.

mixGetGroupProperties(Pointer<MixGroup> group) → int

Get the properties associated with a group.

mixGetMasterGain(Pointer<MixMixer> mixer) → double

Get a mixer's master gain control.

mixGetMixerFormat(Pointer<MixMixer> mixer, Pointer<SdlAudioSpec> spec) → bool

Get the audio format a mixer is generating.

mixGetMixerProperties(Pointer<MixMixer> mixer) → int

Get the properties associated with a mixer.

mixGetNumAudioDecoders() → int

Report the number of audio decoders available for use.

mixGetTrack3DPosition(Pointer<MixTrack> track, Pointer<MixPoint3D> position) → bool

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

mixGetTrackAudio(Pointer<MixTrack> track) → Pointer<MixAudio>

Query the MIX_Audio assigned to a track.

mixGetTrackAudioStream(Pointer<MixTrack> track) → Pointer<SdlAudioStream>

Query the SDL_AudioStream assigned to a track.

mixGetTrackFrequencyRatio(Pointer<MixTrack> track) → double

Query the frequency ratio of a track.

mixGetTrackGain(Pointer<MixTrack> track) → double

Get a track's gain control.

mixGetTrackMixer(Pointer<MixTrack> track) → Pointer<MixMixer>

Get the MIX_Mixer that owns a MIX_Track.

mixGetTrackPlaybackPosition(Pointer<MixTrack> track) → int

Get the current input position of a playing track.

mixGetTrackProperties(Pointer<MixTrack> track) → int

Get the properties associated with a track.

mixGetTrackRemaining(Pointer<MixTrack> track) → int

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

mixInit() → bool

Initialize the SDL_mixer library.

mixLoadAudio(Pointer<MixMixer> mixer, String? path, bool predecode) → Pointer<MixAudio>

Load audio for playback from a file.

mixLoadAudioIo(Pointer<MixMixer> mixer, Pointer<SdlIoStream> io, bool predecode, bool closeio) → Pointer<MixAudio>

Load audio for playback from an SDL_IOStream.

mixLoadAudioWithProperties(int props) → Pointer<MixAudio>

Load audio for playback through a collection of properties.

mixLoadRawAudio(Pointer<MixMixer> mixer, Pointer<NativeType> data, int datalen, Pointer<SdlAudioSpec> spec) → Pointer<MixAudio>

Load raw PCM data from a memory buffer.

mixLoadRawAudioIo(Pointer<MixMixer> mixer, Pointer<SdlIoStream> io, Pointer<SdlAudioSpec> spec, bool closeio) → Pointer<MixAudio>

Load raw PCM data from an SDL_IOStream.

mixLoadRawAudioNoCopy(Pointer<MixMixer> mixer, Pointer<NativeType> data, int datalen, Pointer<SdlAudioSpec> spec, bool freeWhenDone) → Pointer<MixAudio>

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

mixMsToFrames(int sampleRate, int ms) → int

Convert milliseconds to sample frames at a specific sample rate.

mixPauseAllTracks(Pointer<MixMixer> mixer) → bool

Pause all currently-playing tracks.

mixPauseTag(Pointer<MixMixer> mixer, String? tag) → bool

Pause all tracks with a specific tag.

mixPauseTrack(Pointer<MixTrack> track) → bool

Pause a currently-playing track.

mixPlayAudio(Pointer<MixMixer> mixer, Pointer<MixAudio> audio) → bool

Play a MIX_Audio from start to finish without any management.

mixPlayTag(Pointer<MixMixer> mixer, String? tag, int options) → bool

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

mixPlayTrack(Pointer<MixTrack> track, int options) → bool

Start (or restart) mixing a track for playback.

mixQuit() → void

Deinitialize the SDL_mixer library.

mixResumeAllTracks(Pointer<MixMixer> mixer) → bool

Resume all currently-paused tracks.

mixResumeTag(Pointer<MixMixer> mixer, String? tag) → bool

Resume all tracks with a specific tag.

mixResumeTrack(Pointer<MixTrack> track) → bool

Resume a currently-paused track.

mixSetError(String fmt) → bool

const MIX_MAX_VOLUME = SDL_MIX_MAXVOLUME;

mixSetGroupPostMixCallback(Pointer<MixGroup> group, Pointer<NativeFunction<MixGroupMixCallback>> cb, Pointer<NativeType> userdata) → bool

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

mixSetMasterGain(Pointer<MixMixer> mixer, double gain) → bool

Set a mixer's master gain control.

mixSetPostMixCallback(Pointer<MixMixer> mixer, Pointer<NativeFunction<MixPostMixCallback>> cb, Pointer<NativeType> userdata) → bool

Set a callback that fires when all mixing has completed.

mixSetTagGain(Pointer<MixMixer> mixer, String? tag, double gain) → bool

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

mixSetTrack3DPosition(Pointer<MixTrack> track, Pointer<MixPoint3D> position) → bool

Set a track's position in 3D space.

mixSetTrackAudio(Pointer<MixTrack> track, Pointer<MixAudio> audio) → bool

Set a MIX_Track's input to a MIX_Audio.

mixSetTrackAudioStream(Pointer<MixTrack> track, Pointer<SdlAudioStream> stream) → bool

Set a MIX_Track's input to an SDL_AudioStream.

mixSetTrackCookedCallback(Pointer<MixTrack> track, Pointer<NativeFunction<MixTrackMixCallback>> cb, Pointer<NativeType> userdata) → bool

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

mixSetTrackFrequencyRatio(Pointer<MixTrack> track, double ratio) → bool

Change the frequency ratio of a track.

mixSetTrackGain(Pointer<MixTrack> track, double gain) → bool

Set a track's gain control.

mixSetTrackGroup(Pointer<MixTrack> track, Pointer<MixGroup> group) → bool

Assign a track to a mixing group.

mixSetTrackIoStream(Pointer<MixTrack> track, Pointer<SdlIoStream> io, bool closeio) → bool

Set a MIX_Track's input to an SDL_IOStream.

mixSetTrackOutputChannelMap(Pointer<MixTrack> track, Pointer<Int32> chmap, int count) → bool

Set the current output channel map of a track.

mixSetTrackPlaybackPosition(Pointer<MixTrack> track, int frames) → bool

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

mixSetTrackRawCallback(Pointer<MixTrack> track, Pointer<NativeFunction<MixTrackMixCallback>> cb, Pointer<NativeType> userdata) → bool

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

mixSetTrackRawIoStream(Pointer<MixTrack> track, Pointer<SdlIoStream> io, Pointer<SdlAudioSpec> spec, bool closeio) → bool

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

mixSetTrackStereo(Pointer<MixTrack> track, Pointer<MixStereoGains> gains) → bool

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

mixSetTrackStoppedCallback(Pointer<MixTrack> track, Pointer<NativeFunction<MixTrackStoppedCallback>> cb, Pointer<NativeType> userdata) → bool

Set a callback that fires when a MIX_Track is stopped.

mixStopAllTracks(Pointer<MixMixer> mixer, int fadeOutMs) → bool

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

mixStopTag(Pointer<MixMixer> mixer, String? tag, int fadeOutMs) → bool

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

mixStopTrack(Pointer<MixTrack> track, int fadeOutFrames) → bool

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

mixTagTrack(Pointer<MixTrack> track, String? tag) → bool

Assign an arbitrary tag to a track.

mixTrackFramesToMs(Pointer<MixTrack> track, int frames) → int

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

mixTrackLooping(Pointer<MixTrack> track) → bool

Query whether a given track is looping.

mixTrackMsToFrames(Pointer<MixTrack> track, int ms) → int

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

mixTrackPaused(Pointer<MixTrack> track) → bool

Query if a track is currently paused.

mixTrackPlaying(Pointer<MixTrack> track) → bool

Query if a track is currently playing.

mixUntagTrack(Pointer<MixTrack> track, String? tag) → void

Remove an arbitrary tag from a track.

mixVersion() → int

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

sdlMixerVersionAtleast(int x, int y, int z) → bool

const SDL_MIXER_VERSION_ATLEAST = (X, Y, Z) \ (SDL_MIXER_COMPILEDVERSION >= SDL_VERSIONNUM(X, Y, Z));

Typedefs

MixGroupMixCallback = Void Function(Pointer<NativeType> userdata, Pointer<MixGroup> group, Pointer<SdlAudioSpec> spec, Pointer<Float> pcm, Int32 samples)

MixGroupMixCallbackDart = void Function(Pointer<NativeType> userdata, Pointer<MixGroup> group, Pointer<SdlAudioSpec> spec, Pointer<Float> pcm, int samples)

MixPostMixCallback = Void Function(Pointer<NativeType> userdata, Pointer<MixMixer> mixer, Pointer<SdlAudioSpec> spec, Pointer<Float> pcm, Int32 samples)

MixPostMixCallbackDart = void Function(Pointer<NativeType> userdata, Pointer<MixMixer> mixer, Pointer<SdlAudioSpec> spec, Pointer<Float> pcm, int samples)

MixTrackMixCallback = Void Function(Pointer<NativeType> userdata, Pointer<MixTrack> track, Pointer<SdlAudioSpec> spec, Pointer<Float> pcm, Int32 samples)

MixTrackMixCallbackDart = void Function(Pointer<NativeType> userdata, Pointer<MixTrack> track, Pointer<SdlAudioSpec> spec, Pointer<Float> pcm, int samples)

MixTrackStoppedCallback = Void Function(Pointer<NativeType> userdata, Pointer<MixTrack> track)

MixTrackStoppedCallbackDart = void Function(Pointer<NativeType> userdata, Pointer<MixTrack> track)