alGetEventResource(3dm)alGetEventResource(3dm)NAMEalGetEventResource - Return audio resource that posted event
SYNOPSIS
#include <dmedia/audio.h>
ALvalue alGetEventResource(ALevent event)
PARAMETER
event expects an ALevent structure initialized by alNextEvent(3dm) or
alCheckEvent(3dm).
DESCRIPTIONalGetEventResource returns the value of the resource that posted the
event. A resource will post an event to an event queue if it was selected
through alSelectEvents(3dm).
It is important to note that the return value of alGetEventResource(3dm)
is not necessarily the same value of the resource that generated the
event. Similar to alGetParams(3dm) and alQueryParams(3dm), audio events
follow a resource hierarchy. For example, one can set AL_RATE on a
device, even though the parameter is really handled by the device's
clock-generator, a separate resource. Similarly, if one requests an event
for AL_RATE on a device, an event will be posted when the AL_RATE on its
clock-generator changes. In this case, we say that the device posted the
event, and that the clock-generator generated the event. To obtain the
value of the resource that generated the event, use
alGetEventSrcResource(3dm).
DIAGNOSTICS
Upon successful completion, alGetEventResource(3dm) returns a non zero
resource. Otherwise, it returns zero, and sets an error number. This
error number can be retrieved with oserror(3C).
alGetEventResource can fail for the following reason:
AL_BAD_INVALID_EVENT event is invalid or null.
SEE ALSOalNewEvent(3dm), alNextEvent(3dm), alCheckEvent(3dm), alParams(3dm),
alGetEventData(3dm), alGetParams(3dm), alGetEventSrcResource(3dm),
alQueryParams(3dm),oserror(3C)
Page 1
