SDL_SetAudioStreamGain - Change the gain of an audio stream.
Contents
Availability
This function is available since SDL 3.2.0.
Description
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).
This is applied during SDL_GetAudioStreamData , and can be continuously changed to create various
effects.
Function Parameters
stream the stream on which the gain is being changed.
gain the gain. 1.0f is no change, 0.0f is silence.
Header File
Defined in SDL3/SDL_audio.h
Name
SDL_SetAudioStreamGain - Change the gain of an audio stream.
Return Value
Returns true on success or false on failure; call
SDL_GetError () for more information.
See Also
•(3), SDL_GetAudioStreamGain(3) Simple Directmedia Layer SDL 3.2.10 SDL_SetAudioStreamGain(3)
Synopsis
#include"SDL3/SDL.h"boolSDL_SetAudioStreamGain(SDL_AudioStream*stream,floatgain);
Thread Safety
It is safe to call this function from any thread, as it holds a stream-specific mutex while running.
