AuBucketAttributes(3)

✨ AuBucketAttributes ✨

okay bestie, welcome to the Library Functions Manual entry for AuBucketAttributes(3) 💖 this is the lil struct that holds all the deets about where your audio data lives on the server. no cap, it's giving "backstage pass to the bucket."

---

🌸 Name 🌸

AuBucketAttributes — bucket attributes structure 🪣✨

---

🎀 Structures 🎀

first things first, pull in the header:

#include <audio/audiolib.h>

and here's the struct, bestie:

typedef struct _AuBucketAttributes
{
    . . .
}AuBucketAttributes;

like, the insides are a mystery on purpose (iykyk) 👀

---

💅 Members 💅

ok so HUGE disclaimer: do not dereference the members of the AuBucketAttributes structure directly. do not. don't do it. use the access macros instead, periodt. 🙅‍♀️

throughout all of this, ba is a pointer to a AuBucketAttributes structure. she's the main character here 👑

• AuBucketValueMask(ba) — grabs the AuMask value that tells you which attributes are actually present. it's a bitwise inclusive OR of these constants: AuCompCommonIDMask, AuCompCommonKindMask, AuCompCommonUseMask, AuCompCommonFormatMask, AuCompCommonNumTracksMask, AuCompCommonAccessMask, AuCompCommonDescriptionMask, AuCompBucketSampleRateMask, and AuCompBucketNumSamplesMask. literally all of them, what a lineup 🔥
• AuBucketChangableMask(ba) — grabs the AuMask value that tells you which of the attributes can be changed. also a bitwise inclusive OR of these constants: AuCompCommonIDMask, AuCompCommonKindMask, AuCompCommonUseMask, AuCompCommonFormatMask, AuCompCommonNumTracksMask, AuCompCommonAccessMask, AuCompCommonDescriptionMask, AuCompBucketSampleRateMask, and AuCompBucketNumSamplesMask. yes it's the same list as above, i said what i said 💀
• AuBucketIdentifier(ba) — grabs the AuBucketID ID of the bucket. her government name 🪪
• AuBucketKind(ba) — grabs the int value telling you the kind of component. and babes, buckets will always be AuComponentKindBucket. no identity crisis here 🦋
• AuBucketUse(ba) — grabs the AuMask value telling you what uses of the bucket are permitted. bitwise inclusive OR of these constants: AuComponentUseImportMask and AuComponentUseExportMask. import, export, that's the whole vibe 📦
• AuBucketFormat(ba) — grabs the int value telling you the audio data format the bucket uses. rn the following formats are defined: AuFormatULAW8, AuFormatLinearUnsigned8, AuFormatLinearSigned8, AuFormatLinearSigned16MSB, AuFormatLinearUnsigned16MSB, AuFormatLinearSigned16LSB, and AuFormatLinearUnsigned16LSB. pick your fighter ⭐
• AuBucketNumTracks(ba) — grabs the int value telling you how many tracks the bucket supports. multitrack queen 👑
• AuBucketAccess(ba) — grabs the AuMask value telling you what kinds of access the bucket allows. bitwise inclusive OR of these constants: AuAccessImportMask, AuAccessExportMask, AuAccessDestroyMask, and AuAccessListMask. she has boundaries, respect them 💅
• AuBucketDescription(ba) — grabs the AuString structure holding a textual description of the bucket. her bio, basically 📝
• AuBucketSampleRate(ba) — grabs the unsigned int value telling you the sample rate of the bucket. the tempo of it all 🎵
• AuBucketNumSamples(ba) — grabs the AuUint32 value telling you how many samples the bucket contains. so many. count them 🍓

---

🌈 Description 🌈

the AuBucketAttributes structure describes the server-local storage of audio data. that's it, that's the whole job — she's the little info card that says where the audio actually lives on the server 🏠✨

---

💜 See Also 💜

• AuGetBucketAttributes, AuListBuckets.
• audiolib — Network Audio System C Language Interface 🫶

---

and that's the tea, bestie 🎀 this was audiolib's bucket attributes page, version 1.9.5, from the Library Functions Manual — go slay your audio code, mwah 💋✨