AuServer(3)

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

okay bestie, gather round, because today we're talking about AuServer(3) from the Library Functions Manual, and honestly? it's giving "quietly holding the entire audio server connection together" energy. no cap. let's get into it πŸŽ€


✨ Name ✨

AuServer β€” it's the AuServer structure, babe. that's the whole vibe. the whole thing. periodt. πŸ’…


πŸ¦‹ Structures πŸ¦‹

first things first, you gotta pull in the header:

#include <audio/audiolib.h>

and here's the shape of the thing itself:

typedef struct _AuServer
{
    . . .
}AuServer;

yeah, the members are literally . . . in the docs. mysterious. enigmatic. main character energy. πŸ™ˆ


🌸 MACROS 🌸

🚨 read this first, fr fr: do not dereference the members of the AuServer structure directly. like, do not. instead, use the access macros. that's the whole point of them. okay? okay. πŸ’–

just so we're clear on the vocab: server is a pointer to a AuServer structure. got it? slay.

now here's the full roster, no skips, no skimming:

  • AuServerConnectionNumber(server) β€” accesses the int connection number. ✨
  • AuServerQLength(server) β€” accesses the int value with the length of the input queue. πŸ’«
  • AuServerVendor(server) β€” accesses the NUL-terminated string giving the identification of the audio server vendor. πŸŽ€
  • AuServerProtocolMajorVersion(server) β€” accesses the int value of the major protocol revision number of the audio server. πŸ”’
  • AuServerProtocolMinorVersion(server) β€” accesses the int value of the minor protocol revision number of the audio server. πŸ”’
  • AuServerVendorRelease(server) β€” accesses the int value with the release number of the audio server. πŸ“¦
  • AuServerString(server) β€” accesses the NUL-terminated string giving the server name. 🏷️
  • AuServerNextRequest(server) β€” accesses the AuUint32 serial ID of the next protocol request to be sent. πŸ“€
  • AuServerLastKnownRequestProcessed(server) β€” accesses the AuUint32 serial ID of the last known protocol request sent. πŸ“₯
  • AuServerResourceBase(server) β€” accesses the AuID base used in constructing resource ID's. 🧱
  • AuServerResourceMask(server) β€” accesses the AuID mask used in constructing resource ID's. 🎭
  • AuServerMinSampleRate(server) β€” accesses the int value with the minimum sample rate supported by the server. πŸ”‰
  • AuServerMaxSampleRate(server) β€” accesses the int value with the maximum sample rate supported by the server. πŸ”Š
  • AuServerMaxTracks(server) β€” accesses the int value indicating the maximum number of tracks supported by the server. 🎚️
  • AuServerNumFormats(server) β€” accesses the int value indicating the number of formats supported by the server. 🎼
  • AuServerNumElementTypes(server) β€” accesses the int value indicating the number of element types supported by the server. 🧩
  • AuServerNumWaveForms(server) β€” accesses the int value indicating the number of waveform generators supported by the server. 〰️
  • AuServerNumActions(server) β€” accesses the int value indicating the number of actions supported by the server. ⚑
  • AuServerNumDevices(server) β€” accesses the int value indicating the number of server devices. πŸŽ›οΈ
  • AuServerNumBuckets(server) β€” accesses the int value indicating the number of server buckets. πŸͺ£
  • AuServerFormat(server, n) β€” accesses the int value of the n'th format supported by the server. 🎡
  • AuServerElementType(server, n) β€” accesses the int value of the n'th element supported by the server. 🧬
  • AuServerWaveForm(server, n) β€” accesses the int value of the n'th waveform supported by the server. 🌊
  • AuServerAction(server, n) β€” accesses the int value of the n'th action supported by the server. πŸ’₯
  • AuServerDevice(server, n) β€” accesses the AuDeviceAttributes structure of the n'th server device. πŸ”Š
  • AuServerBucket(server, n) β€” accesses the AuBucketAttributes structure of the n'th server bucket. πŸͺ£
  • AuClientOfID(server, resource) β€” extracts the ClientID from resource. πŸ”
  • AuID AuAllocID(server) β€” invokes the ID allocator function. πŸ†”

see? told you it was a lot. every single one is here though. ate and left no crumbs. πŸ‘‘


πŸ’œ Description πŸ’œ

the AuServer structure describes the connection to the audio server. that's it. that's the description. short, sweet, and honestly kind of iconic. 🫢


🌈 See Also 🌈

  • AuCloseServer.
  • audiolib β€” Network Audio System C Language Interface

and that's the whole page, bestie!! πŸ’–βœ¨ this one came from the audiolib source, version 1.9.4, and the footer says it's dated 1.9.4 too (same number, matching vibes, we love consistency πŸŽ€). anyway β€” go use those access macros and do not dereference the members directly. i'm watching. πŸ‘€πŸ’…

πŸ“¦ where this page comes from