AuMakeSendNotifyAction(3)

πŸ’– AuMakeSendNotifyAction β€” the library-functions manual, but make it cute πŸ’–

okay bestie, so this is a page from the Library Functions Manual, and today's main character is AuMakeSendNotifyAction(3). it's an audiolib thing. it initializes an action. that's the whole vibe. let's get into it πŸŽ€


✨ Name ✨

AuMakeSendNotifyAction β€” initialize an action 🫢


✨ Synopsis ✨

#include <audio/audiolib.h>

AuMakeSendNotifyAction(action, trigger_state, trigger_prev_state,
trigger_reason)
    AuElementAction action; /* RETURN */
    unsigned char trigger_state;
    unsigned char trigger_prev_state;
    unsigned char trigger_reason;

like, yes, it's a macro wearing a function costume, we'll get there πŸ’…


✨ Arguments ✨

  • action β€” this one's the RETURN girlie: it hands you back the initialized action. she's not an input, she's an output. respect her role πŸ‘‘
  • trigger_state β€” the state that triggers the action. no cap, it must be one of thses constants: AuStateStop, AuStateStart, or AuStatePause. pick wrong and it's giving invalid, so don't πŸ™ˆ
  • trigger_prev_state β€” the previous state for the trigger, aka the before-times energy. it must be one of thses constants: AuStateStop, AuStateStart, AuStatePause, or AuStateAny. yes, AuStateAny is invited to this party too, she's the flexible friend 🌈
  • trigger_reason β€” the reason for the action. the why, the lore, the backstory. it must be one of these constants: AuReasonUser, AuReasonUnderrun, AuReasonOverrun, AuReasonEOF, AuReasonWatermark, AuReasonHardware, or AuReasonAny. that's seven options bestie, count them, i did πŸ”₯

✨ Description ✨

so what does AuMakeSendNotifyAction actually do? it sets the action field of action to AuElementActionSendNotify β€” yes the field and the argument share a name, iconic, we love a self-referential moment β€” and then it initializes all the other fields using the remaining arguments. that's it. that's the whole plot ✨

🧚 little heads-up: AuMakeSendNotifyAction is implemented as a macro. so don't be out here taking its address or doing weird function-pointer things, she's a macro, she said what she said πŸ’…

✨ See Also ✨

  • AuMakeChangeStateAction
  • AuMakeNoopAction
  • audiolib β€” Network Audio System C Language Interface 🌸

and that's the page, bestie!! πŸŽ€ this was audiolib - action initialization, version 1.9.4, dated AuMakeSendNotifyAction(3) β€” slay, go initialize an action, you've got this πŸ’–πŸ¦‹β­

πŸ“¦ where this page comes from