roar_server_oinfo2(3)

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

πŸ’– roar_server_oinfo2 β€” the manual page, but make it make sense πŸ’–

okay so bestie, we're in the System Manager's Manual section of the RoarAudio docs, and today's main character is roar_server_oinfo2(3). yes it's a C library function, yes it's lowkey iconic, let's get into it 🫢


✨ NAME ✨

roar_server_oinfo, roar_server_oinfo2 β€” gets info on the output stream of RoarAudio's sound server 🌈


πŸŽ€ SYNOPSIS πŸŽ€

#include <roaraudio.h>

int roar_server_oinfo(struct roar_connection * con, struct roar_stream * s);
int roar_server_oinfo2(struct roar_connection * con, struct roar_stream * s, int dir);

like, two functions, one header, very demure, very mindful πŸ’…


πŸ¦‹ DESCRIPTION πŸ¦‹

So what do these actually do, bestie? They grab info about the default mixer stream for whatever stream direction you hand them. Why do you care? Because you can use that to get the optimal parameters for all your operations β€” meaning the server doesn't have to go and resample everything. no resampling, no extra work, it's giving efficiency fr fr ✨

⚠️ heads up babes: roar_server_oinfo() is marked as obsolete and will be removed soon. like, it's on the way out. use roar_server_oinfo2() if you know what's good for you 😭

🌸 PARAMETERS 🌸

  • con β€” the connection to the server. your little link to the mothership πŸ›°οΈ
  • s β€” a stream object that's gonna get filled up with all the information about the output stream. it's the canvas, the info is the paint 🎨
  • dir β€” the stream direction you want to query mixer data for. which way are we going, bestie? 🧭

πŸ‘‘ RETURN VALUE πŸ‘‘

  • On success: these calls return 0 πŸŽ‰ slay
  • On error: -1 is returned πŸ’€ not slay

πŸ“ EXAMPLES πŸ“

FIXME

and yes that's literally what the original says. the examples section is a work in progress, the author said "later" and meant it πŸ™ˆ


πŸ’œ SEE ALSO πŸ’œ

go read those too, they're the supporting cast 🫢


🌟 cute sign-off 🌟

this whole thing lives in the RoarAudio manual, and it's been sitting pretty since May 2011 ⭐ so yeah, vintage. now go forth and query your mixer data, bestie β€” the server is gonna love you for not making it resample πŸŽ€πŸ’–βœ¨

πŸ“¦ where this page comes from