AUGETSCRATCHFLOWTOBUCKET(3nas)

πŸ’– AuGetScratchFlowToBucket(3) πŸ’–

okay bestie, welcome to the AuGetScratchFlowToBucket page β€” it lives in the Library Functions Manual and it's lowkey one of those little helper functions that just works. no cap.


✨ NAME ✨

AuGetScratchFlowToBucket β€” use a scratch flow to create an export to a bucket.

like... a whole scratch flow, just to make an export. iconic behavior honestly πŸŽ€


🌸 SYNOPSIS 🌸

#include <audio/audiolib.h>

AuFlowID AuGetScratchFlowToBucket(server, bucket, import, status)
    AuServer *server;
    AuBucketID bucket;
    int *import; /* RETURN */
    AuStatus *status; /* RETURN */

see that AuFlowID return type? that's what you're getting back, girlie. and yes, import and status are both marked /* RETURN */ β€” they hand stuff back to you, they're not inputs. don't get it twisted πŸ’…


πŸ¦‹ ARGUMENTS πŸ¦‹

  • server β€” the connection to the audio server. your whole link to the vibe, basically.
  • bucket β€” the ID of the bucket you wanna use. tell it which bucket, it can't read your mind (unfortunately).
  • import β€” this one's a return value! it hands you back the index of the ImportClient element. 🫢
  • status β€” if it's non-NULL, the output buffer gets flushed and you get the status straight from the server. if it's NULL, you get nothing back, which is a choice, but okay.

πŸ”₯ DESCRIPTION πŸ”₯

AuGetScratchFlowToBucket uses a scratch flow to create an export to bucket.

that's it, that's the whole thing. short and slay. ✨


πŸ’€ ERRORS πŸ’€

  • AuBadAlloc.
not me getting an AuBadAlloc 😭 that's the allocation girlies saying "no room bestie". handle it, fr fr.

🌈 SEE ALSO 🌈

  • AuCreateFlow
  • AuGetScratchFlow
  • audiolib β€” Network Audio System C Language Interface

go read those next, they're the rest of the lore, iykyk πŸ‘‘


anyway that's the page!! this whole thing came from audioutil, version 1.9.4, and it's serving AuGetScratchFlowToBucket(3) realness. mwah, go write some audio code bestie πŸ’–πŸ’…πŸŽ€

πŸ“¦ where this page comes from