is_EnableEvent

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_EnableEvent (HIDS hCam, INT which)

Description

Using is_EnableEvent(), you release an event object. Following the release, the event messages for the created event object are enabled. Depending on the operating system different functions are to call.

Windows

•Event has to be provided by the application program

•Event has to be declared by is_InitEvent()

•Event has to be activated by is_EnableEvent()

•You have to wait for the event in the application program by WaitForSingleObject or WaitForMultipleObject

•Event has to be deactivated by is_DisableEvent()

•Event has to be logged off by is_ExitEvent()

Linux

•Event has to be provided by the uEye API

•Event has to be activated by is_EnableEvent()

•You have to wait for the event by is_WaitEvent()

•Event has to be deactivated by is_DisableEvent()

Input parameters

hCam

Camera handle

ID of the event to be released.

IS_SET_EVENT_FRAME	A new image is available.
IS_SET_EVENT_EXTTRIG	An image which was captured following the arrival of a trigger has been transferred completely. This is the earliest possible moment for a new capturing process. The image must then be post-processed by the driver and will be available after the IS_FRAME processing event.
IS_SET_EVENT_SEQ	The sequence is completed.
IS_SET_EVENT_STEAL	An image extracted from the overlay is available.
IS_SET_EVENT_CAPTURE_STATUS	There is an information about image capturing available. This information can be requested by is_CaptureStatus(). Note that this event replaces the former IS_SET_EVENT_TRANSFER_FAILED from previous versions.
IS_SET_EVENT_DEVICE_RECONNECTED	A camera initialized with is_InitCamera() and disconnected afterwards was reconnected.
IS_SET_EVENT_WB_FINISHED	The automatic white balance control is completed.
IS_SET_EVENT_AUTOBRIGHTNESS_FINISHED	The automatic brightness control in the run-once mode is completed.
IS_SET_EVENT_OVERLAY_DATA_LOST	Direct3D mode: Because of a re-programming the parameters of the overlay are invalid. The overlay must be draw new.
IS_SET_EVENT_REMOVE	A camera initialized with is_InitCamera() was disconnected.
IS_SET_EVENT_REMOVAL	A camera was removed. This is independent of the device handle (hCam is ignored).
IS_SET_EVENT_NEW_DEVICE	A new camera was connected. This is independent of the device handle (hCam is ignored).
IS_SET_EVENT_STATUS_CHANGED	Linux only: The availability of a camera has changed, e.g. an available camera was opened.

Return values

IS_INVALID_CAMERA_HANDLE	Invalid camera handle
IS_INVALID_PARAMETER	One of the submitted parameters is outside the valid range or is not supported for this sensor or is not available in this mode.
IS_NO_SUCCESS	General error message
IS_SUCCESS	Function executed successfully

Related functions

•is_DisableEvent()

•Windows only: is_InitEvent()

•Windows only: is_ExitEvent()

•Linux only: is_WaitEvent()

Example Window

HANDLE hEvent = CreateEvent(NULL, FALSE, FALSE, NULL);

is_InitEvent(hCam, hEvent, IS_SET_EVENT_FRAME);

is_EnableEvent(hCam, IS_SET_EVENT_FRAME);

is_FreezeVideo(hCam, IS_DONT_WAIT);

DWORD dwRet = WaitForSingleObject(hEvent, 1000);

if (dwRet == WAIT_TIMEOUT)

{

/* wait timed out */

}

else if (dwRet == WAIT_OBJECT_0)

{

/* event signalled */

}

is_DisableEvent(hCam, IS_SET_EVENT_FRAME);

is_ExitEvent(hCam, IS_SET_EVENT_FRAME);

CloseHandle(hEvent);

Example Linux

is_EnableEvent(hCam, IS_SET_EVENT_FRAME);

is_FreezeVideo(hCam, IS_DONT_WAIT);

INT nRet = is_WaitEvent(hCam, IS_SET_EVENT_FRAME, 1000);

if (nRet == IS_TIMED_OUT)

{

/* wait timed out */

}

else if (nRet == IS_SUCCESS)

{

/* event signalled */

}

is_DisableEvent(hCam, IS_SET_EVENT_FRAME);

Sample programs

•SimpleLive (C++)

•uEyeEvent (C++)

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!

For technical questions please contact you local distributor or use the support form on our website.

Home > C: Programming > Function descriptions >	History back Previous chapter Next chapter Print
is_EnableEvent