auelementnotifyevent(3) [debian man page]

AuElementNotifyEvent(3) Library Functions Manual AuElementNotifyEvent(3)

Name
AuElementNotifyEvent - element notify event structure

Structures
#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;

Members
type The event type. 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 AuS-
tatePause.

reason The reason for the notify event. This will be one of these constants: AuReasonUser, AuReasonUnderrun, AuReasonOverrun, AuReaso-
nEOF, AuReasonWatermark, or AuReasonHardware.

num_bytes The number of bytes to send or receive. Only valid if the 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. If kind is AuElementNoti-
fyKindLowWater, the ImportClient element indexed by element_num in flow is ready to receive num_bytes of audio data from the client appli-
cation. 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

audiolib - events 1.9.3 AuElementNotifyEvent(3)

Check Out this Related Man Page

AuSoundPlayFromBucket(3)				     Library Functions Manual					  AuSoundPlayFromBucket(3)

Name
       AuSoundPlayFromBucket - create a flow to play from a bucket.

Synopsis
       #include <audio/audiolib.h>
       #include <audio/soundlib.h>

       AuEventHandlerRec  *AuSoundPlayFromBucket(server, source, destination, volume, callback, callback_data, loop_count, flow, volume_mult_elem,
       monitor_element, status)
	   AuServer *server;
	   AuBucketID source;
	   AuDeviceID destination;
	   AuFixedPoint volume;
	   void (*callback) (AuServer *, AuEventHandlerRec *, AuEvent *, AuPointer);
	   AuPointer callback_data;
	   int loop_count;
	   AuFlowID *flow; /* RETURN */
	   int *volume_mult_elem; /* RETURN */
	   int *monitor_element; /* RETURN */
	   AuStatus *status; /* RETURN */

Arguments
       server	 Specifies the connection to the audio server.

       source	 Specifies the bucket to play.

       destination
		 Specifies the device to output the audio data.

       volume	 Specifies the volume.

       callback  Specifies the procedure to be called for additional event processing.

       callback_data
		 Specifies any additional arguments to be passed to the callback.

       loop_count
		 Specifies how many time the bucket should be played.

       flow	 If non-NULL, returns the flow ID.

       volume_mult_elem
		 If non-NULL, returns the index of the volume multipler element.

       monitor_element
		 If non-NULL, include an ExportMonitor element in the flow and return it's index.

       status	 If non-NULL, flush the output buffer and return the status from the server.

Description
       AuSoundPlayFromBucket creates a flow to play bucket on device and returns a pointer to the event handler created or NULL if  there  was	an
       error.

Errors
       AuBadBucket, AuBadDevice.

See Also
       AuSoundPlay, AuSoundPlayFromData, AuSoundPlayFromFile, AuSoundPlaySynchronousFromFile.

       audiolib - Network Audio System C Language Interface

soundlib							       1.9.3						  AuSoundPlayFromBucket(3)

Linux and UNIX Man Pages

auelementnotifyevent(3) [debian man page]

Check Out this Related Man Page