|
|
USB 2.0 USB 3.0 GigE |
USB 2.0 USB 3.0 GigE |
Syntax
INT is_DeviceFeature (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)
Description
Using is_DeviceFeature() you can configure special camera functions provided by specific uEye models:
•On UI-124x/UI-324x/UI-524x models: Set line scan mode, see Basics: Line scan mode.
•On UI-124x/UI-324x/UI-524x models: Toggle between rolling and global shutter mode, see Basics: Shutter methods.
•On UI-1008XS (uEye XS) model: Choose the HS mode for triggered image capture, see UI-1008XS application notes.
The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the cbSizeOfParam input parameter.
Input parameters
hCam |
Camera handle |
||||||||||||||||||||
|
|||||||||||||||||||||
pParam |
Pointer to a function parameter, whose function depends on nCommand. |
||||||||||||||||||||
nSizeOfParam |
Size (in bytes) of the memory area to which pParam refers. |
||||||||||||||||||||
Status Flags from DEVICE_FEATURE_MODE_CAPS
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_ROLLING |
Rolling shutter mode is supported/Set mode |
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_GLOBAL |
Global shutter mode is supported/Set mode |
IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST |
Fast line scan mode is supported/Set mode |
IS_DEVICE_FEATURE_CAP_LINESCAN_NUMBER |
Line scan mode with selectable line number is supported |
IS_DEVICE_FEATURE_CAP_PREFER_XS_HS_MODE |
HS mode is supported/Set mode |
Return values
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_INVALID_CAPTURE_MODE |
The function can not be executed in the current camera operating mode (free run, trigger or standby). |
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_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_SUCCESS |
General error message |
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 |
INT nSupportedFeatures;
INT nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_SUPPORTED_FEATURES,
(void*)&nSupportedFeatures, sizeof(nSupportedFeatures));
if (nRet == IS_SUCCESS)
{
if (nSupportedFeatures & IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST)
{
// Enable line scan mode
INT nLineMode = IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST;
INT nRet = is_DeviceFeature(m_hCam,IS_DEVICE_FEATURE_CMD_SET_LINESCAN_MODE,
(void*)&nLineMode, sizeof(nLineMode));
// Disable line scan mode
INT nLineMode = 0;
nRet = is_DeviceFeature(m_hCam, IS_DEVICE_FEATURE_CMD_SET_LINESCAN_MODE,
(void*)&nLineMode, sizeof(nLineMode));
}
// Return line scan mode
nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LINESCAN_MODE,
(void*)&nMode , sizeof(nMode));
}
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.