(This function is part of SDL_mixer, a separate library from SDL.)

MIX_SetTagGain

Set the gain control of all tracks with a specific tag.

Header File

Syntax

bool MIX_SetTagGain(MIX_Mixer *mixer, const char *tag, float gain);

Function Parameters

MIX_Mixer *	mixer	the mixer on which to look for tagged tracks.
const char *	tag	the tag to use when searching for tracks.
float	gain	the new gain value.

Return Value

(bool) Returns true on success or false on failure; call SDL_GetError() for more information.

Remarks

Each track has its own gain, to adjust its overall volume. Each sample from this track is modulated by this gain value. A gain of zero will generate silence, 1.0f will not change the mixed volume, and larger than 1.0f will increase the volume. Negative values are illegal. There is no maximum gain specified, but this can quickly get extremely loud, so please be careful with this setting.

A track's gain defaults to 1.0f.

This will change the gain control on tracks on the specified mixer that have the specified tag.

From the point of view of the mixing process, all tracks that successfully change gain values will do so at the exact same moment.

This value can be changed at any time to adjust the future mix.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.