AuGetElements(3)

💖 AuGetElements(3) 💖

okay bestie, welcome to the Library Functions Manual corner of the group chat — this one's all about pulling the elements out of a flow, and it's genuinely so useful, iykyk. ✨

🌸 NAME 🌸

AuGetElements — get the elements in a flow 🦋

✨ SYNOPSIS ✨

#include <audio/audiolib.h>

AuElement *AuGetElements(server, flow, clocked, num_elements, status)
    AuServer *server;
    AuFlowID flow;
    AuBool *clocked; /* RETURN */
    int *num_elements; /* RETURN */
    AuStatus *status; /* RETURN */

🎀 ARGUMENTS 🎀

• server — the connection to the audio server. like, your whole link to the server bestie, you gotta hand it over. 💅
• flow — the ID of the flow you wanna grab elements from. that's the one, no cap.
• clocked — returns a boolean value that tells you if the flow is clocked. RETURN value, so she writes back to you. ⭐
• num_elements — returns the number of elements. RETURN energy again, she's giving you the count. 🔢
• status — if it's non-NULL, it flushes the output buffer and returns the status straight from the server. RETURN girly is reporting back. 📬

🌈 DESCRIPTION 🌈

so here's the tea: AuGetElements returns the list of elements that make up flow — or NULL, with num_elements set to 0, if there was an error. 😭 (yes, on an error you get the NULL and the zero, both, together, that's the deal.)

and when you're done with that list? use AuFreeElements to free it when it's nolonger needed. don't be the person who leaks, bestie, that's not the vibe. 🫶

💀 ERRORS 💀

• AuBadFlow. that's the one. that's the whole list. 🙈

👑 SEE ALSO 👑

• AuSetElements.
• audiolib — Network Audio System C Language Interface

mwah 💋 that's the page, and the sign-off goes out to the source audiolib, version 1.9.4, filed under the footer vibe "audiolib - flow elements" — periodt. 🎀✨