Function SDL_GetAudioDeviceGain

pub unsafe extern "C" fn SDL_GetAudioDeviceGain(devid: u32) -> f32
Available on crate feature dep_sdl3 only.
Expand description

Get the gain of an audio device.

The gain of a device is its volume; a larger gain means a louder output, with a gain of zero being silence.

Audio devices default to a gain of 1.0f (no change in output).

Physical devices may not have their gain changed, only logical devices, and this function will always return -1.0f when used on physical devices.

§Parameters

  • devid: the audio device to query.

§Return value

Returns the gain of the device or -1.0f 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.

§See also