Please enable JavaScript to view this site.

IDS Software Suite - obsolete functions 4.97

Windows_Logo
Linux_Logo

USB 2.0

GigE

USB 2.0

GigE

Syntax

INT is_SetPixelClock (HIDS hCam, INT Clock)

Description

hint_info

This function is obsolete and should not be used anymore. We recommend to use the is_PixelClock() function instead.

is_SetPixelClock() sets the frequency used to read out image data from the sensor (pixel clock frequency). Due to an excessive pixel clock for USB cameras, images may get lost during the transfer. If you change the pixel clock on-the-fly, the current image capturing process will be aborted.

hint_info

Some sensors allow a higher pixel clock setting if binning or subsampling has been activated. If you set a higher pixel clock and then reduce the binning/subsampling factors again, the driver will automatically select the highest possible pixel clock for the new settings.

hint_info

Changes to the image geometry or pixel clock affect the value ranges of the frame rate and exposure time. After executing is_SetPixelClock(), calling the following functions is recommended in order to keep the defined camera settings:

is_SetFrameRate()

is_Exposure()

If you are using the uEye's flash function: is_IO()

Input parameters

hCam

Camera handle

Clock

Pixel clock frequency to be set (in MHz)

IS_GET_PIXEL_CLOCK

Returns the current pixel clock

IS_GET_DEFAULT_PIXEL_CLK

Returns the default pixel clock

IS_GET_PIXEL_CLOCK_INC

Returns the pixel clock increment

Return values

When used with
IS_GET_PIXEL_CLOCK

Current setting

When used with
IS_GET_DEFAULT_PIXEL_CLK

Default setting

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

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_NULL_POINTER

Invalid array

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_SetOptimalCameraTiming()

is_SetFrameRate()

is_Exposure()

is_SetAutoParameter()

is_SetBinning()

is_SetSubSampling()

is_AOI()