IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 2.0 USB 3.x GigE |
USB 2.0 USB 3.x GigE |
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.
When you call is_CaptureVideo() in trigger mode, the camera is set to continuous trigger standby. An image is recorded on each electrical trigger signal and afterwards the camera is ready to trigger again.
For further information on the image capture modes, see the How to proceed: Image capture section.
Input parameters
hCam |
Camera handle |
Return values
When used with IS_GET_LIVE |
TRUE if live capture is enabled |
3 = IS_CAPTURE_STATUS |
An error occurred during the data transfer, see is_CaptureStatus(). The parameter IS_CAPTURE_STATUS replaces the previous parameter IS_TRANSFER_FAILED. The parameter IS_TRANSFER_FAILED was moved into the new header file ueye_deprecated.h, which contains all obsolete function definitions and constants. If necessary the header file ueye_deprecated.h can be included in addition to the header file ueye.h. |
IS_BAD_STRUCTURE_SIZE |
An internal structure has an incorrect size. |
IS_CANT_COMMUNICATE_WITH_DRIVER |
Communication with the driver failed because no driver has been loaded. |
IS_CAPTURE_RUNNING |
A capturing operation is in progress and must be terminated first. |
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 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_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. |
IS_NO_SUCCESS |
General error message |
IS_NOT_CALIBRATED |
The camera does not contain any calibration data. |
IS_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_OUT_OF_MEMORY |
No memory could be allocated. |
IS_SUCCESS |
Function executed successfully |
IS_TIMED_OUT |
A timeout occurred. An image capturing process could not be terminated within the allowable period. |
IS_TRIGGER_ACTIVATED |
The function cannot be used because the camera is waiting for a trigger signal. |
Related functions
Sample programs
•SimpleLive (C++)
•uEyeC# Demo (C#)
