MIX_GETTRACKFREQUENCYRATIO(3)

📦
version 3.2.4 · 2 versions
, in fedora 44

💖 MIX_GetTrackFrequencyRatio(3) 💖

okay bestie so this is a page from SDL_mixer3 FUNCTIONS and we're talking about MIX_GetTrackFrequencyRatio — the little guy that tells you how fast a track is vibing ✨

🌸 NAME 🌸

MIX_GetTrackFrequencyRatio — asks a track what its frequency ratio is, like a vibe check but for playback speed 💅

🎀 SYNOPSIS 🎀

#include <SDL3_mixer/SDL_mixer.h>

float MIX_GetTrackFrequencyRatio(MIX_Track *track);

🦋 DESCRIPTION 🦋

So the frequency ratio is literally the thing that controls how fast the audio data gets eaten up. Change it and you're changing the speed and the pitch of the track's audio at the same time — yes, they come as a package deal, no splitting them up 🙈

  • Anything greater than 1.0f plays the audio faster, and at a higher pitch — it's giving chipmunk era, honestly iconic.
  • Anything less than 1.0f plays it slower, at a lower pitch — slow-mo main character moment.
  • 1.0f is normal speed. The default. The baseline. The unbothered queen 👑

The default value is 1.0f.

Now the messy part: on various errors — like MIX_Init() was not called, or the track is NULL — this returns 0.0f. And since 0.0f is not a valid value to set, you can read that as an error state. Like if you get 0.0f back, something went wrong, periodt 💀

👑 FUNCTION PARAMETERS 👑

  • track — the track you're querying the frequency ratio of. the one we're interrogating 💖

⭐ RETURN VALUE ⭐

Returns the current frequency ratio, or 0.0f on failure. And if it failed? Call SDL_GetError() for more info, bestie, she'll tell you what happened 🫶

🌈 THREAD SAFETY 🌈

It is safe to call this function from any thread. any of them. go wild ✨

💜 AVAILABILITY 💜

This function is available since SDL_mixer 3.0.0.

🌟 SEE ALSO 🌟

and that's the whole page, no cap 🧚💖 written up from SDL_mixer version 3.2.4 — stay slaying out there, and remember: if you got a 0.0f, check SDL_GetError(), she always knows what's up 🎀💅

📦 where this page comes from