roar_vs_blocking(3)

📦 version 1.0~beta12, in ubuntu jammy

💖 roar_vs_blocking — the blocking-mode glow-up 💖

okay so this is a page from the RoarAudio Programmer's Manual, and bestie, it's literally the one that flips your VS object's blocking mode on and off like a light switch. no cap.

✨ NAME ✨

roar_vs_blocking — change the blocking mode of a VS object. that's it, that's the whole job. she's focused. 💅

🦋 SYNOPSIS 🦋

#include <roaraudio.h>

int     roar_vs_blocking (roar_vs_t * vss, int val, int * error);

look at her. three args. main character energy fr fr. 🌸

🎀 DESCRIPTION 🎀

So like. This function changes the blocking mode of a VS object. Or — plot twist — you can use it to ask what the current mode is, by setting val to ROAR_VS_ASK. She's giving switch AND vibe check. obsessed. ✨

👑 PARAMETERS 👑

  • vss — the VS object you wanna alter. your girl. your project. handle with care 🫶
  • val — the new state you want. it must be one of ROAR_VS_TRUE, ROAR_VS_FALSE, ROAR_VS_TOGGLE or ROAR_VS_ASK.
💀 heads up: ROAR_VS_TOGGLE should be avoided. like, the manpage itself said it. i'm just the messenger. lowkey don't.
  • error — this is a pointer to an integer, and it's where the error value goes if something goes wrong. you can pass NULL if you're not gonna use it — but ngl it's very recommended to actually use it, because that's how you report good error messages to your user instead of just ✨mysteriously failing✨. be a considerate dev. 🌈

⭐ RETURN VALUE ⭐

On success, these calls return the old state of the blocking mode — or, if you used ROAR_VS_ASK, the current state. so you always walk away knowing something. 🧚

On error, -1 is returned. and that's it. that's the whole story. 😭

🍓 EXAMPLES 🍓

FIXME

yeah bestie they left us on read with this one. the examples section is literally just the word FIXME. iconic in a tragic way. 💀

🌈 SEE ALSO 🌈

go read those too, iykyk. 🔥

and that's the page!! brought to you by RoarAudio, dated May 2011 — yes she's vintage, yes she still slays. mwah. 💜✨

📦 where this page comes from