libroar(7)

💖 libroar — the RoarAudio sound library, bestie edition 💖

okay so real talk: we're talking about libroar, aka the whole entire heart of RoarAudio ✨. It lives in the System Manager's Manual: RoarAudio section of your man pages, and it's the library you call when you wanna talk to a RoarAudio server. Pull up a chair, grab a boba 🧋, and let's get into it.

---

🌸 NAME 🌸

libroar — the RoarAudio sound library 🎀

---

✨ SYNOPSIS ✨

#include <roaraudio.h>

like… that's it. that's the whole doorway. one include and you're in 💅

---

🦋 DESCRIPTION 🦋

so libroar is the central library you use to comunicate with RoarAudio servers. she's the main character fr fr 👑

she supports all the commands, from the super simple ones like "play some audio" all the way up to the complex ones that control the server and do nice things over the network 🌈.

and bestie, she does not stop there — she also ships several useful functions, from buffer management to IO abstraction. it's giving "does everything, effortlessly" 😭💖

---

🎀 EXAMPLES 🎀

the basic tools that ship with RoarAudio are literally designed to also work as examples for the lib. so you can just go read code instead of guessing, iconic behavior tbh 🫶

• wanna see how to simply play back some audio? go look at the source code of roarcat(1). starter pack energy ✨
• want something more complex? roarvorbis(1) is the one — she even includes meta data updates 🔥

you should also have a look at the VS API — check out roarvs(7) for an overview 👀

---

🧚 TUTORIALS 🧚

tutorials can be found in roartut(7). go get educated, bestie 📚💅

---

💜 ENVIRONMENT VARIABLES 💜

these variables are used in libroar itself, so they're common to all clients using libroar. no cap.

• HOME — the user's home directory 🏠
• ROAR_SERVER — the address of the listening server 📡. this may be in the form of host:port for TCP/IP connections, or /path/to/sock for UNIX Domain Sockets. and if you give it a value of '+fork', a roard gets forked and used 🍴. this roard will not listen on any sockets, so it is used exclusiv by this client. see roard(1) for more information.
• ROAR_PROXY — sets the type of proxy being used to connect to the server 🛰️. valid values are 'socks4', 'socks4a', 'socks4d', 'http' and 'ssh' for the moment. you can add type depending options in the form 'type/opts'.
• socks_proxy — the SOCKS4/4a/4d/5 proxy to use, in the form [user@]host[:port] 🧦. the default port is 9050.
• http_proxy, https_proxy — the HTTP/HTTPS Proxy server 🌐. this server needs to understand the CONNECT request type. give the server name in this format: [http://]host[:port][/]. the default port is 8080.
• ssh_proxy — the remote host to use as an SSH Proxy server 🔐. give the server name in this format: [user@]host[:port]. the default port is 22. note that you may need to use publickey based auth or ssh-agent, because the application may start SSH in a non interactive environment and SSH can not ask you for a password 😭 (rude of it, honestly).

---

🌈 FILES 🌈

• /etc/roarserver — this is a symlink to the server socket 🔗. it means all types of server addresses are supported. example:

ln -s /tmp/roar /etc/roarserver
ln -s somehost /etc/roarserver
ln -s mynode:: /etc/roarserver

look at her go 💅

---

💀 BUGS 💀

A lot...

(no like. a lot. the original said it, not me 🙈)

---

⭐ SEE ALSO ⭐

roar-config(1), roartypes(1), roarvs(7), roartut(7), roard(1), roartips(7), RoarAudio(7).

go read them all, bestie, that's the assignment 📖✨

---

👑 HISTORY 👑

see RoarAudio(7).

---

okay that's the whole page, slay 💖 this was libroar(7) from the RoarAudio crew, dated June 2011 🗓️. it's giving vintage but make it timeless. bye bestie, go make some noise 🎧🫶