|
|
USB 2.0 USB 3.0 GigE |
USB 2.0 USB 3.0 GigE |
Syntax
INT is_FreezeVideo (HIDS hCam, INT Wait)
Description
is_FreezeVideo() acquires a single image from the camera. In DIB mode, the image is stored in the active image memory. If ring buffering is used in DIB mode, the captured image is transferred to the next available image m emory of the sequence. Once the last available sequence memory has been filled, the sequence event or message will be triggered.
In Direct3D mode, the is directly copied to the graphics card buffer and then displayed.
Image capture will be started by a trigger if you previously enabled the trigger mode using is_SetExternalTrigger(). A hardware triggered image acquisition can be cancelled using is_StopLiveVideo() if exposure has not started yet.
For further information on the image capture modes of the uEye camera, see the How to proceed: Image capture section.
Input parameters
hCam |
Camera handle |
||||
|
|||||
Return values
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_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 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_USB20 |
The camera is connected to a port which does not support the USB 2.0 high-speed standard. |
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_TIMED_OUT |
A timeout occurred. An image capturing process could not be terminated within the allowable period. |
IS_SUCCESS |
Function executed successfully |
IS_TRANSFER_ERROR |
Transfer error. Frequent transfer errors can mostly be avoided by reducing the pixel rate. |
Related functions
Example
Enable trigger mode, set high-active flash mode and capture an image:
is_SetExternalTrigger(hCam, IS_SET_TRIGGER_SOFTWARE);
// Set the flash to a high active pulse for each image in the trigger mode
UINT nMode = IO_FLASH_MODE_TRIGGER_HI_ACTIVE;
is_IO(m_hCam, IS_IO_CMD_FLASH_SET_MODE, (void*)&nMode, sizeof(nMode));
is_FreezeVideo(hCam, IS_WAIT);
Sample programs
•SimpleAcquire (C++)
•uEyeC# Demo (C#)
Suggestion for improvement? Send us your short Feedback on this chapter.
Thank you very much!
For technical questions please contact you local distributor or use the support form on our website.