Function SDL_SetAudioStreamGain

pub unsafe extern "C" fn SDL_SetAudioStreamGain(
    stream: *mut SDL_AudioStream,
    gain: f32,
) -> bool

Available on crate feature dep_sdl3 only.

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.

Parameters

• stream: the stream on which the gain is being changed.
• gain: the gain. 1.0f is no change, 0.0f is silence.

Return value

Returns true on success or false 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

• SDL_GetAudioStreamGain