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

SDL_SetAudioStreamGain

Change the gain of an audio stream.

Header File

Defined in <SDL3/SDL_audio.h>

Syntax

bool SDL_SetAudioStreamGain(SDL_AudioStream *stream, float gain);

Function Parameters

SDL_AudioStream * stream the stream on which the gain is being changed.
float gain the gain. 1.0f is no change, 0.0f is silence.

Return Value

(bool) Returns true on success or false 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).

This is applied during SDL_GetAudioStreamData, and can be continuously changed to create various effects.

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

See Also


CategoryAPI, CategoryAPIFunction, CategoryAudio


[ edit | delete | history | feedback | raw ]

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