is_Zoom

uEye Camera Manual Version 4.92


is_Zoom

Windows_Logo
Linux_Logo

USB 3 uEye XC

USB 3 uEye XC

Syntax

INT is_Zoom (HIDS hCam, UINT nCommand, void *pParam, UINT nSizeOfParam)

Description

is_Zoom() controls the zoom function of the lens or sensor (digital zoom) if supported by your camera.

hint_info

This function is currently supported by the following camera models:

•UI-3013XC

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 nSizeOfParam 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 ZOOM_CAPABILITY_FLAGS

ZOOM_CAP_INVALID

The camera does not support the zoom function

ZOOM_CAP_DIGITAL_ZOOM

The camera supports digital zoom

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

Invalid array

IS_SUCCESS

Function executed successfully

Example 1

double dZoomValue = 0;
nRet = is_Zoom(hCam, ZOOM_CMD_DIGITAL_GET_VALUE_DEFAULT, (void*)&dZoomValue, sizeof(dZoomValue));
if (nRet == IS_SUCCESS)
{
nRet = is_Zoom(hCam, ZOOM_CMD_DIGITAL_SET_VALUE, (void*)&dZoomValue, sizeof(dZoomValue));
UpdateZoomControls();
}

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!
For technical questions please contact your local distributor or use the support form on our website.


© 2019 IDS Imaging Development Systems GmbH
https://en.ids-imaging.com