Hand Held Products 4X00 - Manual (Page 15)

IMAGETEAM™ 4X00 Series Software Development Kit (SDK) User’s Guide 2 - 1
2
API Function Descriptions
The following is an alphabetic listing of each API function with its complete description and a prototype for each function. All API
functions return a result code of type Result_t. See
Function Result Values on page 3-2 for a table of result code values.
oemAcquireImage
This function tells the Imager to acquire an image, but does not return the image.
Result_t oemAcquireImage (
const ImagerSetup_t *pImagerSetup
)
Return Values
RESULT_SUCCESS
RESULT_ERR_UNSUPPORTED
RESULT_ERR_NOIMAGE
RESULT_ERR_PARAMETER
Parameters
pImagerSetup
Pointer to a data structure that sets up the Imager.
typedef struct
{
int NumUpdates;
int Exposure;
int Gain;
int TargetWhite;
int TargetWhiteWindow;
int Reserved;
} ImagerSetup _t;
NumUpdates: The Imager takes multiple images attempting to reach a target white value in the image, while
adjusting its gain and exposure settings. This limits the number of attempts.
Exposure : Maximum allowable exposure setting for the Imager. The greater the exposure, the more light,
and hence the brighter the image. However, it also increases motion sensitivity.
Gain: Maximum allowable gain for the Imager. Higher gain will yield a brighter image, at the expense of
added noise. This will not affect motion sensitivity.
TargetWhite: The Imager takes multiple images attempting to reach this target white value in the image, plus
or minus the TargetWhiteWindow value.
TargetWhiteWindow: The acceptable target white value falls within the range TargetWhite +/-
TargetWhiteWindow.
Reserved: Must be set to -1.
oemAimerOn
This function turns the engine's aiming mechanism on or off.
Result_t oemAimerOn (
BOOL bEnable
)
Return Values
RESULT_SUCCESS
RESULT_ERR_DRIVER
RESULT_ERR_NORESPONSE