AuSoundRecordToBucket(3)

✨ AuSoundRecordToBucket(3) ✨

okay so bestie, welcome to the Library Functions Manual entry for AuSoundRecordToBucket — yes it's a mouthful, yes it's iconic, no we are not shortening it 💅

🎀 NAME 🎀

AuSoundRecordToBucket — create a flow to record to a bucket.

like. that's literally the whole job. it makes a flow. the flow records. the recording goes into a bucket. slay.

🌸 SYNOPSIS 🌸

#include <audio/audiolib.h>
#include <audio/soundlib.h>

AuEventHandlerRec *AuSoundRecordToBucket(server, destination, source,
gain, callback, callback_data, mode, flow, volume_mult_elem, status)
    AuServer *server;
    AuBucketID destination;
    AuDeviceID source;
    AuFixedPoint gain;
    void (*callback) (AuServer *, AuEventHandlerRec *, AuEvent *,
AuPointer);
    AuPointer callback_data;
    int mode;
    AuFlowID *flow; /* RETURN */
    int *volume_mult_elem; /* RETURN */
    AuStatus *status; /* RETURN */

look at all those parameters. ten of them. it's giving main character energy for real fr fr 🫶

🦋 ARGUMENTS 🦋

• server — the connection to the audio server. your lil hotline to the server, basically.
• destination — the bucket to record to. this is where the audio ends up, like dropping a voice memo into the group chat.
• source — the input device to record from. where the sound is coming from, king.
• gain — the gain for the input device. turn it up, turn it down, it's a whole vibe.
• callback — the procedure to be called for additional event processing. your little guy that gets pinged when there's more event stuff to handle.
• callback_data — any additional arguments to be passed to the callback. lil care package for your callback 🎁
• mode — the line mode for the input device. currently the following line modes are defined: AuDeviceInputModeNone, AuDeviceInputModeLineIn, AuDeviceInputModeMicrophone. pick your fighter ✨
• flow — if non-NULL, returns the flow ID.
• volume_mult_elem — according to the comment in the source, not implemented. 😭 that's it. that's the whole description. it's giving "we left a TODO and never came back."
• status — if non-NULL, flush the output buffer and return the status from the server.

💖 DESCRIPTION 💖

AuSoundRecordToBucket creates a flow to record from source into destination and returns a pointer to the event handler created or NULL if there was an error.

so like — hand it a source, hand it a destination, and it wires up a whole flow for you and hands back a pointer to the shiny new event handler. if it's not feeling it? you get NULL. no handler. no vibes. 💀

🍓 ERRORS 🍓

• AuBadBucket
• AuBadDevice

bestie if you see one of these it means your bucket or your device was not the moment. check ur ids.

👑 SEE ALSO 👑

• AuSoundRecord
• AuSoundRecordToData
• AuSoundRecordToFile
• AuSoundRecordToFileN

audiolib - Network Audio System C Language Interface

like literally the whole friend group of record functions. go read them too, they ate 🔥

and that's the page!! this one came from soundlib, version 1.9.4, and it's the AuSoundRecordToBucket(3) entry 🦋💜

no cap, thanks for reading bestie, mwah 🫶✨💅