$NCDId: @(#)AuElNEvt.man,v 1.1 1994/09/27 00:25:57 greg Exp $ copyright 1994 Steven King portions are * Copyright 1993 Network Computing Devices, Inc. * * Permission to use, copy, modify, distribute, and sell this software and its * documentation for any purpose is hereby granted without fee, provided that * the above copyright notice appear in all copies and that both that * copyright notice and this permission notice appear in supporting * documentation, and that the name Network Computing...
NameAuElementNotifyEvent - element notify event structure
typedef union _AuEvent
. . .
. . .
typedef struct _AuElementNotifyEvent
unsigned char element_num;
unsigned char kind;
unsigned char prev_state;
unsigned char cur_state;
unsigned char reason;
- The event type. ElementNotify events are type AuEventTypeElementNotify.
- The serial ID of the event expanded from the 16 bit value sent by the server.
- AuTrue if the event came from a SendEvent protocol request.
- The connection to the audio server that the event was read from.
- The server time in milliseconds when the event was generated.
- The ID of the flow that caused the event.
- The index of the element that caused the event or AuElementAll to indicate the flow.
- The kind of notify event. This will be one of these constants: AuElementNotifyKindLowWater, AuElementNotifyKindHighWater, or AuElementNotifyKindState.
- The previous state of the element indexed by element_num. This will be one of these constants: AuStateStop, AuStateStart, or AuStatePause.
- The current state of the element indexed by element_num. This will be one of these constants: AuStateStop, AuStateStart, or AuStatePause.
- The reason for the notify event. This will be one of these constants: AuReasonUser, AuReasonUnderrun, AuReasonOverrun, AuReasonEOF, AuReasonWatermark, or AuReasonHardware.
- The number of bytes to send or receive. Only valid if the the element indexed by element_num is an ImportClient or ExportClient.
DescriptionElementNotify events are sent to client applications to notify them of a watermark condition or state change. 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 AlsoAuAnyEvent, AuErrorEvent, AuGrabNotifyEvent, AuMakeSendNotifyAction, AuMonitorNotifyEvent.
audiolib - Network Audio System C Language Interface