AuReadElement(3)

💖 AuReadElement(3) 💖

okay so bestie, welcome to the Library Functions Manual page for AuReadElement — yes that's the whole name, she's serving exactly what she says on the tin 💅

---

✨ NAME ✨

AuReadElement — read data from an ExportClient element in a flow 🎀

---

🦋 SYNOPSIS 🦋

#include <audio/audiolib.h>

void AuReadElement(server, flow, element, num_bytes, data, status)
    AuServer *server;
    AuFlowID flow;
    int element;
    AuUint32 num_bytes;
    AuPointer data;
    AuStatus *status; /* RETURN */

---

🌸 ARGUMENTS 🌸

• server — the connection to the audio server, aka your link to the mothership 🛰️
• flow — the ID of the flow, like the group chat the element lives in
• element — the index of the ExportClient element you're pulling data from
• num_bytes — how many bytes of audio data you wanna read, no cap
• data — the buffer the audio data gets read into (bring your own container 🫙)
• status — if it's non-NULL, the output buffer gets flushed and the status from the server comes back to you. The /* RETURN */ is literally her telling you it's the return value slot 👑

---

💜 DESCRIPTION 💜

So here's the tea: AuReadElement transfers audio data from the server over to the client application. It reads num_bytes from the ExportClient that element points at, inside audio flow flow, and drops it right into data. That's it, that's the whole vibe — server data, client buffer, slay ✨

---

🎀 NOTE 🎀

If the flow is "trivial" — meaning it's only an ExportClient and an ImportBucket, nothing else — then the num_samples fields in the ExportClient and the ImportBucket get ignored. Not "respected", not "hinted at", ignored. Periodt. 💀

---

😭 ERRORS 😭

• AuBadFlow
• AuBadElement

(yeah, those two. she's dramatic about it but that's the whole list 🙈)

---

🫶 SEE ALSO 🫶

• AuWriteElement — the other half of the duo, the writer to her reader 💞
• audiolib — Network Audio System C Language Interface

---

and that's the page!! go forth and read your audio data, main character 🧚

mwah 💋 — this was audiolib - read from element, version 1.9.5, and the page itself is AuReadElement(3). ty for coming to my ted talk 🎀✨