THORLABS DCU223x User Manual

© 2013 Thorlabs GmbH
4 Programming (SDK)
177
4.3.8 is_CaptureVideo
USB 2.0
USB 3.0
USB 2.0
USB 3.0
Syntax
INT is_CaptureVideo (HIDS hCam, INT Wait)
Description
is_CaptureVideo() activates the camera's live video mode (free run mode). The driver transfers the images to
an allocated image memory or, if Direct3D/OpenGL is used, to the graphics card. The image data (DIB mode) is
stored in the memory created using is_AllocImageMem() and designated as active image memory using
is_SetImageMem() . Using is_GetImageMem() , you can query the memory address.
If ring buffering is used, the image capturing function cycles through all image memories used for storing the
images of a capture sequence in an endless loop. Sequence memories locked by is_LockSeqBuf() will be
skipped. If the last available sequence memory has been filled, the sequence event or message will be triggered.
Capturing always starts with the first element of the sequence.
For further information on the image capture modes, see the How to proceed: Image capture section.
Input parameters
hCam
Camera handle
Wait
IS_DONT_WAIT
Timeout value for image capture (see also the How to
proceed: Timeout values for image capture section)
IS_WAIT
Time t
IS_GET_LIVE
Returns if live capture is enabled.
Return values
When used with
IS_GET_LIVE
TRUE if live capture is enabled
IS_BAD_STRUCTURE_SIZE
An internal structure has an incorrect size.
IS_CANT_COMMUNICATE_WITH_DRI
VER
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_CAPTURE_RUNNING
A capturing operation is in progress and must be terminated before you
can start another one.
IS_INVALID_BUFFER_SIZE
The image memory has an inappropriate size to store the image in the
desired format.
IS_INVALID_CAMERA_TYPE
The camera type defined in the .ini file does not match the current camera
model.
IS_INVALID_EXPOSURE_TIME
This setting is not available for the currently set exposure time.
IS_INVALID_CAMERA_HANDLE
Invalid camera handle
IS_INVALID_MEMORY_POINTER
Invalid pointer or invalid memory ID
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_IO_REQUEST_FAILED
An IO request from the uc480 driver failed. Possibly the versions of the
uc480_api.dll (API) and the driver file (uc480_usb.sys) do not
match.
IS_NO_ACTIVE_IMG_MEM
No active image memory available. You must set the memory to active
using the is_SetImageMem() function or create a sequence using the
is_AddToSequence() function.
157
337 247
289
134
135

THORLABS DCU223x Specifications

General

Brand	THORLABS
Model	DCU223x
Category	Security Camera
Language	English