roarvs(7)

🦋 roarvs(7) — the very simple API, bestie edition

okay so you found the page for roarvs, section 7 of the System Manager's Manual: RoarAuido (yes that's how it's spelled up there, we don't talk about it 💀). This is the one about the RoarAudio sound library, aka libroar. Sit down, get comfy, we're doing this. ✨

---

🌸 NAME

• libroar — the RoarAudio sound library itself, the whole entire moment 👑
• roarvs — the RoarAudio very simple API. lowercase, unbothered, iconic.

---

🎀 SYNOPSIS

like, here's literally all you need to summon it:

#include <roaraudio.h>

roar_vs_t * vss;

that's it. that's the whole vibe check. a header and a pointer. slay. 💅

---

💖 DESCRIPTION

okay so the VS API — and "VS" stands for Very Simple, which is so real of it — is a high level abstraction layer. its whole job? letting genuinely tiny, simple little programs use RoarAudio without making you cry. 😭

the tea is: this API was designed to help people easily upgrade their existing artsc and pulse-simple code over to RoarAudio. like a glow-up but for your source files. 🦋

and yeah, it's equivalently simple to those APIs... but it's much more powerful than the ones from aRtsc or PulseAudio. not me saying that, the page says that. no cap. 🔥

also!! the VS API has a mode to play back (and record) files easily. and because that mode uses VIO/DSTR, it can handle streams as well. streams!! she does it all. main character energy fr fr. 👑

---

🧚 TUTORIALS

want the step-by-step? tutorials live in roartut(7). go read them, bestie, they're right there. 📚

---

⭐ IMPORTANT FUNCTIONS

there are several important functions. here's a small list of the most important ones — think of it as the group chat roster. 💜

🙈 Error handling

• roar_vs_strerr(3) — when things go wrong (and they will, lowkey) this is where you find out what happened.

🎀 Opening

• roar_vs_new(3) — open a new connection.
• roar_vs_new_simple(3) — the simple version of opening. very on brand.
• roar_vs_new_playback(3) — open for playback.
• roar_vs_new_from_file(3) — open from a file.

🌈 Closing

• roar_vs_close(3) — closing time. you don't have to go home but you can't stay here.

💅 Reading and writing

• roar_vs_read(3) — read stuff.
• roar_vs_write(3) — write stuff.

🦋 Non-Blocking and Asyncron IO

• roar_vs_blocking(3) — blocking control.
• roar_vio_select(3) — the select situation.

🔥 Volume and Flags

• roar_vs_pause(3) — pause it.
• roar_vs_mute(3) — mute it.
• roar_vs_volume_mono(3) — mono volume.
• roar_vs_volume_stereo(3) — stereo volume.
• roar_vs_volume_get(3) — get the volume.

👑 Meta data

• roar_vs_meta(3) — meta data.
• roar_vs_role(3) — roles.

🌸 File mode

• roar_vs_file(3)
• roar_vs_file_simple(3)
• roar_vs_iterate(3)
• roar_vs_run(3)

🍓 Buffered mode

• roar_vs_buffer(3)
• roar_vs_iterate(3)
• roar_vs_run(3)

(yes roar_vs_iterate(3) and roar_vs_run(3) show up in both file mode and buffered mode. she contains multitudes. 🫶)

---

💀 BUGS

A lot...

that's it. that's the entire section. no further notes. extremely real of them. 💀

---

🌟 SEE ALSO

• roar-config(1)
• roartypes(1)
• roartut(7)
• RoarAudio(7)

---

ngl this whole thing is giving "small API, big feelings". go forth and make sound, bestie. 🎧✨

---

and that's a wrap!! this page came to you from RoarAudio, dated June 2011, and it lives at roarvs(7). mwah. 💖🎀🦋