uEye Camera Manual Version 4.92
 |
 |
USB 2.0 USB 3.0 GigE |
USB 2.0 USB 3.0 GigE |
Syntax
INT is_SetTimeout (HIDS hCam, UINT nMode, UINT Timeout)
Description
Using is_SetTimeout(), you can change user-defined timeout values of the uEye API. If no user-defined timeout is set, the default value of the uEye API is used for the relevant timeout.
For further information, please refer to the How to proceed: Timeout values for image capture section.
 |
The user-defined timeout only applies to the specified camera at runtime of the program. |
Timeout for hardware trigger
If you set a user-defined timeout value, we recommend the following formula for calculating the timeout:
Timeout = (max. time between trigger signals + max. exposure time + frame duration + trigger delay) * factor
•Max. time between trigger signals: the maximum interval between two hardware trigger signals in the application
•Max. exposure time: the maximum exposure time in the application
•Frame duration: 1/frame rate
•Trigger delay: Trigger delay which can be set using is_SetTriggerDelay().
•Factor: The factor should have a value between 1.5 and 2. The application is blocked too long with a too large value and with a too small value you may lost images.
Input parameters
hCam |
Camera handle |
nMode |
Selects the timeout value to be set |
IS_TRIGGER_TIMEOUT |
Sets the timeout value for triggered image capture |
Timeout |
Timeout value in 10 ms. Value range [0; 4...429496729] (corresponds to 40 ms to approx. 1193 hours) 0 = use default value of the uEye API For 1...3, the value 4 is used. |
Return values
IS_CANT_COMMUNICATE_WITH_DRIVER |
Communication with the driver failed because no driver has been loaded. |
IS_CANT_OPEN_DEVICE |
An attempt to initialize or select the camera failed (no camera connected or initialization error). |
IS_INVALID_CAMERA_HANDLE |
Invalid camera handle |
IS_IO_REQUEST_FAILED |
An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match. |
IS_NO_SUCCESS |
General error message |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_SUCCESS |
Function executed successfully |
Related functions
Example
// Set user-defined timeout to 120 seconds
is_SetTimeout(hCam, IS_TRIGGER_TIMEOUT, 12000);
Suggestion for improvement? Send us your short
Feedback on this chapter.
Thank you very much!
For technical questions please contact your local distributor or use the support form on our website.