Timeout values for image capture

uEye Camera Manual Version 4.92


Timeout values for image capture

When you call is_FreezeVideo() or is_CaptureVideo(), the timeout value for the image capture is determined from the Wait parameter. If no image arrives within this timeout period, a timeout error message is issued. Under Windows, a dialog box is displayed if you have enabled error reports (see is_SetErrorReport()). Information on the error cause can be queried using is_CaptureStatus().

The following table shows the effect of the Wait parameter depending on the image capture mode:

Parameter Wait

Image capture mode

Function returns

Timeout for 1st image

Timeout for subsequent images*1

IS_DONT_WAIT

Hardware trigger

When command completed*4

API default or user-defined value*3

API default or user-defined value*3

IS_WAIT

Hardware trigger

When 1st image in memory

API default or user-defined value*3

API default or user-defined value*3

Time t

Value range [4...429496729]

Hardware trigger

When 1st image in memory

Time t in steps of 10 ms

(40 ms to approx. 1193 h)

API default or user-defined value*3

IS_DONT_WAIT

Freerun/software trigger

When command completed*4

Calculated internally by API*2

Calculated internally by API*2

IS_WAIT

Freerun/software trigger

When 1st image in memory

Calculated internally by API*2

Calculated internally by API*2

Time t

Value range [4...429496729]

Freerun/software trigger

When 1st image in memory

Time t in steps of 10 ms

(40 ms to approx. 1193 h)

Calculated internally by API*2

*1 Only with continuous image capture using is_CaptureVideo()

*2 The timeout is calculated from the exposure time setting, the image transfer time (depending on the pixel clock) and the optional trigger delay (see is_SetTriggerDelay()); it is at least 40 ms.

*3 The default value of the uEye API is 60 s. User-defined values can be set using the is_SetTimeout() function.

*4 If an error occurs, e. g. camera is not available, it may take some time until the function returns.

hint_info

In combination with IS_DONT_WAIT the functions returns immediately, so you have to use the API event IS_SET_EVENT_FRAME for querying if the image is available in the memory.

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.


© 2019 IDS Imaging Development Systems GmbH
https://en.ids-imaging.com