(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetAudioStreamGain

Get the gain of an audio stream.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

float SDL_GetAudioStreamGain(SDL_AudioStream *stream);

Function Parameters

SDL_AudioStream *

stream

the SDL_AudioStream to query.

Return Value

(float) Returns the gain of the stream or -1.0f on failure; call SDL_GetError() for more information.

Remarks

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).

Thread Safety

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

Version

This function is available since SDL 3.1.3.

See Also

• SDL_SetAudioStreamGain

---

CategoryAPI, CategoryAPIFunction, CategoryAudio

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.