IDS Software Suite 4.96.1

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.

cbSizeOfParam

Size (in bytes) of the memory area to which pParam refers.

Status flags from DEVICE_FEATURE_MODE_CAPS

IS_DEVICE_FEATURE_CAP_BLACK_REFERENCE	Displays the black level reference in the image which can be used to calibrate the black level.
IS_DEVICE_FEATURE_CAP_END_OF_EXPOSURE	The camera model supports the IS_SET_EVENT_END_OF_EXPOSURE event (see is_Event())
IS_DEVICE_FEATURE_CAP_EXTENDED_PIXELCLOCK_RANGE	The use of the extended pixel clock range is supported.
IS_DEVICE_FEATURE_CAP_FPN_CORRECTION	Fixed pattern noise correction is supported.
IS_DEVICE_FEATURE_CAP_IMAGE_EFFECT	Image effects are supported.
IS_DEVICE_FEATURE_CAP_JPEG_COMPRESSION	JPEG compression is supported.
IS_DEVICE_FEATURE_CAP_LEVEL_CONTROLLED_TRIGGER	The use of the level controlled trigger is supported.
IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST	Fast line scan mode is supported/Set mode
IS_DEVICE_FEATURE_CAP_LINESCAN_NUMBER	Line number at fast line scan mode is supported/Set number
IS_DEVICE_FEATURE_CAP_LOG_MODE	Log mode is supported/Set mode
IS_DEVICE_FEATURE_CAP_MEMORY_MODE	Internal image memory is supported.
IS_DEVICE_FEATURE_CAP_MULTI_INTEGRATION	Multi integration mode is supported.
IS_DEVICE_FEATURE_CAP_NOISE_REDUCTION	Noise suppression is supported.
IS_DEVICE_FEATURE_CAP_REPEATED_START_CONDITION_I2C	Enabling/disabling the I2C stop bit for the read command is supported.
IS_DEVICE_FEATURE_CAP_SENSOR_BIT_DEPTH	Sets the bit depth of the sensor. With the IS_SENSOR_BIT_DEPTH_AUTO setting the software selects the appropriate sensor bit depth to the chosen image format. The bit depth can also be selected independent from the image format. Attention: As you can choose combinations that does not fit, this function should be used by experts only. In most cases the auto control are sufficient.
IS_DEVICE_FEATURE_CAP_SENSOR_SOURCE_GAIN	Analog sensor source gain is supported.
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_GLOBAL	Global shutter mode is supported/Set mode
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_GLOBAL_ALTERNATIVE_TIMING	Global shutter mode with different timing parameters is supported/Set mode
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_ROLLING	Rolling shutter mode is supported/Set mode
IS_DEVICE_FEATURE_CAP_SHUTTER_MODE_ROLLING_GLOBAL_START	Rolling shutter mode with global start is supported/Set mode
IS_DEVICE_FEATURE_CAP_TEMPERATURE	Display of the internal camera temperature is supported.
IS_DEVICE_FEATURE_CAP_TEMPERATURE_STATUS	Monitoring the temperature status is supported.
IS_DEVICE_FEATURE_CAP_TIMESTAMP_CONFIGURATION	Configuration of the timestamp (e.g. reset the timestamp to 0 at a signal on the trigger pin).
IS_DEVICE_FEATURE_CAP_VERTICAL_AOI_MERGE	Special AOI merge mode which combines the lines of an AOI to a new image.
IS_DEVICE_FEATURE_CAP_WIDE_DYNAMIC_RANGE	The use of the wide dynamic range is supported.

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

Example

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 nMode = IS_DEVICE_FEATURE_CAP_LINESCAN_MODE_FAST;
nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LINESCAN_MODE, (void*)&nMode,
sizeof(nMode));
// Disable line scan mode
nMode = 0;
nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LINESCAN_MODE, (void*)&nMode,
sizeof(nMode));
// Return line scan mode
nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LINESCAN_MODE, (void*)&nMode,
sizeof(nMode));
}
if (nSupportedFeatures & IS_DEVICE_FEATURE_CAP_LINESCAN_NUMBER)
{
// Set line number
INT nLineNumber = 512;
nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_SET_LINESCAN_NUMBER,
(void*)&nLineNumber, sizeof(nLineNumber));
nRet = is_DeviceFeature(hCam, IS_DEVICE_FEATURE_CMD_GET_LINESCAN_NUMBER,
(void*)&nLineNumber, sizeof(nLineNumber));
}
}

Please enable JavaScript to view this site.

IDS Software Suite 4.96.1