SDL_SetAudioStreamGain(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_SetAudioStreamGain 💖

okay bestie, gather round, we're doing SDL3 audio today and honestly? it's giving volume knob energy. this one lives in the SDL3 FUNCTIONS lineup and its whole personality is changing the gain of an audio stream. that's it. that's the job. and it eats. ✨

🎀 NAME 🎀

SDL_SetAudioStreamGain — change the gain of an audio stream. no cap, that's literally the whole thing.

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_audio.h>

bool SDL_SetAudioStreamGain(SDL_AudioStream *stream, float gain);

🦋 DESCRIPTION 🦋

so like. the gain of a stream is its volume, periodt. bigger gain = louder output, and a gain of zero means silence, like the sound went to sleep. 💤

audio streams default to a gain of 1.0f, which is the "no change in output" vibe — you're not touching anything, you're just existing. iconic.

and here's the fun part: this gets applied during SDL_GetAudioStreamData, which means you can continuously change it to cook up all kinds of effects. fades, dips, dramatic swells... the whole main character arc. 🔥

💅 FUNCTION PARAMETERS 💅

  • stream — the stream whose gain is getting changed. the glow-up target. 👑
  • gain — the gain itself. 1.0f is no change, 0.0f is silence. pick your fighter.

⭐ RETURN VALUE ⭐

returns true on success or false on failure. and if it fails? call SDL_GetError() for more info, she'll tell you what went wrong. 🫶

🔥 THREAD SAFETY 🔥

fr fr, you can call this from any thread and it's safe — it holds a stream-specific mutex the whole time it's running. so go ahead and be chaotic, it's protected. 💪

🌈 AVAILABILITY 🌈

this function has been available since SDL 3.2.0. she's been here, she's been serving. 💜

💀 SEE ALSO 💀

⚠️ heads up bestie: 0.0f gain is full silence, not "a little quiet." don't be surprised when the vibes go completely quiet. 🙈

okay that's the whole page!! this was brought to you by Simple Directmedia Layer (the source, the icon, the legend 🌟) running SDL 3.4.18. now go make something loud. mwah. 💖✨🎀

📦 where this page comes from