AuPauseFlow(3)

✨ AuPauseFlow ✨

okay bestie, welcome to the AuPauseFlow(3) page from the Library Functions Manual 💖 this is a lil function that lives in the audiolib world and it does exactly one thing, and honestly? it does it flawlessly. it's giving pause a flow. that's it. that's the whole vibe. 🎀

🌸 Name 🌸

AuPauseFlow — pause a flow. no cap, that's literally the entire job description. 🫶

🦋 Synopsis 🦋

#include <audio/audiolib.h>

void AuPauseFlow(server, flow, status)
    AuServer *server;
    AuFlowID flow;
    AuStatus *status; /* RETURN */

so you're pulling in <audio/audiolib.h>, and then you call AuPauseFlow with three things: your server, the flow you wanna pause, and a status pointer that's marked /* RETURN */ because it's gonna hand info back to you. 👑

💅 Arguments 💅

• server — the connection to the audio server. like, which server are we talking to bestie, that one. 🔌
• flow — the ID of the flow you want to pause. that specific flow. not the other ones. her. 💜
• status — if this is non-NULL, the output buffer gets flushed and the status from the server comes back to you. if it's NULL, well, no status for you and that's fine too. 🌈

🎀 Description 🎀

okay so AuPauseFlow pauses flow. that's the moment. 🙈 and the way it works is so satisfying: all of the elements in flow get their state set to AuStatePause. every single one. no element left behind. it's a whole collective pause moment, main character energy for the entire flow. 💖

💀 Errors 💀

AuBadFlow.

yeah. that's the one. if your flow ID is bad, you're getting AuBadFlow and the function is not gonna be nice about it. 😭

⭐ See Also ⭐

• AuStartFlow
• AuStopFlow
• audiolib — Network Audio System C Language Interface

iykyk, the flow-control trio right there. go read those next bestie. 🔥

cute lil sign-off time 🎀 this page came from audioutil, version 1.9.4, and it's the AuPauseFlow(3) page, dated whenever that version dropped. mwah. 💖✨🦋