roar_vs_ctl(3)

💖 roar_vs_ctl — bestie's backstage pass to the VS object 💖

okay so this is roar_vs_ctl(3), straight out of the RoarAudio Programmer's Manual. It's the little key that opens the private door of your VS object, and we're gonna talk about it. 🎀

---

✨ NAME ✨

roar_vs_ctl — the interface to the private internals of a VS object 🫣

---

✨ SYNOPSIS ✨

#include <roaraudio.h>

int     roar_vs_ctl           (roar_vs_t * vss, roar_vs_ctlcmd cmd, void
* argp, int * error);

---

✨ DESCRIPTION ✨

So like, this function exists to let you poke at the internals of the VS object. That's the whole job. 💅

But hear me out — it is generally to be avoided to use this function. Like, generally. It's giving "yeah you can but should you". 🙈

Which commands are valid? That depends on your library version, bestie. The commands are defined in a way that's suitable for #ifdef checking, so you can vibe-check them at compile time. ✨

---

✨ PARAMETERS ✨

• vss — the VS object that's about to get altered. main character energy, honestly. 👑
• cmd — says which command to run on the object. pick one, bestie.
• argp — a pointer to the operant for the given command. the type depends on which command you picked, so no cap on the variety here. it must be NULL for commands that don't take any argument. 💀
• error — a pointer to an int where the error value gets stored if something goes wrong. you can pass NULL if you're not using it, but fr fr, it is very recommended to use this error value so you can report good error messages to the user. do it for them. 🥺

---

✨ RETURN VALUE ✨

• On success, these calls return 0. slay. ✨
• On error, -1 is returned. 😭

---

✨ EXAMPLES ✨

FIXME

not me leaving the examples section as FIXME but like... that's literally what it says. iconic honestly. 💀

---

✨ SEE ALSO ✨

roarvs(7), libroar(7), RoarAudio(7).

go read those too, they're part of the lore. 📚

---

kisses, bye 💋

this has been RoarAudio, from May 2011, signing off like the legend it is 🌈⭐ — go forth and #ifdef responsibly, bestie 💖🦋