xiQ - Technical Manual Version 1.0
88
5.6.4.
xiAPI Parameters Description
For a complete list of available parameter, please visit the xiAPI online manual at
http://www.ximea.com/support/wiki/apis/XiAPI_Manual
Note: Since xiAPI is a unified programming interface for all of XIMEA‘s cameras, not all of the described parameters apply for
every camera and sensor model.
All functions in xiAPI return status values in form of the
XI_RET
structure which is defined in
xiApi.h.
If a parameter is not
supported by a certain camera, the rerun value will represent a respective error code (e.g.
106 -
Parameter not supported).
5.6.5.
xiAPI Examples
5.6.5.1.
Connect Device
This example shows the enumeration of available devices. If any device was found the first device (with index 0) is opened.
HANDLE xiH = NULL;
XI_RETURN stat = XI_OK;
// Get number of camera devices
DWORD dwNumberOfDevices = 0;
stat = xiGetNumberDevices(&dwNumberOfDevices);
if
(!dwNumberOfDevices)
{
printf(
"No camera found\n"
);
goto
finish;
}
// Retrieving a handle to the camera device
stat = xiOpenDevice(0, &xiH);
…
finish:
// Close device
if
(xiH)
xiCloseDevice(xiH);
5.6.5.2.
Parameterize Device
This example shows how an exposure time is set. Next, the maximum possible downsampling rate is retrieved and the result is
set as new downsampling rate.
// Setting "exposure" parameter (10ms)
int
time_us = 10000;
xiSetParam(xiH, XI_PRM_EXPOSURE, &time_us,
sizeof
(time_us),
xiTypeInteger);
// Getting maxium possible doensampling rate
int
dspl_max;
xiGetParamInt(xiH, XI_PRM_DOWNSAMPLING XI_PRM_INFO_MAX, &dspl_max);
// Setting maxium possible doensampling rate
xiSetParamInt(xiH, XI_PRM_DOWNSAMPLING, dspl_max);
