MIX_TagTrack(3)

📦
version 3.2.4 · 2 versions
, in fedora 44

💖 MIX_TagTrack(3) 💖

okay bestie, welcome to the SDL_mixer3 girlies' corner of the manual ✨ this one lives in the SDL_mixer3 FUNCTIONS section and it's literally so cute, let's go 🎀

✨ NAME ✨

MIX_TagTrack — slap an arbitrary tag onto a track, no cap 🏷️

🌸 SYNOPSIS 🌸

#include <SDL3_mixer/SDL_mixer.h>

bool MIX_TagTrack(MIX_Track *track, const char *tag);

🦋 DESCRIPTION 🦋

ok so a tag can be any valid C string in UTF-8 encoding. that's it. that's the rule 💅

and like… why would you even want that? because grouping tracks is lowkey iconic, that's why. picture this: everything in-game gets tagged "game", and then when the user pops open the settings menu, your app can pause every single track involved in gameplay all at once — while background music and menu sound effects just keep vibing 🎶✨ main character energy fr fr.

a track can have as many tags as desired, until the machine runs out of memory 😭 (we don't talk about that part).

it's also totally legal to add the same tag to a track more than once 🫶 the extra attempts will report success but won't actually change anything. so like, no harm, no foul, no drama.

and when you're done with a tag? tags can later be removed with MIX_UntagTrack() 🧹✨

💜 FUNCTION PARAMETERS 💜

  • track — the track you're adding a tag to 🎯
  • tag — the tag you're adding 🏷️

⭐ RETURN VALUE ⭐

returns true on success, false on error 😭 and if it's an error you gotta call SDL_GetError() for the details, iykyk 👑

🔥 THREAD SAFETY 🔥

it is safe to call this function from any thread. go off, multithreaded queen 👑✨

🌈 AVAILABILITY 🌈

this function is available since SDL_mixer 3.0.0 💖 so if you're on anything older… bestie. upgrade. 🙈

🎀 SEE ALSO 🎀

and that's the whole page, periodt 💅 this masterpiece was brought to you by SDL_mixer 3.2.4 — mwah, love u, go tag some tracks 🫶💖✨

📦 where this page comes from