AuDestroyBucket(3)

💖 AuDestroyBucket(3) — the bucket destruction page 💖

Library Functions Manual ✨ yes bestie, we're in the C library section, get comfy 🫶

🌸 NAME 🌸

AuDestroyBucket — destroy bucket 💅

✨ SYNOPSIS ✨

#include <audio/audiolib.h>

void AuDestroyBucket(server, bucket, status)
    AuServer *server;
    AuBucketID bucket;
    AuStatus *status; /* RETURN */

like… it's giving "void, no return value, we just vibe and the bucket is gone" 💀

🎀 ARGUMENTS 🎀

• server — the connection to the audio server 🖥️✨ this is your link to the whole audio situation.
• bucket — the ID of the bucket that's about to be destroyed 💀 lowkey a little sad but okay.
• status — if it's non-NULL, it flushes the output buffer and hands you back the status from the server 📨 (the comment in the synopsis literally says /* RETURN */, so yeah, this one's the output).

🦋 DESCRIPTION 🦋

So AuDestroyBucket destroys the bucket you point it at, releasing the resources that bucket was using 🎀✨ that's the whole job, and it ate, no crumbs.

BUT — and this is the important part, bestie, don't skip it — if the bucket is currently in use, the resources will not be released until the bucket is no longer in use 👑 so it's not instant-instant, it's more like "okay you're on the list, we'll free you when you're done serving."

no cap, it's not a force-delete. the bucket finishes its shift first. 🙈

💀 ERRORS 💀

• AuBadBucket
• AuBadAccess

yeah… those can happen. read them, respect them. 🫶

🌈 SEE ALSO 🌈

• AuCreateBucket — the origin story, the birth of the bucket 🍼✨
• audiolib — Network Audio System C Language Interface 📚

🧚 SIGN-OFF 🧚

that's the page, babe 💖 it came from the audiolib docs, under the very cute descriptor "audiolib - bucket existence", at version 1.9.4 🌸

AuDestroyBucket(3) — go forth and clean up your buckets responsibly, queen 👑💅✨