SDL_GetAudioStreamGain - Man Page

Get the gain of an audio stream.

Header File

Defined in SDL3/SDL_audio.h

Synopsis

#include "SDL3/SDL.h"

float SDL_GetAudioStreamGain(SDL_AudioStream *stream);

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

Function Parameters

stream

the SDL_AudioStream
to query.

Return Value

Returns the gain of the stream or -1.0f on failure; call

SDL_GetError () for more information.

Thread Safety

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

Availability

This function is available since SDL 3.2.0.

See Also

·(3), SDL_SetAudioStreamGain(3)

Referenced By

SDL_SetAudioStreamGain(3).

SDL 3.2.2 Simple Directmedia Layer SDL3 FUNCTIONS