setGain method

bool setGain(
  1. double gain
)

Change the gain of an audio stream.

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.

\param stream the stream on which the gain is being changed. \param gain the gain. 1.0f is no change, 0.0f is silence. \returns true on success or false on failure; call SDL_GetError() for more information.

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

\since This function is available since SDL 3.1.3.

\sa SDL_GetAudioStreamGain

extern SDL_DECLSPEC bool SDLCALL SDL_SetAudioStreamGain(SDL_AudioStream *stream, float gain)

Implementation

bool setGain(double gain) {
  return sdlSetAudioStreamGain(this, gain);
}