alGetEventQueueFD(3dm)                                  alGetEventQueueFD(3dm)


NAME
     alGetEventQueueFD - get the file descriptor for an audio event queue

SYNOPSIS
     #include <dmedia/audio.h>

     int alGetEventQueueFD(ALeventQueue eventq)

PARAMETER
     eventq   expects the ALeventQueue structure whose file descriptor you
              desire.  This structure is the returned value of an
              alOpenEventQueue(3dm) call.

DESCRIPTION
     alGetEventQueueFD() returns a file descriptor that you can use to
     construct the arguments to a select(2)  or poll(2) call.

     These calls are used when you want to block a process until a queue
     receives an audio event (see alSelectEvents(3dm)).  At that time,
     select(2) and poll(2) return, and your code can retrieve the event
     information through calls to alNextEvent(3dm) or alCheckEvent(3dm).
     NOTE: alNextEvent(3dm) will block if passed an event queue that is empty.

     When using select(2), an event queue file descriptor is used in a read
     fdset.

     When using poll(2), an event queue file descriptor is used with the
     POLLIN event flag.

DIAGNOSTICS
     Upon successful completion, alGetEventQueueFD returns a valid file
     descriptor. Otherwise, alGetEventQueueFD returns -1 and sets an error
     number which can be retrieved with oserror(3C).

     alGetEventQueueFD can fail for the following reason:

     AL_BAD_INVALID_EVENTQ   eventq is either invalid or null.

SEE ALSO
     alSelectEvents(3dm), alOpenEventQueue(3dm), alNextEvent(3dm),
     alCheckEvent(3dm), select(2), poll(2), oserror(3C)


                                                                        Page 1