Essentials API - v1.1 - EN

Essential API – BioSlap
BioSlap Ten-Print Scanner

Essentials API
Version 1.1
This document contains commercial information and trade secrets, which are confidential and the proprietary in nature and are subject to
protection under China and/or international law. Access to the information contained herein, howsoever acquired and of whatsoever nature,
will not entitle the accessor thereof to acquire any right thereto. The data subject to this restriction are contained in all sheets in this
document.
This BioSlap fingerprint scanner contains commercial or trade secrets of Shenzhen Bio Technologies Co.,Ltd. Disclosure of any such information
or trade secrets shall not be made without the prior written permission of Shenzhen Bio Technologies Co.,Ltd.
No part of this document may be reproduced, stored in a retrieval system, or transmitted, in any form or by any means, electronic, mechanical,
photocopying, recording, or otherwise, without the prior written permission of Shenzhen Bio Technologies Co.,Ltd.
The information in this document is subject to change without notice. The software mentioned in this document is furnished under license and
may only be used or copied in accordance with the terms of such license. Contact vendors directly for terms of software licenses for any
software mentioned in this document if applied, not originating from Shenzhen Bio Technologies Co.,Ltd.
All brand or product names are the trademarks or registered trademarks of their respective holders.
1 Application Requirements for the PC and System ................................................................................................................ 1

1.1 CPU ................................................................................................................................................................................... 1
1.2 PC Main Memory .............................................................................................................................................................. 1
1.3 Installation of Interface ..................................................................................................................................................... 1
1.4 PC Graphics Adapter ......................................................................................................................................................... 1
1.5 PC Operating System ......................................................................................................................................................... 1
2 SDK Usage .............................................................................................................................................................................. 2
2.1 Overview ........................................................................................................................................................................... 2
2.2 SDK Implementation ......................................................................................................................................................... 2
2.3 Generic Notes ................................................................................................................................................................... 2
2.4 Typical Workflow to Acquire Images ................................................................................................................................ 2
3 Integrating with a Scanner .................................................................................................................................................... 3
3.1 Getting Started.................................................................................................................................................................. 3
3.2 Acquiring Image info ......................................................................................................................................................... 4
3.3 Closing a Device ................................................................................................................................................................ 4
3.4 Accessing Maintenance Data ............................................................................................................................................ 5
4 Function Reference ................................................................................................................................................................ 6
4.1 M_Main_Initialize ............................................................................................................................................................. 7
Parameters ........................................................................................................................................................................ 7
Return Value ..................................................................................................................................................................... 7
4.2 M_Main_DeInitialize ......................................................................................................................................................... 7
Parameters ........................................................................................................................................................................ 7
Return Value ..................................................................................................................................................................... 7
4.3 M_Capture_SetMode ....................................................................................................................................................... 7
Parameters ........................................................................................................................................................................ 8
Return Value ..................................................................................................................................................................... 8
4.4 M_Capture_Start .............................................................................................................................................................. 8
Parameters ........................................................................................................................................................................ 8
Return Value ..................................................................................................................................................................... 8
4.5 M_Capture_TakeResultImage ........................................................................................................................................... 8
Parameters ........................................................................................................................................................................ 8
Return Value ..................................................................................................................................................................... 8
4.6 M_Capture_AcquireResultImage ...................................................................................................................................... 9
Parameters ........................................................................................................................................................................ 9
Return Value ..................................................................................................................................................................... 9
4.7 M_Contorls_Beeper .......................................................................................................................................................... 9
Parameters ........................................................................................................................................................................ 9
Return Value ..................................................................................................................................................................... 9
i
4.8 M_Capture_SetRollParameters ........................................................................................................................................ 9

Parameters ........................................................................................................................................................................ 9
Return Value ..................................................................................................................................................................... 9
4.9 M_Capture_Calibration................................................................................................................................................... 10
Parameters ...................................................................................................................................................................... 10
Return Value ................................................................................................................................................................... 10
4.10 M_Control_RemoveFog .................................................................................................................................................. 10
Parameters 10
Return Value 10
4.11 M_Capture_FPSegment .................................................................................................................................................. 10
Parameters 11
Return Value ..................................................................................................................................................................... 11
4.12 M_Main_GetDeviceInfo .................................................................................................................................................. 11
Parameters ...................................................................................................................................................................... 11
Return Value 11
4.13 M_Capture_Raw2Wsq .................................................................................................................................................... 11
Parameters 12
Return Value 12
4.14 M_Capture_GetTemplate ............................................................................................................................................... 12
Parameters 12
Return Value 13
4.15 M_Capture_RegisterCallbackPreviewImage ................................................................................................................... 13
Parameters 13
Return Value 13
4.16 M_Capture_RegisterCallbackTakingResultImage ........................................................................................................... 13
Parameters 13
Return Value 13
4.17 M_Capture_RegisterCallbackResultImage ...................................................................................................................... 14
Parameters 14
Return Value 14
4.18 M_Capture_IsTrueFinger ................................................................................................................................................ 14
Parameters 14
Return Value 14
5 Callback Function Reference ............................................................................................................................................... 14
5.1 CallbackPreviewImage .................................................................................................................................................... 15
Parameters ...................................................................................................................................................................... 15
5.2 CallbackTakingResultImage ............................................................................................................................................. 15
Parameters ...................................................................................................................................................................... 15
ii
5.3 CallbackResultImage ....................................................................................................................................................... 15

Parameters ...................................................................................................................................................................... 15
6 Structs Reference................................................................................................................................................................. 16
6.1 ImageData ........................................................................................................................................................................ 16
Member Data ................................................................................................................................................................... 16
6.2 DTFPropertyInfo .............................................................................................................................................................. 16
Member Data .................................................................................................................................................................. 17
6.3 DTFRunningInfo .............................................................................................................................................................. 18
Member Data .................................................................................................................................................................. 18
6.4 ImageResolution ............................................................................................................................................................. 18
Member data documentation ......................................................................................................................................... 18
6.5 DTFImageType ................................................................................................................................................................ 18
6.6 SegFPData ....................................................................................................................................................................... 20
6.7 DFRollParameters ........................................................................................................................................................... 20
iii
1 Application Requirements for the PC and System
1.1 PC CPU
• Intel Core i3, 2.0GHZ or better
1.2 PC Main Memory

• 2 GB RAM or better
1.3 Installation of Interface

• USB 2.0 or over
1.4 PC Graphics Adapter

• Fast XGA graphics (1280 x 1024 x 24bit colors) with Direct Draw support and 1 GB memory,
on AGP (2x) bus
1.5 PC Operating System

• Microsoft Windows 7 32bit/64bit
• Microsoft Windows 10 64bit
1
2 SDK Usage
2.1 Overview
This Essentials API provides access to the BioSlap ten print scanner. It is designed to be usable in a multi- threaded
environment. The interface is provided as a DLL that exports C functions.
2.2 SDK Implementation

In order to use the Essentials API, please include the following header files to your project:
• DTFEssentialsAPIM.h DTFEssentialsAPI.h – interface function, type definitions, constants, enumerations, and SDK
related return codes.
If you plan to load the DLL statically, then the following files needs to be specified for linkage:
• BioIDFScanner.lib
At runtime, the following files need to be accessible:
• BioIDFScanner.dll – the main runtime library.
• BioIDFinger.dll, DTF.dll, etc… – mosaic arithmetic runtime library.
2.3 Generic Notes

If the function returns a status which is not 0, then return parameter values might be invalid.
2.4 Typical Workflow to Acquire Images

1. Call M_Main_Initialize() to initialize device for image acquisition.
2. Call M_Capture_RegisterCallbackPreviewImage()
Call M_Capture_RegisterCallbackTakingResultImage()
Call M_Capture_RegisterCallbackResultImage()
Call appropriate callback registration functions to retrieve required notifications
3. Call M_Capture_SetModel() to select correct acquisition type(Auto or manually).
4. Call M_Capture_Start() to start running
5. Call M_Capture_AcquireResultImage() to scanner document.
6. Result images and info that are passed as ImageData to callback
CallbackResultImage() can be obtained.
7. Call M_Capture_Abort() to Abort running image acquisition.
8. Call M_Main_DeInitialize() when finished using the device.
2
3 Integrating with a Scanner
Applications utilize a BioSlap scanner by using the API in the following manner:
• Initialize a BioSlap scanner
• Call API functions of the BioSlap scanner to acquire images
• Close the BioSlap scanner
3.1 Getting Started

The Essentials API was designed to allow only one device to exist on the same computer. Before an application can use a
BioSlap device, it must:
1. Call M_Main_Initialize() to initialize the device
Call M_Capture_RegisterCallbackResultImage to initialize the callback functions.
2. Call M_Capture_SetAMode() to set capture mode
3. Call M_Capture _Start() to start running device
4. Call appropriate callback registration functions to retrieve the required notifications.
The following code is an example of initializing the device driver.
int nRc;
m_iCurIndex = 0;
SetInfo("Initialization device！",0);
nRc = M_Main_Initialize(m_iCurIndex,&m_DeviceHandle[m_iCurIndex]);
if (nRc != STATUS_OK) return;
m_iCurHandle = m_DeviceHandle[m_iCurIndex];
M_Capture_RegisterCallbackPreviewImage(
m_iCurHandle,
OnPreviewImageAvailable,
this
);
M_Capture_RegisterCallbackTakingResultImage(
m_iCurHandle,
OnTakingResultImage,
this
);
M_Capture_RegisterCallbackResultImage(
3
m_iCurHandle,
OnResultImageAvailable,
this
);
3.2 Acquiring Image into

The BioSlap scanner communicates to the application using callback functions during the acquisition
Starting an Acquisition
Please call M_Capture_SetMode to set capture image mode and call M_Capture_Start to Getting the
final Image and Data.
The images and data received with the CallbackResultImage function reflects the final document images and data as it is
captured.
Important: The BioSlap scanner owns the image’s memory buffer. Do not keep pointers to this
buffer because address of the buffer may change next image acquisitions.
3.3 Closing a Device

An application can close a BioSlap scanner, frees all the resources that were allocated by it. The BioSlap scanner handle is no
longer valid when the BioSlap scanner references has been closed. In order to use the same BioSlap scanner again, the
application must reopen the device. An application closes a BioSlap scanner by calling the M_Main_DeInitialize function.
NOTE: If an application closes without closing any open BioSlap scanner then the device driver interface
will automatically close all the running BioSlap scanner. This happens before the DLL is unloaded.
This behavior holds true if the application loaded and unloaded the BioSlap scanner DLL
dynamically.
The following code shows an example of closing a BioSlap scanner:
• // NOTE: Error handling is kept simple for brevity

M_Main_DeInitialize();
if (…) delete[] …;
4
3.4 Accessing Maintenance Data

The BioSlap scanner records maintenance data to the device’s data store. Applications have access to this data and can read
the data from the device at any time. To read the data, call the function M_Main_GetDeviceInfo. The following code shows an
example:
int nRet = 0;
DTFPropertyInfo info;
…
nRet = M_Main_GetDeviceInfo(ihandle,&info);
5
4 Function Reference
• M_Main_Initialize
• M_Main_DeInitialize
• M_Capture_SetMode
• M_Capture_Start
• M_Capture_TakeResultImage
• M_Capture_AcquireResultImage
• M_Controls_Beeper
• M_Capture_SetRollParameters
• M_Capture_Caliebration
• M_Control_RemoveFog
• M_Capture_FPSegment
• M_Main_GetDeviceInfo
• M_Capture_Raw2Wsq
• M_Capture_GetTemplate
• M_Capture_RegisterCallbackPreviewImage
• M_Capture_RegisterCallbackResultTakingImage
• M_Capture_RegisterCallbackReusultImage
• M_Capture_IsTrueFinger
6
4.1 M_Main_Initialize
Initialize the device.
BOOL WIN_API M_Main_Initialize(const int deviceIndex, int *handle);
Parameters
• deviceIndex [in] Zero-based device index for device to init
• handle [out] Function returns device handle to be used for subsequent function calls
Return Value
If the function succeeds, the return value is 0, else return<0.
4.2 M_Main_DeInitialize
DeInitialize the device.
int WIN_API M_Main_DeInitialize(const int handle);

Parameters
• Handle [in] Device handle obtained by M_Main_Initialize()
Return Value
If the function succeeds, the return value is 0, else return <0.
4.3 M_Capture_SetMode
Set capture mode
int WINAPI M_Capture_SetMode(

const int handle,
const DTFImageType imageType,
const DTFImageResolution imageResolution,
BOOL AutoCapture,
BOOL AutoContrast,
int *resultWidth,
int *resultHeight,
int *baseResolutionX,
int *baseResolutionY
);
7
Parameters
⚫ handle [in] Device handle obtained by M_Main_Initialize()
⚫ imageType [in] Image type to capture
⚫ imageResolution[in] Requested capture resolution
⚫ AutoCapture[in] Flag to auto capture
⚫ AutoContrast[in] Flag to auto contrast
⚫ resultWidth[out] Returns width of captured result image in pixels
⚫ resultHeight[out] Returns height of captured result image in pixels
⚫ baseResolutionX[out] Returns image horizontal base resolution before processing
⚫ baseResolutionY[out] Returns image vertical base resolution before processing
Return Value
If the function succeeds, the return value is 0, else return <0..
4.4 M_Capture_Start
Start image acquisition
int WINAPI M_Capture_Start(const int handle, const int numberOfObjects,

BOOL AutoAcquireResultImage=TRUE);
Parameters
⚫ numberofobject[in] Number of expected fingertips in the image
⚫ AutoAcquireResultImage[in] Auto acquire result image flag
Return Value
If the function succeeds, the return value is 0, else return <0.
4.5 M_Capture_TakeResultImage
Initiate manual result image acquisition, This function needs to be called prior to M_Capture_AcquireResultImage().
int WINAPI M_Capture_TakeResultImage(const int handle);

Parameters

Return Value
If the function succeeds, the return value is 0, else <0.
8
4.6 M_Capture_AcquireResultImage
Acquire the result image, it might take several seconds, expect a delay
int WINAPI M_Capture_AcquireResultImage(const int handle);

Parameters
Return Value
4.7 M_Contorls_Beeper
Send beep pattern to internal device beeper.
int WINAPI M_Controls_Beeper(const int handle, int BeepMode);

Parameters
⚫ BeepMode [in] Beeper mode
Return Value
4.8 M_Capture_SetRollParameters
Set roll parameters
int WINAPI M_Capture_SetRollParameters(const int handle, DFRollParameters

para);
Parameters
⚫ para [in] Roll construct parameters
Return Value
9
4.9 M_Capture_Calibration
Calibrate scanner
int WINAPI M_Capture_Calibration(const int handle);
Parameters
Return Value
4.10 M_Control_RemoveFog
Setting a flag of remove fog from image
int WINAPI M_Control_RemoveFog(const int handle,BOOL bFlag);

Parameters
⚫ bFlag [in] Flag of remove fog(turn on/off)
Return Value
4.11 M_Capture_FPSegment
Segment flat image
int WINAPI M_Capture_FPSegment(

const int handle,
BYTE* pRawImg,
int iWidth,
int iHeight,
SegFPData* pSegFPData,
int* NumSegFinger,
char* pszErrMsg
);
10
Parameters
⚫ imageType [in] flat type
⚫ pRawImg [in] flat image
⚫ iWidth [in] image width
⚫ iHeight [in] image height
⚫ pSegFPData[out] segment single finger image data of the flat image
⚫ NumSegFinger[out] Number of finger
⚫ pszErrMsg [out] error message
Return Value
4.12 M_Main_GetDeviceInfo
Retrieve detailed device information
int WINAPI M_Main_GetDeviceInfo(const int handle, DTFPropertyInfo *info);

Parameters

⚫ info [out] Basic device information; memory provided by caller
Return Value
4.13 M_Capture_Raw2Wsq
Save the image as WSQ format.
int WINAPI M_Capture_Raw2Wsq(

const int handle,
int nHeight,
int nWidth,
int nBitsCount,
UCHAR* pucRawBuf,
Int* pnWSQBufLen,
UCHAR** ppucWSQBuf,
Float fRatio
);
11
Parameters
⚫ nHeight [in] Image height
⚫ nWidth [in] Image width
⚫ nBitsCount [in] Image bits
⚫ pucRawBuf [in] Image raw data
⚫ pnWSQBufLen [out] Image size of WSQ
⚫ ppucWSQBuf [out] Image data of WSQ
⚫ fRatio [in] Compression ratio, default is 10
Return Value
4.14 M_Capture_GetTemplate
Extract fingerprint feature data.
int WINAPI M_Capture_Raw2Wsq(
const int handle,
unsigned char* Image,
int ImgWidth,
int ImgHeight,
int FingerPosition,
Int TemplateType,
Unsigned char** Template,
Int* TemplateSize
);
Parameters
⚫ Image [in] Image buffer data
⚫ ImgWidth [in] Image width
⚫ ImgHeight [in] Image height
⚫ FingerPosition [in] Finger index, from right to left 0-9
⚫ TemplateType [in] Template type. 0x01
⚫ Template [out] Feature data
⚫ TemplateSize [out] Data size
12
Return Value
4.15 M_Capture_RegisterCallbackPreviewImage
Callback preview image availability
int WINAPI M_Capture_RegisterCallbackPreviewImage(

const int handle,
CallbackPreviewImage callback,
void *context
);
Parameters
⚫ callback [in] Pointer to the notification function
⚫ context [in] Pointer to user context; this value is used as parameter for callback
Return Value
4.16 M_Capture_RegisterCallbackTakingResultImage
Callback for start of result image capture
int WINAPI M_Capture_RegisterCallbackTakingResultImage(

const int handle,
CallbackTakingResultImage callback,
void *context
);
Parameters
Return Value
13
4.17 M_Capture_RegisterCallbackResultImage
Callback for completion of result image acquisition
int WINAPI M_Capture_RegisterCallbackResultImage(

const int handle,
CallbackResultImage callback,
void *context
);
Parameters
Return Value
4.18 M_Capture_IsTrueFinger
To check if a live finger presented or fake finger detection
int WINAPI M_Capture_IsTrueFinger(
const int handle,
unsigned char* Image,
int ImgWidth,
int ImgHeight,
);
Parameters
⚫ Image [in] Image buffer data
⚫ ImgWidth [in] Image width
⚫ ImgHeight [in] Image height
Return Value
5 Callback Function Reference
This section describes function prototypes for callback registration.
• CallbackPreviewImage
14
• CallbackTakingResultImage
• CallbackResultIImage
5.1 CallbackPreviewImage
Preview image available notification.
typedef void ( CALLBACK *CallbackPreviewImage ) (

void* pContext,
const ImageData image
);
Parameters
• pContext [in] caller defined context (e.g. handler object instance pointer)
• image [in/out] preview image (valid until callback function is exited)
5.2 CallbackTakingResultImage
This notification is sent to indicate begin of result image acquisition.
typedef void ( CALLBACK *CallbackTakingResultImage ) (
void* pContext
);
Parameters
5.3 CallbackResultImage
Result image acquisition completion notification.(only valid if imageStatus >= STATUS_OK)
typedef void ( CALLBACK *CallbackResultImage ) (

void* pContext,
const int imageStatus,
const ImageData image,
const int detectedObjects
);
Parameters
• imageStatus [in] result image status value (value >= STATUS_OK indicates success)
• image [in] preview image (valid until callback function is exited)
• imageType [in] result image type (e.g. LSCAN_ROLL_SINGLE_FINGER)
15
• detectedObject [in] number of detected objects/fingers in result image
6 Structs Reference
• ImageData
• DTFPropertyInfo
• DTFRunningInfo
• DTFImageResolution
• DTFImageType
• SegFPData
• DFRollParameters
6.1 ImageData
Container to hold image data together with meta information
Member Data
• void* Buffer
• DWORD Width
• DWORD Height
• double ResolutionX
• double ResolutionY
• double FrameTime
• int Pitch
• BYTE BitsPerPixel
• ImageFormat Forma
• BOOL IsFinal
6.2 DTFPropertyInfo
Device information
16
Member Data
• int nResolution
• char szMaker[MAX_STR_LEN]
• char szModel[MAX_STR_LEN]
• char szInterfaceType[MAX_STR_LEN]
• char szSerial[MAX_STR_LEN]
• char szVer[MAX_STR_LEN]
• char szManDate[MAX_STR_LEN]
• char szServDate[MAX_STR_LEN]
17
6.3 DTFRunningInfo
Device running information
Member Data
• BOOL bIsInitialized
• BOOL bIsCaptueing;
• BOOL bIsCaptureAbort;
• BOOL bAutoCapture;
• BOOL bAutoContrast;
• BOOL bStartPreview;
• BOOL bIsCaptureOK;
• BOOL bIsStartRolling;
• int nErrorCode;
6.4 ImageResolution
Image resolution types
Member data documentation
• IMAGE_RESOLUTION_500 = 500
• IMAGE_RESOLUTION_1000 = 1000
6.5 DTFImageType
Image types
• ROLL_SINGLE_FINGER, ///< Rolled finger print image
• FLAT_SINGLE_FINGER, ///< Flat single finger
• FLAT_RIGHT_FINGERS, ///< Right flat fingers
• FLAT_LEFT_FINGERS, ///< Left flat fingers
• FLAT_TWO_THUMBS, ///< Two flat thumbs
• ROLL_RIGHT_THUMB, ///< Right thumb Rolled finger print image
• ROLL_LEFT_THUMB, ///< Left thumb Rolled finger print image
18
• PALM_RIGHT_FULL, ///< Full right palm
• PALM_RIGHT_WRITERS, ///< Right writers palm
• PALM_RIGHT_LOWER, ///< Right lower palm
• PALM_RIGHT_UPPER, ///< Right upper palm
• PALM_LEFT_FULL, ///< Full left palm
• PALM_LEFT_WRITERS, ///< Left writers palm
• PALM_LEFT_LOWER, ///< Left lower palm
• PALM_LEFT_UPPER, ///< Left upper palm
• ROLL_RIGHT_INDEX, ///< Right index Rolled finger print image
• ROLL_RIGHT_MIDDLE, ///< Right middle Rolled finger print image
• ROLL_RIGHT_RING, ///< Right ring Rolled finger print image
• ROLL_RIGHT_SMALL, ///< Right small Rolled finger print image
• ROLL_LEFT_INDEX, ///< Left index Rolled finger print image
• ROLL_LEFT_MIDDLE, ///< Left middle Rolled finger print image
• ROLL_LEFT_RING, ///< Left ring Rolled finger print image
• ROLL_LEFT_SMALL, ///< Left small Rolled finger print image
• FLAT_RIGHT_THUMB, ///< Right flat thumb
• FLAT_RIGHT_INDEX, ///< Right flat index
• FLAT_RIGHT_MIDDLE, ///< Right flat middle
• FLAT_RIGHT_RING, ///< Right flat ring
• FLAT_RIGHT_SMALL, ///< Right flat small
• FLAT_LEFT_THUMB, ///< Left flat thumb
• FLAT_LEFT_INDEX, ///< Left flat index
• FLAT_LEFT_MIDDLE, ///< Left flat middle
• FLAT_LEFT_RING, ///< Left flat ring
• FLAT_LEFT_SMALL, ///< Left flat small
19
• FLAT_TWO_THUMBS_R_IndexMiddle,
• FLAT_TWO_THUMBS_R_RingSmall,
• FLAT_TWO_THUMBS_L_IndexMiddle,
• FLAT_TWO_THUMBS_L_RingSmall,
• FLAT_ALL_FINGERS,
• TYPE_NONE, ///< No image (default after initialization)
6.6 SegFPData
Single fingerprint data
• int nFGP
• int nWidth
• int nHeight
• int nQuality
• int nRawImgLe
• unsigned char *pucRawImg;
6.7 DFRollParameters
Roll construct parameter
• int MaxFrameNumber
• int SlideDetectionStatus
• float SlidingPercentageThreshold
• int SlidingSADMeanThreshlod
• int RollBackThreshold
• int CheckSensorThreshold
20

Essentials API - v1.1 - EN

Uploaded by

Copyright:

Available Formats

You might also like

Essentials API - v1.1 - EN

Uploaded by

Document Information

Original Description:

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Essentials API - v1.1 - EN

Uploaded by

Copyright:

Available Formats

Essential API – BioSlap

BioSlap Ten-Print Scanner

1 Application Requirements for the PC and System ................................................................................................................ 1

4.8 M_Capture_SetRollParameters ........................................................................................................................................ 9

5.3 CallbackResultImage ....................................................................................................................................................... 15

1 Application Requirements for the PC and System

1.2 PC Main Memory

1.3 Installation of Interface

1.4 PC Graphics Adapter

1.5 PC Operating System

2.2 SDK Implementation

2.3 Generic Notes

2.4 Typical Workflow to Acquire Images

Call appropriate callback registration functions to retrieve required notifications

3. Call M_Capture_SetModel() to select correct acquisition type(Auto or manually).

4. Call M_Capture_Start() to start running

5. Call M_Capture_AcquireResultImage() to scanner document.

6. Result images and info that are passed as ImageData to callback

CallbackResultImage() can be obtained.

7. Call M_Capture_Abort() to Abort running image acquisition.

8. Call M_Main_DeInitialize() when finished using the device.

3 Integrating with a Scanner

• Initialize a BioSlap scanner

• Call API functions of the BioSlap scanner to acquire images

• Close the BioSlap scanner

3.1 Getting Started

1. Call M_Main_Initialize() to initialize the device

Call M_Capture_RegisterCallbackResultImage to initialize the callback functions.

2. Call M_Capture_SetAMode() to set capture mode

3. Call M_Capture _Start() to start running device

4. Call appropriate callback registration functions to retrieve the required notifications.

The following code is an example of initializing the device driver.

3.2 Acquiring Image into

final Image and Data.

3.3 Closing a Device

The following code shows an example of closing a BioSlap scanner:

• // NOTE: Error handling is kept simple for brevity

3.4 Accessing Maintenance Data

BOOL WIN_API M_Main_Initialize(const int deviceIndex, int *handle);

• deviceIndex [in] Zero-based device index for device to init

If the function succeeds, the return value is 0, else return<0.

int WIN_API M_Main_DeInitialize(const int handle);

• Handle [in] Device handle obtained by M_Main_Initialize()

If the function succeeds, the return value is 0, else return <0.

int WINAPI M_Capture_SetMode(

⚫ handle [in] Device handle obtained by M_Main_Initialize()

⚫ imageType [in] Image type to capture

⚫ imageResolution[in] Requested capture resolution

⚫ AutoCapture[in] Flag to auto capture

⚫ AutoContrast[in] Flag to auto contrast

⚫ resultWidth[out] Returns width of captured result image in pixels

⚫ resultHeight[out] Returns height of captured result image in pixels

⚫ baseResolutionX[out] Returns image horizontal base resolution before processing

⚫ baseResolutionY[out] Returns image vertical base resolution before processing

If the function succeeds, the return value is 0, else return <0..

int WINAPI M_Capture_Start(const int handle, const int numberOfObjects,

⚫ handle [in] Device handle obtained by M_Main_Initialize()