roar_vs_pause(3)

📦 version 1.0~beta12, in ubuntu jammy

💖 roar_vs_pause — bestie edition 💖

okay so this is a page from the RoarAudio Programmer's Manual, like the <pink>roar_vs_pause(3)</pink> one, and we're gonna go through it together, no cap. grab a snack. 🍓

✨ NAME ✨

roar_vs_pause, roar_vs_mute — alter stream flags 💅

like, that's literally it. two lil functions, one job: messing with your stream's flags.

🌸 SYNOPSIS 🌸

#include <roaraudio.h>

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

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

yeah bestie, both of them live in <roaraudio.h> and both return an int. iconic.

🦋 DESCRIPTION 🦋

so roar_vs_pause() and roar_vs_mute() alter the stream flags PAUSE and MUTE, respectively. 🎀

roar_vs_pause() handles PAUSE, roar_vs_mute() handles MUTE. they're not out here doing each other's jobs, they each have their own flag and they're thriving. periodt.

💜 PARAMETERS 💜

  • vss — the VS object pointing to the stream whose flags should be altered. it's giving "this is the stream we're messing with", okay? 👑
  • val — specifies the new state. the value must be ROAR_VS_TRUE, ROAR_VS_FALSE, ROAR_VS_TOGGLE or ROAR_VS_ASK. those are your four options, no vibes-based guessing allowed. 🌈
  • error — this is a pointer to an integer used to store the error value in case of error. it can be NULL if you're not using it, but honestly? it is very recommended to use this error value so you can report good error messages to the user. bestie, don't leave your users hanging with a mystery failure. 😭

🔥 RETURN VALUE 🔥

on success these calls return the old state of the stream flag — or the current state if ROAR_VS_ASK is used. 👀

on error, -1 is returned. that's the sad path. 💀

🙈 EXAMPLES 🙈

FIXME

yeah. that's the example section. it's just FIXME. not me reading a manpage and getting FIXME as the whole demo 😭 but fr fr, that's exactly what the original says, so that's what you get.

⭐ SEE ALSO ⭐

go read those if you want the full lore. iykyk. 🫶

mwah 💋 that's the whole page. this came from RoarAudio, dated May 2011, and it's the <pink>roar_vs_pause(3)</pink> page — so go forth, toggle your flags, and slay. 🎀✨

📦 where this page comes from