roar_si..._standby(3)

πŸ“¦ version 1.0~beta12, in ubuntu jammy

πŸ’– roar_si..._standby(3) β€” the RoarAudio girlies' guide πŸ’–

okay so bestie, welcome to section 3 of the System Manager's Manual (yes, that's the library functions section, we love her), brought to you by the RoarAudio girlies. this one's a lil vintage, a lil obsolete, but we're gonna read it together because knowledge is free and so is this man page. πŸŽ€


✨ NAME ✨

roar_simple_get_standby β€” Get RoarAudio's standby state

like, that's literally it. she gets the standby state. that's her whole job. πŸ’…


πŸ¦‹ SYNOPSIS πŸ¦‹

#include <roaraudio.h>

int roar_simple_get_standby(int fh);

that's the whole vibe. one include, one function, one int argument. iconic, honestly. ✨


🌸 DESCRIPTION 🌸

So what does she do, bestie? She asks the server for its standby state. That's it. That's the tea. You give her a file handle, she goes and asks, and she comes back with the answer. πŸ’–

⚠️ BUT WAIT. This function is marked obsolete and will be removed soon. Like, not "someday maybe" β€” soon soon. She's on her way out. πŸ₯²

The glow-up replacement is roar_get_standby(3). Use that one instead. This girl is giving "graduating senior energy" β€” she's done, she's leaving, please stop depending on her. 😭


🌈 PARAMETERS 🌈

  • fh β€” FIXME

yeah. that's what the original says. FIXME. the authors literally left this one as a homework assignment for future-us. not me reading a man page that says FIXME and just nodding along 🫢 honestly relatable, we've all been there. πŸ™ˆ


πŸ‘‘ RETURN VALUE πŸ‘‘

  • On success: this call returns either ROAR_STANDBY_ACTIVE or ROAR_STANDBY_INACTIVE β€” so like, either she's on or she's off, no in-between, no "it's complicated". πŸ’…
  • On error: -1 is returned. classic. the universal "nope". πŸ’€

🧚 EXAMPLES 🧚

FIXME

bestie. bestie. the examples section is literally just FIXME. no code. no demo. nothing. we're on our own out here fr fr. 😭 not the man page leaving us hanging like that β€” main character energy is missing in this section, no cap.


⭐ SEE ALSO ⭐


🌟 tiny recap so you don't forget: obsolete function, use roar_get_standby(3) instead, params are a mystery (FIXME), examples are a mystery (FIXME), returns ROAR_STANDBY_ACTIVE / ROAR_STANDBY_INACTIVE or -1. slay. πŸ’–

this page came to you from RoarAudio, dated May 2011 β€” yeah, she's an elder, show some respect. πŸ’œ bye bestie, go read the non-obsolete one, iykyk πŸ¦‹βœ¨

πŸ“¦ where this page comes from