Please enable JavaScript to view this site.

IDS Software Suite 4.96.1

Windows_Logo
Linux_Logo

USB 2.0

USB 3.x

GigE

USB 2.0

USB 3.x

GigE

Syntax

INT is_Exposure (HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParam)

Description

Using is_Exposure() you can query the exposure time ranges available in your camera, and set new exposure times:

Setting the exposure time

Exposure time with fine increments

Setting the long exposure

Setting the dual exposure

hint_info

Note on dependencies on other settings

The use of the following functions will affect the exposure time:

is_PixelClock()

is_SetOptimalCameraTiming()

is_SetFrameRate()

is_AOI() (if the image size is changed)

is_SetSubSampling()

is_SetBinning()

Changes made to the image size, the frame rate or the pixel clock frequency also affect the exposure time. For this reason, you need to call is_Exposure() again after such changes.

hint_info

Note on new driver versions

Newer driver versions sometimes allow an extended value range for the exposure time setting. We recommend querying the value range every time and set the exposure time explicitly.

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.

Contents of the EXPOSURE_CAPS structure

INT

IS_EXPOSURE_CAP_EXPOSURE

The exposure time setting is supported

INT

IS_EXPOSURE_CAP_FINE_INCREMENT

Fine exposure time increments are supported

INT

IS_EXPOSURE_CAP_LONG_EXPOSURE

Long time exposure is supported. Depending on the camera model long time exposure is only supported in trigger mode but not in freerun mode.

INT

IS_EXPOSURE_CAP_DUAL_EXPOSURE

UI-336x/UI-536x and UI-337x/UI-537x only: The sensor supports dual exposure. Odd and even lines can be exposed with different exposure times.

Return values

IS_CANT_OPEN_DEVICE

An attempt to initialize or select the camera failed (no camera connected or initialization error).

IS_CANT_COMMUNICATE_WITH_DRIVER

Communication with the driver failed because no driver has been loaded.

IS_INVALID_CAMERA_TYPE

The camera type defined in the .ini file does not match the current camera model.

IS_INVALID_CAMERA_HANDLE

Invalid camera handle

IS_INVALID_MODE

Camera is in standby mode, function not allowed

UI-146x/UI-546x models: Function not allowed because the camera is in freerun synchronization mode.

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_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_SUCCESS

Function executed successfully

IS_TIMED_OUT

A timeout occurred. An image capturing process could not be terminated within the allowable period.

Related functions

is_SetFrameRate()

is_PixelClock()

is_SetOptimalCameraTiming()

is_SetAutoParameter()

is_AutoParameter()

is_SetHardwareGain()

Example

UINT nCaps = 0;
INT nRet = is_Exposure(m_hCam, IS_EXPOSURE_CMD_GET_CAPS, (void*)&nCaps, sizeof(nCaps));
 
if (nRet == IS_SUCCESS)
{
  if (nCaps & IS_EXPOSURE_CAP_FINE_INCREMENT)
  {
      // Fine increment supported
  }
}

© 2022 IDS Imaging Development Systems GmbH