alNewEvent(3dm)                                                alNewEvent(3dm)


NAME
     alNewEvent - create and initialize an audio ALevent structure

SYNOPSIS
     #include <dmedia/audio.h>

     ALevent alNewEvent(void)

DESCRIPTION
     alNewEvent creates and initializes an ALevent structure.  An ALevent
     structure contains the event information of a particular audio system
     change.  Events are retrieved from event queues through alNextEvent(3dm)
     and alCheckEvent(3dm).  All events have an audio parameter associated
     with them.  For example, an ALevent with an AL_RATE parameter means that
     an AL_RATE change occurred on an audio resource. Please refer to
     alParams(3dm) for more information.

     To access event information, use the following calls:
     alEventGetSrcResource(3dm), alEventGetResource(3dm), alGetEventUST(3dm),
     alGetEventData(3dm), alGetEventParam(3dm), and alGetEventValue(3dm).
     Some non-scalar parameters require a call to alGetParams(3dm) in order to
     access the event data information.  Refer to alParams(3dm) for more
     information on the specific parameters and their methods for retrieving
     data from an ALevent.

DIAGNOSTICS
     Upon successful completion, alNewEvent returns an opaque ALevent
     structure with all its members initialized to zero. If the structure
     allocation fails, alNewEvent returns 0 and sets an error number which can
     be retrieved with oserror(3C).

     alNewEvent can fail for the following reason:

     AL_BAD_OUT_OF_MEM   insufficient memory is available to allocate the
                         ALevent structure.

SEE ALSO
     alFreeEvent(3dm), alGetEventParam(3dm), alGetEventResource(3dm),
     alGetEventSrcResource(3dm), alGetEventUST(3dm), alGetEventValue(3dm),
     alGetEventData(3dm), alParams(3dm), oserror(3C)


                                                                        Page 1