sdl3/sdl_audio library

Classes

SdlxAudioSpec

Functions

sdlAudioDevicePaused(int devid) → bool audio
Use this function to query if an audio device is paused.
sdlAudioStreamDevicePaused(Pointer<SdlAudioStream> stream) → bool audio
Use this function to query if an audio device associated with a stream is paused.
sdlBindAudioStream(int devid, Pointer<SdlAudioStream> stream) → bool audio
Bind a single audio stream to an audio device.
sdlBindAudioStreams(int devid, Pointer<Pointer<SdlAudioStream>> streams, int numStreams) → bool audio
Bind a list of audio streams to an audio device.
sdlClearAudioStream(Pointer<SdlAudioStream> stream) → bool audio
Clear any pending data in the stream.
sdlCloseAudioDevice(int devid) → void audio
Close a previously-opened audio device.
sdlConvertAudioSamples(Pointer<SdlAudioSpec> srcSpec, Pointer<Uint8> srcData, int srcLen, Pointer<SdlAudioSpec> dstSpec, Pointer<Pointer<Uint8>> dstData, Pointer<Int32> dstLen) → bool audio
Convert some audio data of one format to another format.
sdlCreateAudioStream(Pointer<SdlAudioSpec> srcSpec, Pointer<SdlAudioSpec> dstSpec) → Pointer<SdlAudioStream> audio
Create a new audio stream.
sdlDestroyAudioStream(Pointer<SdlAudioStream> stream) → void audio
Free an audio stream.
sdlFlushAudioStream(Pointer<SdlAudioStream> stream) → bool audio
Tell the stream that you're done sending data, and anything being buffered should be converted/resampled and made available immediately.
sdlGetAudioDeviceChannelMap(int devid, Pointer<Int32> count) → Pointer<Int32> audio
Get the current channel map of an audio device.
sdlGetAudioDeviceFormat(int devid, Pointer<SdlAudioSpec> spec, Pointer<Int32> sampleFrames) → bool audio
Get the current audio format of a specific audio device.
sdlGetAudioDeviceGain(int devid) → double audio
Get the gain of an audio device.
sdlGetAudioDeviceName(int devid) → String? audio
Get the human-readable name of a specific audio device.
sdlGetAudioDeviceProperties(int devid) → int audio
Get the properties associated with an audio device.
sdlGetAudioDriver(int index) → String? audio
Use this function to get the name of a built in audio driver.
sdlGetAudioFormatName(int format) → String? audio
Get the human readable name of an audio format.
sdlGetAudioPlaybackDevices(Pointer<Int32> count) → Pointer<Uint32> audio
Get a list of currently-connected audio playback devices.
sdlGetAudioRecordingDevices(Pointer<Int32> count) → Pointer<Uint32> audio
Get a list of currently-connected audio recording devices.
sdlGetAudioStreamAvailable(Pointer<SdlAudioStream> stream) → int audio
Get the number of converted/resampled bytes available.
sdlGetAudioStreamData(Pointer<SdlAudioStream> stream, Pointer<Void> buf, int len) → int audio
Get converted/resampled data from the stream.
sdlGetAudioStreamDevice(Pointer<SdlAudioStream> stream) → int audio
Query an audio stream for its currently-bound device.
sdlGetAudioStreamFormat(Pointer<SdlAudioStream> stream, Pointer<SdlAudioSpec> srcSpec, Pointer<SdlAudioSpec> dstSpec) → bool audio
Query the current format of an audio stream.
sdlGetAudioStreamFrequencyRatio(Pointer<SdlAudioStream> stream) → double audio
Get the frequency ratio of an audio stream.
sdlGetAudioStreamGain(Pointer<SdlAudioStream> stream) → double audio
Get the gain of an audio stream.
sdlGetAudioStreamInputChannelMap(Pointer<SdlAudioStream> stream, Pointer<Int32> count) → Pointer<Int32> audio
Get the current input channel map of an audio stream.
sdlGetAudioStreamOutputChannelMap(Pointer<SdlAudioStream> stream, Pointer<Int32> count) → Pointer<Int32> audio
Get the current output channel map of an audio stream.
sdlGetAudioStreamProperties(Pointer<SdlAudioStream> stream) → int audio
Get the properties associated with an audio stream.
sdlGetAudioStreamQueued(Pointer<SdlAudioStream> stream) → int audio
Get the number of bytes currently queued.
sdlGetCurrentAudioDriver() → String? audio
Get the name of the current audio driver.
sdlGetNumAudioDrivers() → int audio
Use this function to get the number of built-in audio drivers.
sdlGetSilenceValueForFormat(int format) → int audio
Get the appropriate memset value for silencing an audio format.
sdlIsAudioDevicePhysical(int devid) → bool audio
Determine if an audio device is physical (instead of logical).
sdlIsAudioDevicePlayback(int devid) → bool audio
Determine if an audio device is a playback device (instead of recording).
sdlLoadWav(String? path, Pointer<SdlAudioSpec> spec, Pointer<Pointer<Uint8>> audioBuf, Pointer<Uint32> audioLen) → bool audio
Loads a WAV from a file path.
sdlLoadWavIo(Pointer<SdlIoStream> src, bool closeio, Pointer<SdlAudioSpec> spec, Pointer<Pointer<Uint8>> audioBuf, Pointer<Uint32> audioLen) → bool audio
Load the audio data of a WAVE file into memory.
sdlLockAudioStream(Pointer<SdlAudioStream> stream) → bool audio
Lock an audio stream for serialized access.
sdlMixAudio(Pointer<Uint8> dst, Pointer<Uint8> src, int format, int len, double volume) → bool audio
Mix audio data in a specified format.
sdlOpenAudioDevice(int devid, Pointer<SdlAudioSpec> spec) → int audio
Open a specific audio device.
sdlOpenAudioDeviceStream(int devid, Pointer<SdlAudioSpec> spec, Pointer<NativeFunction<SdlAudioStreamCallback>> callback, Pointer<Void> userdata) → Pointer<SdlAudioStream> audio
Convenience function for straightforward audio init for the common case.
sdlPauseAudioDevice(int devid) → bool audio
Use this function to pause audio playback on a specified device.
sdlPauseAudioStreamDevice(Pointer<SdlAudioStream> stream) → bool audio
Use this function to pause audio playback on the audio device associated with an audio stream.
sdlPutAudioStreamData(Pointer<SdlAudioStream> stream, Pointer<Void> buf, int len) → bool audio
Add data to the stream.
sdlPutAudioStreamDataNoCopy(Pointer<SdlAudioStream> stream, Pointer<Void> buf, int len, Pointer<NativeFunction<SdlAudioStreamDataCompleteCallback>> callback, Pointer<Void> userdata) → bool audio
Add external data to an audio stream without copying it.
sdlPutAudioStreamPlanarData(Pointer<SdlAudioStream> stream, Pointer<Pointer<Void>> channelBuffers, int numChannels, int numSamples) → bool audio
Add data to the stream with each channel in a separate array.
sdlResumeAudioDevice(int devid) → bool audio
Use this function to unpause audio playback on a specified device.
sdlResumeAudioStreamDevice(Pointer<SdlAudioStream> stream) → bool audio
Use this function to unpause audio playback on the audio device associated with an audio stream.
sdlSetAudioDeviceGain(int devid, double gain) → bool audio
Change the gain of an audio device.
sdlSetAudioPostmixCallback(int devid, Pointer<NativeFunction<SdlAudioPostmixCallback>> callback, Pointer<Void> userdata) → bool audio
Set a callback that fires when data is about to be fed to an audio device.
sdlSetAudioStreamFormat(Pointer<SdlAudioStream> stream, Pointer<SdlAudioSpec> srcSpec, Pointer<SdlAudioSpec> dstSpec) → bool audio
Change the input and output formats of an audio stream.
sdlSetAudioStreamFrequencyRatio(Pointer<SdlAudioStream> stream, double ratio) → bool audio
Change the frequency ratio of an audio stream.
sdlSetAudioStreamGain(Pointer<SdlAudioStream> stream, double gain) → bool audio
Change the gain of an audio stream.
sdlSetAudioStreamGetCallback(Pointer<SdlAudioStream> stream, Pointer<NativeFunction<SdlAudioStreamCallback>> callback, Pointer<Void> userdata) → bool audio
Set a callback that runs when data is requested from an audio stream.
sdlSetAudioStreamInputChannelMap(Pointer<SdlAudioStream> stream, Pointer<Int32> chmap, int count) → bool audio
Set the current input channel map of an audio stream.
sdlSetAudioStreamOutputChannelMap(Pointer<SdlAudioStream> stream, Pointer<Int32> chmap, int count) → bool audio
Set the current output channel map of an audio stream.
sdlSetAudioStreamPutCallback(Pointer<SdlAudioStream> stream, Pointer<NativeFunction<SdlAudioStreamCallback>> callback, Pointer<Void> userdata) → bool audio
Set a callback that runs when data is added to an audio stream.
sdlUnbindAudioStream(Pointer<SdlAudioStream> stream) → void audio
Unbind a single audio stream from its audio device.
sdlUnbindAudioStreams(Pointer<Pointer<SdlAudioStream>> streams, int numStreams) → void audio
Unbind a list of audio streams from their audio devices.
sdlUnlockAudioStream(Pointer<SdlAudioStream> stream) → bool audio
Unlock an audio stream for serialized access.
sdlxBindAudioStreams(int devid, List<Pointer<SdlAudioStream>> streams) → bool audio
Bind a list of audio streams to an audio device.
sdlxCreateAudioStream(SdlxAudioSpec srcSpec, SdlxAudioSpec? dstSpec) → Pointer<SdlAudioStream> audio
Create a new audio stream.
sdlxGetAudioDeviceChannelMap(int devid) → List<int> audio
Get the current channel map of an audio device.
sdlxGetAudioDeviceFormat(int devid) → ({int sampleFrames, SdlxAudioSpec spec})? audio
Get the current audio format of a specific audio device.
sdlxGetAudioPlaybackDevices() → List<int> audio
Get a list of currently-connected audio playback devices.
sdlxGetAudioRecordingDevices() → List<int> audio
Get a list of currently-connected audio recording devices.
sdlxGetAudioStreamData(Pointer<SdlAudioStream> stream, int maxLenInBytes) → TypedData? audio
Get converted/resampled data from the stream.
sdlxGetAudioStreamFormat(Pointer<SdlAudioStream> stream) → (SdlxAudioSpec, SdlxAudioSpec)? audio
Query the current format of an audio stream.
sdlxGetAudioStreamInputChannelMap(Pointer<SdlAudioStream> stream) → List<int> audio
Get the current input channel map of an audio stream.
sdlxGetAudioStreamOutputChannelMap(Pointer<SdlAudioStream> stream) → List<int> audio
Get the current output channel map of an audio stream.
sdlxLoadWav(String path) → ({Uint8List audioBuf, SdlxAudioSpec spec})? audio
Loads a WAV from a file path.
sdlxLoadWavIo(Pointer<SdlIoStream> src, {bool closeio = false}) → ({Uint8List audioBuf, SdlxAudioSpec spec})? audio
Load the audio data of a WAVE file into memory.
sdlxOpenAudioDevice(int devid, SdlxAudioSpec? spec) → int audio
Open a specific audio device.
sdlxOpenAudioDeviceStream(int devid, SdlxAudioSpec? spec, Pointer<NativeFunction<SdlAudioStreamCallback>> callback, Pointer<Void> userdata) → Pointer<SdlAudioStream> audio
Convenience function for straightforward audio init for the common case.
sdlxPutAudioStreamData(Pointer<SdlAudioStream> stream, TypedData buf) → bool audio
Add data to the stream.
sdlxPutAudioStreamDataNoCopy(Pointer<SdlAudioStream> stream, Uint8List buf, Pointer<NativeFunction<SdlAudioStreamDataCompleteCallback>> callback, Pointer<Void> userdata) → bool audio
Add external data to an audio stream without copying it.
sdlxSetAudioStreamFormat(Pointer<SdlAudioStream> stream, SdlxAudioSpec? srcSpec, SdlxAudioSpec? dstSpec) → bool audio
Change the input and output formats of an audio stream.
sdlxSetAudioStreamInputChannelMap(Pointer<SdlAudioStream> stream, List<int> chmaps) → bool audio
Set the current input channel map of an audio stream.
sdlxSetAudioStreamOutputChannelMap(Pointer<SdlAudioStream> stream, List<int> chmaps) → bool audio
Set the current output channel map of an audio stream.
sdlxUnbindAudioStreams(List<Pointer<SdlAudioStream>> streams) → void audio
Unbind a list of audio streams from their audio devices.