SDL_SETAUDIOSTREAMFREQUENCYRATIO(3)

📦
version 3.4.18 · 9 versions
, in fedora 43, fedora 44

💖 SDL_SetAudioStreamFrequencyRatio 💖

okay bestie, welcome to the SDL3 FUNCTIONS corner of the manual, and today's main character is SDL_SetAudioStreamFrequencyRatio — the lil function that changes the frequency ratio of an audio stream. yes it's a mouthful, no you don't have to say it out loud. 🎀

✨ NAME ✨

SDL_SetAudioStreamFrequencyRatio — change the frequency ratio of an audio stream.

🌸 SYNOPSIS 🌸

#include <SDL3/SDL_audio.h>

bool SDL_SetAudioStreamFrequencyRatio(SDL_AudioStream *stream, float ratio);

🦋 DESCRIPTION 🦋

so here's the vibe: the frequency ratio is what adjusts the rate at which input data is consumed. change it and you're literally changing the speed and the pitch of the audio. it's giving DJ, it's giving chipmunk, it's giving slow-mo dramatic montage. 💅

  • a value greater than 1.0f plays the audio faster, and at a higher pitch 🐿️
  • a value less than 1.0f plays the audio slower, and at a lower pitch 🐢
  • 1.0f means play at normal speed, aka the default reality, aka no notes ✨

this gets applied during SDL_GetAudioStreamData, and you can continuously change it to create various effects. obsessed. keep messing with it mid-stream, the audio does not mind. 🔥

💅 FUNCTION PARAMETERS 💅

  • stream — the stream on which the frequency ratio is being changed. yes, the one you're doing this to. that stream. 🫶
  • ratio — the frequency ratio. 1.0 is normal speed. Must be between 0.01 and 100. like, genuinely must. no cap.

👑 RETURN VALUE 👑

returns true on success or false on failure. and if it fails, bestie, go call SDL_GetError() for more information — it will tell you what went wrong, fr fr. 😭

🔒 THREAD SAFETY 🔒

it is safe to call this function from any thread, because it holds a stream-specific mutex while running. multitask away, she's protected. 💜

🌈 AVAILABILITY 🌈

this function has been available since SDL 3.2.0. if you're on something older... not the vibe, upgrade. ⭐

🎀 SEE ALSO 🎀

and that's the whole page, bestie, you ate it. 🍓 this iconic lil doc is brought to you by Simple Directmedia Layer — SDL 3.4.18 — mwah, slay, periodt. 💖✨🧚

📦 where this page comes from