AuGetScrat...FromBucket(3)

📦 version 1.9.4, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 AuGetScratchFlowFromBucket — Library Functions Manual 💖

okay bestie, pull up a chair, we're doing audio server stuff today and honestly? it's giving iconic. this one lives in AuGetScrat...FromBucket(3) territory, aka the audiolib crew, and she's here to make you an import using a scratch flow. no cap. 🦋

✨ NAME ✨

AuGetScratchFlowFromBucket — use a scratch flow to create an import from a bucket.

like, that's the whole vibe. scratch flow in, import out. slay.

🌸 SYNOPSIS 🌸

#include <audio/audiolib.h>

AuFlowID AuGetScratchFlowFromBucket(server, bucket, export, status)
    AuServer *server;
    AuBucketID bucket;
    int *export; /* RETURN */
    AuStatus *status; /* RETURN */

look at her. four args, two of them marked /* RETURN */ because they hand stuff back to you. the way that works is so satisfying ngl. ✨

🎀 ARGUMENTS 🎀

  • server — the connection to the audio server. your lil phone line to the whole audio operation fr fr.
  • bucket — the ID of the bucket you wanna use. yes, a bucket. we love her. 🍓
  • import — returns the index of the ExportClient element. (heads up bestie: the synopsis up there calls this param export and this list calls it import. the docs said "both, actually." i don't make the rules, i just report them 💀)
  • status — if it's non-NULL, it flushes the output buffer and returns the status from the server. if it's NULL? nothing happens, no drama, we move on. 🫶

👑 DESCRIPTION 👑

AuGetScratchFlowFromBucket uses a scratch flow to create an import from bucket and returns the flow ID — or AuNone if there was an error. that's it. that's the whole thing. main character behaviour, honestly. 🔥

so you give her a server and a bucket, she goes and does scratch-flow magic, and she comes back with a flow ID. if things went sideways, you get AuNone instead. not me getting emotionally attached to a return value 😭

💀 ERRORS 💀

  • AuBadAlloc.

just the one. one singular error. she keeps it tight. 💅

🌈 SEE ALSO 🌈

  • AuCreateFlow
  • AuGetScratchFlow
  • audiolib — Network Audio System C Language Interface

go read those next, bestie, they're the rest of the lore. iykyk. 💜

🧚 little reminder: this is a library functions page from the audiolib set, so keep your #include <audio/audiolib.h> handy and your AuStatus * checked, mkay?

and that's the page, periodt. 🎀 this lil write-up is from audioutil, version 1.9.4, and it covers AuGetScrat...FromBucket(3). mwah, go make some imports bestie 💖✨

📦 where this page comes from