AuGetElementStates(3)

πŸ“¦ version 1.9.5, in fedora 43, fedora 44

πŸ’– AuGetElementStates(3) πŸ’–

okay bestie, we're in the Library Functions Manual today and this one is literally all about peeking at the state of elements in a flow ✨ so let's get into it


πŸŽ€ NAME πŸŽ€

AuGetElementStates β€” get the state of elements in a flow πŸ’…


🌸 SYNOPSIS 🌸

#include <audio/audiolib.h>

AuElementState *AuGetElementStates(server, num_states, states, status)
    AuServer *server;
    int *num_states; /* SEND and RETURN */
    AuElementState *states;
    AuStatus *status; /* RETURN */

πŸ¦‹ ARGUMENTS πŸ¦‹

  • server β€” the connection to the audio server, aka your lil link to the whole operation 🫢
  • num_states β€” you send the number of element states that are in states, and it returns the number of element states that actually came back. it's giving send and return, it's giving multitasking πŸ‘‘
  • states β€” the list of AuElementState structures, and those are the ones saying which flow and which element number you want the state of. like a lil wishlist of states πŸ“
  • status β€” if it's non-NULL, the output buffer gets flushed and you get the status straight from the server. if it's NULL, no status for you, no cap 🌈

⭐ DESCRIPTION ⭐

AuGetElementStates returns a list of element states, or NULL with num_states set to 0 if there was an error 😭

and when you're done with that list? use AuFreeElementStates to free it when it's no longer needed, bestie. clean up after yourself, main character energy fr fr 🧚


πŸ’€ NOTES πŸ’€

okay so this is the important bit: if you try to get the state of a non-component element β€” and that's AddConstant, Bundle, ExportMonitor, MultiplyConstant, and Sum β€” you will get an error. not a vibe. don't do it πŸ™ˆ

🚨 ERRORS 🚨

the possible errors are AuBadFlow, AuBadLength, AuBadAlloc, and AuBadElement πŸ’€


πŸ”₯ SEE ALSO πŸ”₯

  • AuSetElementStates β€” the other half of this whole situation, the setter to this getter πŸ’œ
  • audiolib β€” Network Audio System C Language Interface

and that's the whole page, periodt ✨ this was audiolib β€” flow elements states, version 1.9.5, from the AuGetElementStates(3) era, and honestly? iconic. go forth and get those states, bestie πŸ’–πŸŽ€πŸ¦‹

πŸ“¦ where this page comes from