devela::_dep::sdl3::sys::audio

Function SDL_GetAudioDeviceFormat

pub unsafe extern "C" fn SDL_GetAudioDeviceFormat(
    devid: u32,
    spec: *mut SDL_AudioSpec,
    sample_frames: *mut i32,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

Get the current audio format of a specific audio device.

For an opened device, this will report the format the device is currently using. If the device isn’t yet opened, this will report the device’s preferred format (or a reasonable default if this can’t be determined).

You may also specify SDL_AUDIO_DEVICE_DEFAULT_PLAYBACK or SDL_AUDIO_DEVICE_DEFAULT_RECORDING here, which is useful for getting a reasonable recommendation before opening the system-recommended default device.

You can also use this to request the current device buffer size. This is specified in sample frames and represents the amount of data SDL will feed to the physical hardware in each chunk. This can be converted to milliseconds of audio with the following equation:

ms = (int) ((((Sint64) frames) * 1000) / spec.freq);

Buffer size is only important if you need low-level control over the audio playback timing. Most apps do not need this.

§Parameters

  • devid: the instance ID of the device to query.
  • spec: on return, will be filled with device details.
  • sample_frames: pointer to store device buffer size, in sample frames. Can be NULL.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Thread safety

It is safe to call this function from any thread.

§Availability

This function is available since SDL 3.2.0.