AuElementNotifyEvent(3)

✨ NAME ✨

okay so bestie, welcome to the AuElementNotifyEvent(3) page from the audiolib manual 💖 — it's all about the element notify event structure. No cap, this is your guide to knowing when audio elements are like “hey, I got bytes” or “hey, I changed state.” 👑

🎀 STRUCTURES 🎀

First, include this:

#include <audio/audiolib.h>

Then the union and the struct, exactly like this:

       #include <audio/audiolib.h>

       typedef union _AuEvent
       {
           . . .
           AuElementNotifyEvent auelementnotify;
           . . .
       }AuEvent;

       typedef struct _AuElementNotifyEvent
       {
           int type;
           AuUint32 serial;
           AuBool send_event;
           AuServer *server;
           AuTime time;
           AuFlowID flow;
           unsigned char element_num;
           unsigned char kind;
           unsigned char prev_state;
           unsigned char cur_state;
           unsigned char reason;
           AuUint32 num_bytes;
       }AuElementNotifyEvent;

So AuEvent is a union, and one of its members is AuElementNotifyEvent auelementnotify; — that’s the one we’re obsessed with. 💅

💅 MEMBERS 💅

• type — the event type, bestie. ElementNotify events are type AuEventTypeElementNotify. 💖
• serial — the serial ID of the event expanded from the 16 bit value sent by the server. 🧚
• send_event — AuTrue if the event came from a SendEvent protocol request. ✨
• server — the connection to the audio server that the event was read from. 🫶
• time — the server time in milliseconds when the event was generated. ⏰
• flow — the ID of the flow that caused the event. 🌊
• element_num — the index of the element that caused the event, or AuElementAll to indicate the flow. 🎯
• kind — the kind of notify event. This will be one of these constants: AuElementNotifyKindLowWater, AuElementNotifyKindHighWater, or AuElementNotifyKindState. 🔥
• prev_state — the previous state of the element indexed by element_num. This will be one of these constants: AuStateStop, AuStateStart, or AuStatePause. 🦋
• cur_state — the current state of the element indexed by element_num. This will be one of these constants: AuStateStop, AuStateStart, or AuStatePause. 🌈
• reason — the reason for the notify event. This will be one of these constants: AuReasonUser, AuReasonUnderrun, AuReasonOverrun, AuReasonEOF, AuReasonWatermark, or AuReasonHardware. 💀
• num_bytes — the number of bytes to send or receive. Only valid if the element indexed by element_num is an ImportClient or ExportClient. 📦

🌈 DESCRIPTION 🌈

ElementNotify events are sent to client applications to notify them of a watermark condition or state change. That’s the whole vibe. 💫

If kind is AuElementNotifyKindLowWater, the ImportClient element indexed by element_num in flow is ready to receive num_bytes of audio data from the client application. 🎧

If kind is AuElementNotifyKindHighWater, the ExportClient element indexed by element_num in flow is ready to send num_bytes of audio data to the client application. 📤

If kind is AuElementNotifyKindState, the element indexed by element_num (or flow if element_num is AuElementAll) has made a state transition from prev_state to cur_state triggering the event. ✨

Reguardless of kind, prev_state and cur_state contain the old and new states, and reason contains the reason for the event. 👑

🔗 SEE ALSO 🔗

• AuAnyEvent
• AuErrorEvent
• AuGrabNotifyEvent
• AuMakeSendNotifyAction
• AuMonitorNotifyEvent
• audiolib — Network Audio System C Language Interface

Mwah 💋 this has been the AuElementNotifyEvent(3) page, from audiolib - events, version 1.9.4. The footer didn’t give a date, bestie 🙈 — so no date, just vibes, version 1.9.4, and the manual name AuElementNotifyEvent(3). Stay hydrated and check your watermarks. 💖✨