THORLABS DCU223x User Manual

© 2013 Thorlabs GmbH288
DCx Cameras
4.3.65 is_IsVideoFinish
USB 2.0
USB 3.0
USB 2.0
USB 3.0
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
hCam
Camera handle
pbo
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
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_FreezeVideo()
is_HasVideoStarted()
223
223
259

THORLABS DCU223x Specifications

General

Brand	THORLABS
Model	DCU223x
Category	Security Camera
Language	English