AuElementState(3)

✨ AuElementState(3) ✨

okay bestie, pull up a chair πŸ’– this is a page from the Library Functions Manual, and it's about AuElementState β€” yes, that's the whole name, AuElementState(3), section 3, library functions, we're in the grown-up section but we're still gonna have fun.


πŸŽ€ Name πŸŽ€

AuElementState β€” the element state structure. that's it, that's the vibe. element state structure πŸ’…


πŸ¦‹ Structures πŸ¦‹

first things first, you gotta pull in the header:

#include <audio/audiolib.h>

and here's the struct, in all its glory, no cap:

typedef struct _AuElementState
{
    AuFlowID flow;
    unsigned char element_num;
    unsigned char state;
    unsigned short pad;
}AuElementState;

look at her. she's small but she's doing so much. πŸ‘‘


πŸ’œ Members πŸ’œ

  • flow β€” specifies the flow. that's the flow, babe. πŸŒ€
  • element_num β€” specifies the index of the element of interest. and here's the plot twist: if you wanna reach the state of the flow itself, use AuElementAll. yes literally, that's the move. use AuElementAll to access the state of the flow. 🌸
  • state β€” specifies the state of the element (or flow) specified by element_num. this one has to be one of these constants, and only these:
    • AuStateStop
    • AuStateStart
    • AuStatePause

pick one, bestie, those are the options. no improvising. 🎯


🌈 Description 🌈

so the AuElementState structure is the thing you use to access the state of elements inside a flow. simple concept, big responsibility. 🫢

and here's the part people always miss β€” not everything has state. only flows and component elements do. the component elements are:

  • ExportBucket
  • ExportClient
  • ExportDevice
  • ImportClient
  • ImportDevice
  • ImportBucket
  • ImportWaveForm

those seven. if it's not a flow and it's not on that list, it does not have state, and it's not gonna have state, periodt. πŸ’€ don't ask it for one.


⭐ See Also ⭐

  • AuGetElementStates
  • AuMakeElementState
  • AuGetElementStates

(yes it's listed twice, and honestly? iconic. we love a callback. πŸ”₯)

  • audiolib β€” Network Audio System C Language Interface

and that's the whole page, mwah πŸ’‹ go forth and check your element states, you've got this, i believe in you fr fr 🧚✨


this page is from audiolib, version 1.9.4, dated with all the love of AuElementState(3) β€” audiolib - element state structure, and that's the sign-off, byeee πŸŽ€πŸ’–

πŸ“¦ where this page comes from