SDL_GetAudioDeviceGain - Man Page

Get the gain of an audio device.

Header File

Defined in SDL3/SDL_audio.h

Synopsis

#include "SDL3/SDL.h"

float SDL_GetAudioDeviceGain(SDL_AudioDeviceID devid);

Description

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.

Function 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

·(3), SDL_SetAudioDeviceGain(3)

Referenced By

SDL_SetAudioDeviceGain(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS