1AuElementNotifyEvent(3)    Library Functions Manual    AuElementNotifyEvent(3)
2
3
4

Name

6       AuElementNotifyEvent - element notify event structure
7

Structures

9       #include <audio/audiolib.h>
10
11       typedef union _AuEvent
12       {
13           . . .
14           AuElementNotifyEvent auelementnotify;
15           . . .
16       }AuEvent;
17
18       typedef struct _AuElementNotifyEvent
19       {
20           int type;
21           AuUint32 serial;
22           AuBool send_event;
23           AuServer *server;
24           AuTime time;
25           AuFlowID flow;
26           unsigned char element_num;
27           unsigned char kind;
28           unsigned char prev_state;
29           unsigned char cur_state;
30           unsigned char reason;
31           AuUint32 num_bytes;
32       }AuElementNotifyEvent;
33

Members

35       type      The  event  type.  ElementNotify events are type AuEventType‐
36                 ElementNotify.
37
38       serial    The serial ID of the event expanded from  the  16  bit  value
39                 sent by the server.
40
41       send_event
42                 AuTrue if the event came from a SendEvent protocol request.
43
44       server    The  connection  to  the audio server that the event was read
45                 from.
46
47       time      The server time in milliseconds when the event was generated.
48
49       flow      The ID of the flow that caused the event.
50
51       element_num
52                 The index of the element that caused the event  or  AuElemen‐
53                 tAll to indicate the flow.
54
55       kind      The  kind  of  notify  event.  This will be one of these con‐
56                 stants: AuElementNotifyKindLowWater, AuElementNotifyKindHigh‐
57                 Water, or AuElementNotifyKindState.
58
59       prev_state
60                 The  previous  state  of  the element indexed by element_num.
61                 This will be one of these constants:  AuStateStop,  AuStateS‐
62                 tart, or AuStatePause.
63
64       cur_state The  current  state  of  the  element indexed by element_num.
65                 This will be one of these constants:  AuStateStop,  AuStateS‐
66                 tart, or AuStatePause.
67
68       reason    The  reason  for the notify event.  This will be one of these
69                 constants: AuReasonUser,  AuReasonUnderrun,  AuReasonOverrun,
70                 AuReasonEOF, AuReasonWatermark, or AuReasonHardware.
71
72       num_bytes The  number  of  bytes to send or receive.  Only valid if the
73                 the element indexed by  element_num  is  an  ImportClient  or
74                 ExportClient.
75

Description

77       ElementNotify  events are sent to client applications to notify them of
78       a watermark condition or state change.  If kind is AuElementNotifyKind‐
79       LowWater,  the  ImportClient  element indexed by element_num in flow is
80       ready to receive num_bytes of audio data from the  client  application.
81       If  kind  is  AuElementNotifyKindHighWater,  the  ExportClient  element
82       indexed by element_num in flow is ready to send num_bytes of audio data
83       to  the  client  application.  If kind is AuElementNotifyKindState, the
84       element indexed by element_num (or flow if element_num is AuElementAll)
85       has made a state transition from prev_state to cur_state triggering the
86       event.  Reguardless of kind, prev_state and cur_state contain  the  old
87       and new states and reason contains the reason for the event.
88

See Also

90       AuAnyEvent,  AuErrorEvent,  AuGrabNotifyEvent,  AuMakeSendNotifyAction,
91       AuMonitorNotifyEvent.
92
93       audiolib - Network Audio System C Language Interface
94
95
96
97audiolib - events                    1.9.1             AuElementNotifyEvent(3)
Impressum