AuCreateBucket(3)

🎀 AuCreateBucket — create a bucket 💖

okay so bestie, we're in AuCreateBucket(3) territory, part of the Library Functions Manual for audiolib (the Network Audio System C Language Interface, if you're new here, hi, welcome, slay). Buckets are literally the whole vibe of this page and we're about to make one. no cap.

---

✨ SYNOPSIS ✨

#include <audio/audiolib.h>

AuBucketID AuCreateBucket(server, format, tracks, access, sample_rate,
nsamples, description, status)
    AuServer *server;
    AuUint32 format;
    AuUint32 tracks;
    AuUint32 access;
    AuUint32 sample_rate;
    AuUint32 num_samples;
    AuString *description;
    AuStatus *status; /* RETURN */

like, she's giving function signature. look at her. 👑

---

🌸 ARGUMENTS 🌸

• server — the connection to the audio server. your little link to the mothership, basically.
• format — the data format of the audio data. currently these formats are defined: AuFormatULAW8, AuFormatLinearUnsigned8, AuFormatLinearSigned8, AuFormatLinearSigned16MSB, AuFormatLinearUnsigned16MSB, AuFormatSignedLinear16LSB, and AuFormatLinearUnsigned16LSB. pick your fighter 💅
• tracks — how many tracks of audio data. yes, plural tracks. multitrack era. 🔥
• access — the types of operations permitted on this bucket. this must be a bitwise inclusive OR of zero or more of these constants: AuAccessImportMask, AuAccessExportMask, AuAccessDestroyMask, and AuAccessListMask. it's giving permissions, it's giving boundaries, we love a secure queen 🫶
• sample_rate — the sample rate of the audio data.
• num_samples — how many samples the bucket is gonna contain.
• description — a textual description of the bucket. this may be NULL (so if you're not feeling chatty, that's valid, no pressure bestie 🌈).
• status — if non-NULL, flush the output buffer and return the status from the server. she reports back. iconic.

---

💫 DESCRIPTION 💫

AuCreateBucket creates a bucket with the specified attributes, and returns the bucket ID, or AuNone if there was an error. so like, you either get your bucket ID or you get absolutely nothing, and honestly? relatable.

heads up: the initial contents of the bucket are undefined. do not assume, do not trust, do not look at them directly. it's a mystery bucket. 🙈

---

😭 ERRORS 😭

the possible errors are:

• AuBadValue
• AuBadLength
• AuBadAlloc

she can be a little dramatic. it's fine.

---

🦋 SEE ALSO 🦋

• AuDestroyBucket — the breakup arc 💔
• AuSetBucketAttributes — glow-up arc ✨
• AuListBuckets — inventory era 📋
• AuFreeBucketAttributes — letting go, very healing 🧚

and of course: audiolib — Network Audio System C Language Interface. the whole family.

---

friendly reminder: every option, every constant, every NULL check is here on purpose. do not skip the boring parts, the boring parts are load-bearing. periodt.

okay that's the page, mwah 💖 this was audiolib — bucket existence, version 1.9.5, and if you read all the way to the bottom you are genuinely my favorite person. go make a bucket, bestie, you got this 🎀🦋💜