SDL Wiki
[ front page | index | search | recent changes | git repo | offline html ]
(This function is part of SDL_mixer, a separate library from SDL.)

MIX_SetTrackGroup

Assign a track to a mixing group.

Header File

Defined in <SDL3_mixer/SDL_mixer.h>

Syntax

bool MIX_SetTrackGroup(MIX_Track *track, MIX_Group *group);

Function Parameters

MIX_Track * track the track to set mixing group assignment.
MIX_Group * group the new mixing group to assign to. May be NULL.

Return Value

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

Remarks

All tracks in a group are mixed together, and that output is made available to the app before it is mixed into the final output.

Tracks can only be in one group at a time, and the track and group must have been created on the same MIX_Mixer.

Setting a track to a NULL group will remove it from any app-created groups, and reassign it to the mixer's internal default group.

Thread Safety

It is safe to call this function from any thread.

Version

This function is available since SDL_mixer 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategorySDLMixer


[ edit | delete | history | feedback | raw ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.