© 2016 Thorlabs Scientific Imaging
4 Programming (SDK)
299
4.3.66 is_IsVideoFinish
Syntax
INT is_IsVideoFinish (HIDS hCam, INT* pbo)
Description
Using is_IsVideoFinish(), you can check whether an image has been captured and stored
completely in the image memory. This function is helpful if the is_FreezeVideo() function was
called with the IS_DONT_WAIT parameter.
By setting the *pbo==IS_CAPTURE_STATUS parameter before calling is_IsVideoFinish(), you can
also check whether a transfer or post-processing error occurred.
Input parameters
By setting *pbo != IS_CAPTURE_STATUS before calling the function,
pbo contains the following digitizing status:
IS_VIDEO_NOT_FINISH = Digitizing of the image is not completed
yet.
IS_VIDEO_FINISH = Digitizing of the image is completed.
By setting *pbo == IS_CAPTURE_STATUS before calling the function,
pbo contains the following digitizing status:
IS_VIDEO_NOT_FINISH = Digitizing of the image is not completed
yet.
IS_VIDEO_FINISH = Digitizing of the image is completed.
IS_CAPTURE_STATUS = Transfer error or conversion problem (e.g.
destination memory is invalid)
The parameter IS_CAPTURE_STATUS replaces the previous
parameter IS_TRANSFER_FAILED.
The parameter IS_TRANSFER_FAILED was moved into the new
header file uc480_deprecated.h, which contains all obsolete
function definitions and constants. If necessary the header file
uc480_deprecated.h can be included in addition to the header file
uc480.h.
Return values
One of the submitted parameters is outside the
valid range or is not supported for this sensor or
is not available in this mode.
Function executed successfully
Related functions
is_FreezeVideo()