roar_get_standby(3)

📦 version 1.0~beta12, in ubuntu jammy

🦋 roar_get_standby — the manual page bestie 💖

okay so this is roar_get_standby(3), from the System Manager's Manual: RoarAudio section. yes it's a mouthful, no we're not renaming it, it's iconic actually. sit down, grab a strawberry 🍓, and let's get into it.

✨ NAME ✨

roar_get_standby, roar_set_standby — get and set RoarAudio's sound servers standby state 💅

like, literally the two functions that peek at and poke the server's nap mode. that's the whole vibe.

🌸 SYNOPSIS 🌸

#include <roaraudio.h>

int roar_get_standby(struct roar_connection * con);

int roar_set_standby(struct roar_connection * con, int state);

no cap, that's the entire incantation. include the header, call the thing, done. 🎀

💜 DESCRIPTION 💜

so what do these babies actually do? they get or set the standby state of the server. periodt.

and listen, when the server is in standby, no audio is played. like, silence. crickets. the whole main-character moment is paused. 😭

also, and this is the lowkey important part — the audio device may be released depending on configuration. so it's not a guarantee, it's a "depends how your setup is configured" situation. read your config, bestie, i'm not guessing for you. 🙈

👑 PARAMETERS 👑

  • con — the connection to the server. this is your little thread of friendship to the daemon, you gotta have it. 🫶
  • state — the new state. and it's gotta be one of these two:
    • ROAR_STANDBY_ACTIVE — if you want standby set active. i.e. nap time, audio goes night-night. 💤
    • ROAR_STANDBY_INACTIVE — normal operating mode. i.e. wake up, we're playing sound again. 🔥

⭐ RETURN VALUE ⭐

roar_get_standby returns ROAR_STANDBY_ACTIVE, ROAR_STANDBY_INACTIVE or -1 on error. she'll tell you which mood the server is in, or she'll just say -1 and you'll know something went sideways. 💀

roar_set_standby returns on success 0. on error, -1 is returned. classic zero-for-success, negative-one-for-nope. no notes. 💅

🌈 EXAMPLES 🌈

FIXME

yeah. that's it. that's the example section. the authors left us on read and honestly? we respect the honesty. 😭✨

🧚 SEE ALSO 🧚

go read those too, iykyk. 📚💖

kisses and bye bye, this was the RoarAudio manual page, dated May 2011 — she's vintage, she's still serving, and she ate. 🎀

📦 where this page comes from