roar_get_vol(3)

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

πŸ’– roar_get_vol β€” get/set mixer levels, bestie edition πŸ’–

okay so this is a page from the System Manager's Manual: RoarAudio (that's the manual name, she's fancy like that πŸŽ€), and today we're learning about roar_get_vol, roar_set_vol, and roar_set_vol2 β€” aka the trio that sets mixer levels and RoarAudio stream levels. no cap, they're literally the volume girlies πŸ’…


✨ NAME ✨

roar_get_vol, roar_set_vol, roar_set_vol2 β€” set mixer levels or RoarAudio streams 🎚️


🌸 SYNOPSIS 🌸

#include <roaraudio.h>

int roar_set_vol(struct roar_connection * con, int id, struct
roar_mixer_settings * mixer, int   channels);

int roar_set_vol2     (struct roar_connection * con, int id, struct
roar_mixer_settings * mixer, int   channels, int mode);

int roar_get_vol(struct roar_connection * con, int id, struct
roar_mixer_settings * mixer, int * channels);

πŸ¦‹ DESCRIPTION πŸ¦‹

so basically this call gets or sets the mixing levels for a stream. like, it's the volume knob of the whole situation πŸ”₯

important bestie alert 🚨 roar_set_vol() is marked obsolete and will be removed soon β€” use roar_set_vol2() instead, fr fr. don't get attached to the old one, she's leaving πŸ’€

πŸ’œ PARAMETERS πŸ’œ

  • con β€” the connection to the roar audio server. your little phone line to the server, essentially πŸ“ž
  • id β€” the ID of the stream you wanna change. gotta know which stream you're messing with πŸ‘‘
  • mixer β€” the mixer state for the stream. this is the actual data packet of volume vibes ✨
  • channels β€” the number of channels to set mixer data for, or the number of channels mixer data is returned for (depends on which direction you're going, iykyk) 🎧
  • mode β€” the mode of operating. currently the following modes are supported: ROAR_SET_VOL_ALL, ROAR_SET_VOL_MS, ROAR_SET_VOL_UNMAPPED 🌈

πŸ’… RETURN VALUE πŸ’…

  • on success, these calls return 0 β€” slay, we ate βœ…
  • on error, -1 is returned β€” not the vibe, something went wrong 😭

πŸ“ EXAMPLES πŸ“

FIXME

(yeah, the examples section literally just says FIXME. iconic of the devs, honestly πŸ™ˆ no example yet, bestie, the docs are still cooking 🧚)


🫢 SEE ALSO 🫢


and that's the whole page, bestie πŸ’– this one came from RoarAudio, dated May 2011 β€” a true vintage queen πŸ‘‘ go forth and adjust those mixer levels responsibly πŸŒΈπŸ’œβœ¨

πŸ“¦ where this page comes from