AuListBuckets(3)

✨ NAME ✨

okay so bestie, this is AuListBuckets(3) from the Library Functions Manual, and she is serving one iconic purpose: AuListBuckets - list buckets. that's the whole vibe. 💅✨

🌸 SYNOPSIS 🌸

first you gotta include the header, then call her like this, no cap:

       #include <audio/audiolib.h>

       AuBucketAttributes *AuListBuckets(server, valuemask, attributes,
       nbuckets, status)
           AuServer *server;
           AuMask valuemask;
           AuBucketAttributes *attributes;
           int *nbuckets; /* RETURN */
           AuStatus *status; /* RETURN */

🎀 ARGUMENTS 🎀

• server — specifies the connection to the audio server. like, which server are we gossiping with? that one. 🫶
• valuemask — specifies which bucket attributes are defined in attributes. this must be a bitwise inclusive OR of zero or more of these constants: AuCompCommonIDMask, AuCompCommonKindMask, AuCompCommonUseMask, AuCommonFormatMask, AuCommonNumTracksMask, AuCommonAccessMask, AuCommonDescriptionMask, AuCompBucketSampleRateMask, or AuCompBucketNumSamplesMask. if valuemask is zero, the attributes are ignored and are not referenced. so zero means she's not even looking at them, bestie. 🙈
• attributes — specifies the structure from which the values (as specified by the value mask) are to be taken. it's the little info holder she reads from. 📋
• nbuckets — returns the number of buckets in the returned list. this one's a /* RETURN */ girlie. 🔢
• status — if non-NULL, flush the output buffer and return the status from the server. also marked /* RETURN */ in the synopsis. she's the receipts. 🧾

🌈 DESCRIPTION 🌈

so what's the tea? AuListBuckets returns a list of buckets whose attributes match those values in attributes specified by valuemask, or NULL, with nbuckets set to 0, if there was an error. and when you're done with the list, use AuFreeBucketAttributes to free it when it's no longer needed. don't be a messy bestie and leave it lying around. 💖

ngl, if there was an error you get NULL and nbuckets is 0 — that's the signal, periodt.

💀 ERRORS 💀

• AuBadLength.

👑 SEE ALSO 👑

• AuGetBucketAttributes.
• audiolib - Network Audio System C Language Interface.

xoxo, this page is brought to you by audiolib - bucket attributes, version/date 1.9.5, and it's literally the AuListBuckets(3) manual. byeee 💖🫶