SDL_GetAudioStreamGain(3)

SDL_GetAudioStreamGain3

Get the gain of an audio stream.

Usage

#include "SDL3/SDL.h"

float SDL_GetAudioStreamGain(SDL_AudioStream *stream);

Header file

Defined in SDL3/SDL_audio.h

Overview

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

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

Function parameters

stream

the SDL_AudioStream
to query.

Return value

Returns the gain of the stream or -1.0f on failure; call

SDL_GetError () for more information.

Thread safety

It is safe to call this function from any thread, as it holds a stream-specific mutex while running.

Availability

This function is available since SDL 3.2.0.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.