MIX_SETTRACKCOOKEDCALLBACK(3)

📦
version 3.2.4 · 2 versions
, in fedora 44

💖 MIX_SetTrackCookedCallback(3) 💖

okay bestie, welcome to the SDL_mixer3 functions section, and today's main character is MIX_SetTrackCookedCallback ✨

🌸 NAME 🌸

MIX_SetTrackCookedCallback — sets up a callback that fires when the mixer has transformed a track's audio. like, the audio is cooked now, get it? 🍳

🎀 SYNOPSIS 🎀

#include <SDL3_mixer/SDL_mixer.h>

bool MIX_SetTrackCookedCallback(MIX_Track *track, MIX_TrackMixCallback cb, void *userdata);

🦋 DESCRIPTION 🦋

okay so here's the vibe. a track is out here needing to mix more data, right? so it pulls from its input (a MIX_Audio, an SDL_AudioStream, etc). and that input might be a compressed file format — think MP3 — so a lil bit more data gets uncompressed out of it. 💅

once the track has PCM data to actually start operating on, and its raw callback has finished doing its thing, the track begins transforming the audio: gain, fading, frequency ratio, 3D positioning, etc. the whole glow-up sequence. ✨

so a callback can fire after all these transformations, but before the transformed data gets mixed into other tracks. this is literally the last moment the data is still part of this track, so it lets an app peek at it. 👀 and here's the iconic part: during this callback it can change the data in any way it pleases, and the mixer will just keep going as if this data came directly from the input. no cap. 🔥

each track has its own unique cooked callback — no sharing, no hand-me-downs, every track gets its own. 👑

passing a NULL callback here is legal btw; it disables this track's callback. completely valid, no drama. 🙈

💜 FUNCTION PARAMETERS 💜

  • track — the track you're assigning this callback to. the one getting the glow-up. 🫶
  • cb — the function to call when the track mixes. may be NULL.
  • userdata — an opaque pointer handed to the callback for its own personal use. it's giving "here's your lil bag, do what you want with it". 🎀

🌈 RETURN VALUE 🌈

returns true on success or false on failure — and bestie, if it fails, call SDL_GetError() for more info. always check, fr fr. 😭

⭐ AVAILABILITY ⭐

this function has been available since SDL_mixer 3.0.0. vintage but make it fresh. 👑

🔥 SEE ALSO 🔥

mwah 💋 that's the whole page, go forth and cook those tracks. this was SDL_mixer 3.2.4 from the SDL_mixer crew — ty for reading, ily, stan a safe audio pipeline 🫶✨💖

📦 where this page comes from