roar_simple_stream(3)

📦 version 1.0~beta12, in ubuntu jammy

💖 roar_simple_stream(3) 💖

okay bestie, welcome to the RoarAudio corner of the System Manager's Manual. this one's about roar_simple_stream and it's giving "legacy but make it cute" 🎀

✨ NAME ✨

roar_simple_stream — opens a stream to RoarAudio's sound server 🦋

🌸 SYNOPSIS 🌸

#include <roaraudio.h>

int roar_simple_stream(int rate, int channels, int bits, int codec, char
* server, int dir, char * name);

👑 DESCRIPTION 👑

so basically this creates a brand new stream to RoarAudio. that's the whole vibe ✨

but ngl, normally you don't want to call this directly — you want to use one of roar_simple_play(3), roar_simple_monitor(3), roar_simple_record(3) or roar_simple_filter(3) instead. they're the ones holding the main character energy 💅

💀 heads up bestie, this is the important part: these functions are marked obsolete and will be removed very soon. no cap. please upgrade to the VS API — go look at roar_vs_new_simple(3) 🫶

🍓 PARAMETERS 🍓

  • rate, channels, bits, codec, server, name — for the full explanation on all of these, go read roar_simple_play(3), it's got you 💜
  • dir — the direction of the new stream. valid directions are listed right below, keep scrolling 🌈

🧚 STREAM DIRECTIONS 🧚

  • ROAR_DIR_PLAY — this direction means a player streams data to the server so it can play it back. classic 🎶
  • ROAR_DIR_RECORD — this one is for recording audio from the soundcard. use it when you want to grab data from your microphone or your line in 🎤
  • ROAR_DIR_MONITOR — this gets you a copy of whatever the server is sending to the soundcard. iconic use case: streaming the fully mixed data to Icecast (check icecast2(1)) 🔥
  • ROAR_DIR_FILTER — this creates a filter stream. a filter stream filters the output of the sound server through some tool — a software equalizer, for example. and listen: the filter stream is the only bi-directional stream. you have to read some data and write back data of exactly the same size. exactly. same size. don't play with it 💀
  • ROAR_DIR_OUTPUT — this is the type of stream the server sends to the soundcard. you can not create such a stream. it's only listed here for completeness. it's literally just here to be perceived 🙈

⭐ RETURN VALUE ⭐

on success, these calls return a filehandle 🎀

on error, -1 is returned. that's it, that's the tea 😭

🌈 EXAMPLES 🌈

FIXME

(yes. that's genuinely what's there. no notes. the examples are forthcoming, bestie 💅)

🦋 SEE ALSO 🦋

and that's the whole page, bestie, you ate it up 👑

this little icon dropped back in May 2011 as part of RoarAudio — yeah she's been around a while, hence the whole obsolete situation 💜 mwah, go use the VS API 🫶

📦 where this page comes from