Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Thunder SDK initiation and authorization
Initiation
Parameter
Return
None
Exception
None
Authorization
Parameter
Return
None
Exception
None
Release SDK resource
Parameter
None
Return
None
Exception
None
Member Function
Description
Version Introduced
void init(Context context)
Initiation
2.0.0
void auth(String licFileName, boolean isLeafLic, String productName, PassModel modelConfig,IAuthCallback authCallback)
Authorization
2.0.0
void release()
Release SDK resource
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
context
Context
context object
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
licFileName
String
license file name
None
2.0.0
isLeafLic
boolean
Is Leaf License
None
2.0.0
productName
String
Device Product Name
None
2.0.0
modelConfig
PassModel
Model Configuration
None
2.0.0
authCallback
IAuthCallback
Authorization Callback
None
2.0.0
This document, which describes the functions of a single type, is mainly for developers. The main purpose is to let developers understand the specific purpose and functions provided by each type.
Support Human Face 1:1 Verification, Local 1:N Identification, Server 1:N Identification and Face Mask Detection.
Entrance for the Identify Manager
Set Individual Identification Feature
Parameter
Return
Exception
None
Get Image Configuration
Parameter
None
Return
ImageConfig
Exception
None
Get Identify Manager Workflow Configuration
Parameter
None
Return
IdentifyConfig
Exception
None
Get Threshold Configuration
Parameter
None
Return
ThresholdConfig
Exception
None
Add Face Filter Interceptor
Parameter
Return
None
Exception
None
Handle rgb Data
Parameter
Return
None
Exception
None
Handle irb Data
Parameter
Return
None
Exception
None
Handle Thermodynamic Diagram and Related Data
Parameter
Return
None
Exception
None
Initialize
Parameter
Return
None
Exception
None
Pause Face Identification
Parameter
None
Return
None
Exception
None
Resume Face Identification
Parameter
None
Return
None
Exception
None
Release Resource
Parameter
None
Return
None
Exception
None
Remove Face Filter Interceptor
Parameter
Return
None
Exception
None
Remove the Set Individual Identification Feature
Parameter
None
Return
None
Exception
None
Start Identification
Parameter
None
Return
None
Exception
None
Stop Identification
Parameter
None
Return
None
Exception
None
Set Identification Result Callback
Parameter
Return
None
Exception
None
Set the Verification Mode for the Identification Manager
Parameter
Return
None
Exception
None
Set Threshold Configuration
Parameter
Return
None
Exception
None
Set Identification Manager Workflow Configuration
Parameter
Return
None
Exception
None
Set Server Verification Logic
Parameter
Return
None
Exception
None
Set Temperature Measurement Sdk Action
Parameter
Return
None
Exception
None
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Method
Description of Properties
Description of Properties
Description of Method
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Method
Description of Properties
An instance of quick access to the camera is provided, an interface for previewing data is obtained, method of managing the life cycle of the camera is encapsulated, and the monitoring of the camera.
The main methods of operating the camera
Add preview data callback
Parameter
Return
Current Object
Exception
None
Remove Preview Data Callback
Parameter
Return
Current Object
Exception
None
Get camera instance
Parameter
Return
Current Object
Exception
None
Set Preview Degree, 0/90/180/270 selectable
Parameter
Return
Current Object
Exception
None
Set Preview Texture
Parameter
Return
Current Object
Exception
None
Get the List of Supported Preview Sizes
Parameter
None
Return
Exception
None
Camera Initialization
Parameter
Return
None
Exception
None
Open Camera
Parameter
Return
None
Exception
None
Release Camera
Parameter
None
Return
None
Exception
None
Start Camera Preview
Parameter
None
Return
None
Exception
None
Stop Camera Preview
Parameter
None
Return
None
Exception
None
None
The main methods to operate the camera in order to output video stream (combined RGB and IR).
Add preview data callback
Parameter
Return
None
Exception
None
Remove preview data callback
Parameter
Return
None
Exception
None
Get camera instance
Parameter
None
Return
Current object
Exception
None
Get the preview size supported by the camera
Parameter
Return
Exception
None
Camera Initialization
Parameter
Return
None
Exception
None
Open camera
Parameter
Return
None
Exception
None
Release camera
Parameter
Return
None
Exception
None
Start camera preview
Parameter
Return
None
Exception
None
Stop camera preview
Parameter
Return
None
Exception
None
reset the preview size supported by the camera
Parameter
Return
None
Exception
None
Parameter Description
Version
Revision Date
Revision Content
2.0.0
03/01/2021
First Draft
2.1.0
04/30/2021
Added an API for video stream output
Added APIs for attribute detection
Added an API for FR face calibration check
Added an API for image rotation
Updated the temperature detection model
2.1.1
06/30/2021
Revised camera function description
Updated the temperature detection model
Member Function | Description | Version Introduced |
boolean setIdentifyTarget(Bitmap avatar) | Set Individual Identification Feature | 2.0.0 |
ImageConfig getImageConfig() | get Image Configuration | 2.0.0 |
IdentifyConfig getIdentifyConfig() | Get Identify Manager Workflow Configuration | 2.0.0 |
ThresholdConfiggetThresholdConfig]() | get Threshold Configuration | 2.0.0 |
void addFaceFilterInterceptor(IFaceFilterInterceptor faceFilterInterceptor) | add Face Filter Interceptor | 2.0.0 |
void handleRgbData(byte[] data) | Handle rgb Image Data | 2.0.0 |
void handleIrData(byte[] data) | Handle ir Image Data | 2.0.0 |
void handleTemperatureData(Bitmap temperatureBitmap,float[] temperatureValue, int width, int height, FaceOrientation temperatureOrientation) | Handle Thermodynamic Diagram and Related Data | 2.0.0 |
void init(ImageConfig imageConfig, IIdentifyResultCallback identifyResultCallback) | Initialize | 2.0.0 |
void pause() | Pause Face Identification | 2.0.0 |
void resume() | Resume Face Identification | 2.0.0 |
void release() | Release Resouce | 2.0.0 |
void removeFaceFilterInterceptor(IFaceFilterInterceptor faceFilterInterceptor) | Remove Face Filter Interceptor | 2.0.0 |
void removeIdentifyTarget() | Remove the Set Individual Identification Feature | 2.0.0 |
void start() | Start Identification | 2.0.0 |
void stop() | Stop Identification | 2.0.0 |
void setIdentifyCallback(IIdentifyResultCallback iIdentifyCallback) | Set Identify Callback | 2.0.0 |
void setVerifyMode(VerifyModeEnum verifyMode) | Set the Verification Mode for the Identification Manager | 2.0.0 |
void setThresholdConfig(ThresholdConfig thresholdConfig) | Set Threshold Configuration | 2.0.0 |
void setIdentifyConfig(IdentifyConfig identifyConfig) | Set Identification Manager Workflow Configuration | 2.0.0 |
void setServerVerifyAction(IServerVerifyAction serverVerifyAction) | Set Server Verification Logic | 2.0.0 |
void setTemperatureSdkAction(ITemperatureSdkAction temperatureSdkAction) | Set Temperature Measurement Sdk Action | 2.0.0 |
Member Function | Description | Version Introduced |
boolean setIdentifyTarget(Bitmap avatar) | Set Individual Identification Feature | 2.0.0 |
ImageConfig getImageConfig() | get Image Configuration | 2.0.0 |
IdentifyConfig getIdentifyConfig() | Get Identify Manager Workflow Configuration | 2.0.0 |
ThresholdConfig getThresholdConfig() | get Threshold Configuration | 2.0.0 |
void addFaceFilterInterceptor(IFaceFilterInterceptor faceFilterInterceptor) | add Face Filter Interceptor | 2.0.0 |
void handleRgbData(byte[] data) | Handle rgb Image Data | 2.0.0 |
void handleIrData(byte[] data) | Handle ir Image Data | 2.0.0 |
void handleTemperatureData(Bitmap temperatureBitmap,float[] temperatureValue, int width, int height, FaceOrientation temperatureOrientation) | Handle Thermodynamic Diagram and Related Data | 2.0.0 |
void init(ImageConfig imageConfig, IIdentifyResultCallback identifyResultCallback) | Initialize | 2.0.0 |
void pause() | Pause Face Identification | 2.0.0 |
void resume() | Resume Face Identification | 2.0.0 |
void release() | Release Resouce | 2.0.0 |
void removeFaceFilterInterceptor(IFaceFilterInterceptor faceFilterInterceptor) | Remove Face Filter Interceptor | 2.0.0 |
void removeIdentifyTarget() | Remove the Set Individual Identification Feature | 2.0.0 |
void start() | Start Identification | 2.0.0 |
void stop() | Stop Identification | 2.0.0 |
void setIdentifyCallback(IIdentifyResultCallback iIdentifyCallback) | Set Identify Callback | 2.0.0 |
void setVerifyMode(VerifyModeEnum verifyMode) | Set the Verification Mode for the Identification Manager | 2.0.0 |
void setThresholdConfig(ThresholdConfig thresholdConfig) | Set Threshold Configuration | 2.0.0 |
void setIdentifyConfig(IdentifyConfig identifyConfig) | Set Identification Manager Workflow Configuration | 2.0.0 |
void setServerVerifyAction(IServerVerifyAction serverVerifyAction) | Set Server Verification Logic | 2.0.0 |
void setTemperatureSdkAction(ITemperatureSdkAction temperatureSdkAction) | Set Temperature Measurement Sdk Action | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
avatar | Bitmap | Individual ID Photo | None | 2.0.0 |
Returned Value | Description | Note | Version Introduced |
true | Set Success | None | 2.0.0 |
false | Set Fail | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
faceFilterInterceptor | IFaceFilterInterceptor | Face Filter Interceptor | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
data | byte[] | Image Data | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
data | byte[] | Image Data | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
temperatureBitmap | Bitmap | Thermodynamic Diagram | None | 2.0.0 |
temperatureValue | float[] | Temperature Value | None | 2.0.0 |
width | int | Thermodynamic Diagram Width | None | 2.0.0 |
height | int | Thermodynamic Diagram Height | None | 2.0.0 |
temperatureOrientation | FaceOrientation | Face Orientation | None | 2.0.0 |
Type | Parameter Name | Description | Note | Version Introduced |
ImageConfig | imageConfig | Image Configuration | None | 2.0 |
IIdentifyResultCallback | identifyResultCallback | Identification Result Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
faceFilterInterceptor | IFaceFilterInterceptor | Face Filter Interceptor | None | 2.0 |
Parameter Name | Type | Description | Note | Version Introduced |
iIdentifyCallback | IIdentifyResultCallback | Identification Result Callback | None | 2.0 |
Parameter Name | Type | Description | Note | Version Introduced |
verifyMode | VerifyModeEnum | Verification Mode | None | 2.0 |
Parameter Name | Type | Description | Note | Version Introduced |
thresholdConfig | ThresholdConfig | Threshold Configuration | None | 2.0 |
Parameter Name | Type | Description | Note | Version Introduced |
identifyConfig | IdentifyConfig | Identification Manager Workflow Configuration | None | 2.0 |
Parameter Name | Type | Description | Note | Version Introduced |
serverVerifyAction | IServerVerifyAction | Server Verification Logic | None | 2.0 |
Parameter Name | Type | Description | Note | Version Introduced |
temperatureSdkAction | ITemperatureSdkAction | Temperature Measurement Sdk Action | None | 2.0 |
Member | Type | Description | Note | Version Introduced |
int previewW | int | Camera Preview Resolution Width | None | 2.0.0 |
int previewH | int | Camera Preview Resolution Height | None | 2.0.0 |
pixelFormat | MidPixelFormat | Camera Preview Frame Data Format | None | 2.0.0 |
faceOrientation | FaceOrientation | Face Direction in Camera Preview Frame Data | None | 2.0.0 |
Member | Description | Note | Version Introduced |
GRAY8 | Y 1 | None | 2.0.0 |
YUV420P | YUV 4:2:0 | None | 2.0.0 |
NV12 | YUV 4:2:0 | None | 2.0.0 |
NV21 | YUV 4:2:0 | None | 2.0.0 |
BGRA8888 | BGRA 8:8:8:8 | None | 2.0.0 |
BGR888 | BGR 8:8:8 | None | 2.0.0 |
RGBA8888 | RGBA 8:8:8:8 | None | 2.0.0 |
RGB888 | RGB 8:8:8 | None | 2.0.0 |
GRAY16 | Special Image Format | Rotation and Conversion to Other Formats are not Provided | 2.0.0 |
RGB565 | RGB 5:6:5 | None | 2.0.0 |
ABGR8888 | ABGR 8:8:8:8 | None | 2.0.0 |
Member | Description | Note | Version introduced |
UP | Face up | None | 2.0.0 |
LEFT | Face Left | None | 2.0.0 |
DOWN | Face Down | None | 2.0.0 |
RIGHT | Face Right | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
debug | boolean | Debug ON/OFF | None | 2.0.0 |
imageConfig | ImageConfig | Identify Frame Information Configuration | None | 2.0.0 |
thresholdConfig | ThresholdConfig | Identify Threshold Configuration | None | 2.0.0 |
hasLiveness | boolean | Liveness ON/OFF | None | 2.0.0 |
isAlwaysLiveness | boolean | Will the Liveness Identification Always be Conducted for the Same trackID | None | 2.0.0 |
isSingleLiveness | boolean | Is it Single Liveness | None | 2.0.0 |
hasTemperatureDetection | boolean | Temperature Detection ON/OFF | None | 2.0.0 |
isMultiTemperatureDetection | boolean | Multi Person Temperature Detection ON/OFF | None | 2.0.0 |
hackNoPassCountThreshold | int | Number of Liveness Identifications Required to Determine Non-liveness | None | 2.0.0 |
strangerCountThreshold | int | Number of Comparisons Required to Determine a Stranger | None | 2.0.0 |
irNoFaceCountThreshold | int | Non-liveness can be Determined After Successive N Frames | None | 2.0.0 |
irAndRgbFaceMinDist | float | Threshold for the minimum distance between RGB camera and IR camera | None | 2.0.0 |
isContinueVerify | boolean | Will the Identification be Continued after the Recognition Result of the Same trackID Comes Out | None | 2.0.0 |
irAndRgbFaceSizeThreshold | float | RGB and IR Face SizeThreshold | None | 2.0.0 |
continueVerifyIntervalTime | long | The Time Interval to Continue the Recognition after the Recognition Result of the Same trackID Comes Out | None | 2.0.0 |
samePersonContinuousRecognitionInterval | long | Continuous Identification Interval of the Same userID() | This parameter is personnel targeted, and is higher than the continueVerifyIntervalTime control | 2.0.0 |
isServerVerify | boolean | is it Server Verification | None | 2.0.0 |
isMultiFaceVerify | boolean | is it Multi Face Verification Senario | None | 2.0.0 |
detectSerialMultiFace | int | An Interval of How Many Frames is Kept for Detection While Tracking | None | 2.0.0 |
isSenseGateConfig | boolean | is it SenseGate Device | SenseGateBD Baseline Distance Calculation is Different from Pass Series | 2.0.0 |
isCheckCameraRotate | boolean | is Camera Rotation Checked | None | 2.0.0 |
isDoVerify | boolean | Face Identification Yes or No | None | 2.0.0 |
isOpenWearMaskIdentify | boolean | Open Wear Mask Identification | None | 2.0.0 |
isInnerEyeTempDetect | boolean | is Inner Eye Temperature Detected | None | 2.0.0 |
unSuccessTimeoutTimeThreshold | int | The timeout period of unsuccessful recognition, that is, only successful recognition will return the result immediately, otherwise it will return the failed result after the timeout | Default-1, means this function is closed | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
verifyAreaRect | RectF | Masked rectangle Area | None | 2.0.0 |
faceMinWidth | int | Recognizable minimum face width | None | 2.0.0 |
faceMaxWidth | int | Recognizable maximum face width | None | 2.0.0 |
alignmentScore | float | Marked Face Alignment Score | None | 2.0.0 |
sharpness | float | Face Ambiguity | None | 2.0.0 |
yaw | float | yaw angle | Profile | 2.0.0 |
pitch | float | pitch angle | Look down and up | 2.0.0 |
roll | float | roll angle | Tilt head | 2.0.0 |
livenessScore | float | Recognition of liveness threshold | None | 2.0.0 |
verifyScore | float | Comparison threshold | None | 2.0.0 |
maskVerifyScore | float | Comparison threshold for wearing a mask | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
T filterFace(FaceInfo faceInfo, byte[] data, MidPixelFormat midPixelFormat, int width, int height, FaceOrientation faceOrientation) | Face Filter | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
faceRect | Rect | Face Rectangle | None | 2.0.0 |
facePoints | PointF[] | Face Points | None | 2.0.0 |
occlusion | int[] | Face Occlusion | None | 2.0.0 |
id | int | track id | None | 2.0.0 |
detectionScore | float | Detection Score | None | 2.0.0 |
alignmentScore | float | Alignment Score | None | 2.0.0 |
pointsCount | int | Face Points Count | None | 2.0.0 |
yaw | float | yaw angle | None | 2.0.0 |
pitch | float | pitch angle | None | 2.0.0 |
roll | float | roll angle | None | 2.0.0 |
Member | Description | Note | Version Introduced |
MODE_1_N | 1:N Comparison Mode | None | 2.0.0 |
MODE_1_1 | 1:1 Comparison Mode | None | 2.0.0 |
MODE_SERVER_1_N | Server identification 1:N Mode | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onTrackResult(FaceInfo[] faces, byte[] rgbCameraData, byte[] irCameraData) | Callback Track Result | None | 2.0.0 |
void onNoFaceOverTime(byte[] rgbCameraData, byte[] irCameraData) | No Face Callback Detected within the Specified Time | None | 2.0.0 |
void onClearScreen() | No Face Callback | None | 2.0.0 |
void onDrawFaces(List<FaceInfo> faceInfoList) | Callback for drawing faces in the screen | None | 2.0.0 |
void onUnknown(float faceW) | Callback Abnormal Faces | Callback when a Person Stands Far Away and the Liveness Judgment is Inaccurate |
void onCameraRotate(FaceOrientation forwardOrientation) | Callback API for camera rotation | None | 2.0.0 |
void onFaceFilterResult(List<FaceFilterResult> faceFilterResults) | Face Filter Callback | None | 2.0.0 |
void onAttributeFilterResult(List<AttributeFilterResult> attributeFilterResults) | Attribute Filter Result | None | 2.0.0 |
void onIdentifyResult(List<FrameIdentifyResult> frameIdentifyResults) | Face Identify Callback | None | 2.0.0 |
void onTrackAndTemperatureResult(List<TrackAndTemperatureResult> results) | Track and Temperature Detection Result | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
code | int | Result Code | 0-Pass, Filtered if it is not 0. If it is filtered, then the developer should customize it in the interceptor API | 2.0.0 |
interceptorId | int | Interceptor ID | None | 2.0.0 |
faceInfo | FaceInfo | Face Info | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
code | int | Result Code | 0-Pass, Filtered if it is not 0, specifically customized by each interceptor | 2.0.0 |
interceptorId | int | Interceptor ID | None | 2.0.0 |
attributeResult | AttributeResult | Attribute Result | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
rgbFace | FaceInfo | Face Info | None | 2.0.0 |
wearMask | boolean | Wear Mask | None | 2.0.0 |
wearEyeGlass | boolean | Wear eye glass or not | None | 2.1.0 |
age | int | Age | None | 2.1.0 |
isMale | boolean | Gender | None | 2.1.0 |
isHasMustache | boolean | Has mustache or not | None | 2.1.0 |
Member | Type | Description | Note | Version Introduced |
frameId | int | Frame ID | None | 2.0.0 |
rgbCameraNv21Data | byte[] | RGB frame data corresponding to the recognition result | None | 2.0.0 |
w | int | Frame Width | None | 2.0.0 |
h | int | Frame Height | None | 2.0.0 |
orientation | FaceOrientation | Face Orientation | None | 2.0.0 |
irCameraNv21Data | byte[] | IR frame data corresponding to the recognition result | None | 2.0.0 |
temperatureValue | float[] | Temperature Value | None | 2.0.0 |
temperatureBitmap | Bitmap | temperatureBitmap | None | 2.0.0 |
temperatureWidth | int | Width temperatureBitmap | None | 2.0.0 |
temperatureHeight | int | Height temperatureBitmap | None | 2.0.0 |
temperatureOrientation | FaceOrientation | temperatureBitmap Face Orientation | None | 2.0.0 |
faceIdentifyResults | List<FaceIdentifyResult> | List of Identification Result | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
faceInfo | FaceInfo | RGB Face Info | None | 2.0.0 |
irFaceInfo | FaceInfo | IR Face Info | None | 2.0.0 |
feature | byte[] | Feature | None | 2.0.0 |
verifyScore | float | Verify Score | None | 2.0.0 |
livenessScore | float | Liveness Score | None | 2.0.0 |
userId | int | User ID | None | 2.0.0 |
trackAndTemperatureResult | TrackAndTemperatureResult | Temperature Result | None | 2.0.0 |
isMask | boolean | Whether a mask is wore or not | None | 2.0.0 |
identifyResultTypeEnum | IdentifyResultTypeEnum | Identification Result | None | 2.0.0 |
faceSearchResult | FaceSearchResult | Search Result | None | 2.0.0 |
AttributeResult | AttributeResult | Face Attribute Result | None | 2.1.0 |
Member | Type | Description | Note | Version Introduced |
faceInfo | FaceInfo | RGB Face Info | None | 2.0.0 |
irFaceInfo | FaceInfo | IR Face Info | None | 2.0.0 |
temperature | float | Temperature | None | 2.0.0 |
Member | Description | Note | Version Introduced |
NON_LIVENESS | NON_LIVENESS | None | 2.0.0 |
LIVENESS | LIVENESS | None | 2.0.0 |
STRANGER | STRANGER | None | 2.0.0 |
VERIFY_SUCCESS | VERIFY_SUCCESS | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
userID | int | Index value defined when inserting into the database | None | 2.0.0 |
score | float | The score of the most similar eigenvalue | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
T verify( byte[] cameraData, byte[] feature,FaceInfo rgbFace, int width, int height) | Face Search Identification | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
List temperCalculateAir(MatchFace[] matchFaces, Bitmap temperatureBitmap, float[] temperatureData, int temperatureWidth, int temperatureHeight, FaceOrientation temperatureOrientation) | Multi-person temperature measurement algorithm | None | 2.0.0 |
Member Function | Description | Version Introduced |
CameraManager removePreviewCallbackWithBuffer(PreviewCallback callback) | remove preview data callback | 2.0.0 |
CameraManager addPreviewCallbackWithBuffer(PreviewCallback callback) | add preview data callback | 2.0.0 |
CameraManager getInstance(int cameraId) | get camera instance | 2.0.0 |
CameraManager setDisplayOrientation(int degree) | set preview degree | 2.0.0 |
CameraManager setPreviewTexture(SurfaceTexture texture) | set preview texture | 2.0.0 |
List getSupportedPreviewSizes() | get the preview size supported by the camera | 2.0.0 |
void initParameters(int width, int height, int degree, SurfaceTexture surfaceTexture) | Camera Initialization | 2.0.0 |
void openCamera(Context context) | open camera | 2.0.0 |
void releaseCamera() | release camera | 2.0.0 |
void startPreview() | start preview | 2.0.0 |
void stopPreview() | stop preview | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | PreviewCallback | Preview Data Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | PreviewCallback | Preview Data Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cameraId | int | Camera Index | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
degree | int | Degree, 0/90/180/270 selectable | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
texture | SurfaceTexture | Preview Texture | None | 2.0.0 |
Returned Value | Description | Version introduced |
List | List of Supported Preview Sizes | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
width | int | Preview Width | None | 2.0.0 |
height | int | Preview Height | None | 2.0.0 |
degree | int | Preview Degree: 0,90,180,270 | None | 2.0.0 |
surfaceTexture | SurfaceTexture | Preview Texture | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
context | Context | Context | None | 2.0.0 |
Member Function | Description | Version Introduced |
void removePreviewCallbackWithBuffer(IRgbAndIrPreviewCallback callback) | remove preview data callback | 2.1.0 |
void addPreviewCallbackWithBuffer(IRgbAndIrPreviewCallback callback) | add preview data callback | 2.1.0 |
RgbAndIrCameraManager getInstance() | get camera instance | 2.1.0 |
List getSupportedPreviewSizes(CameraType cameraType) | get the preview size supported by the camera | 2.1.0 |
void initParameters(int width, int height, int degree , SurfaceTexture irSurfaceTexture, SurfaceTexture rgbSurfaceTexture, CameraType cameraType) | Camera Initialization | 2.1.0 |
void openCamera(Context context,CameraType cameraType) | open camera | 2.1.0 |
void releaseCamera(CameraType cameraType) | release camera | 2.1.0 |
void startPreview(CameraType cameraType) | start preview | 2.1.0 |
void stopPreview(CameraType cameraType) | stop Preview | 2.1.0 |
void resetPreviewSize(ScaleManager.Size size,CameraType cameraType) | reset the preview size supported by the camera | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | IRgbAndIrPreviewCallback | Preview Data Callback | None | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | IRgbAndIrPreviewCallback | Preview Data Callback | None | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cameraType | CameraType | Camera Type | None | 2.1.0 |
Return Value | Description | Version Introduced |
List | Preview size list | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
width | int | preview width | None | 2.1.0 |
height | int | preview height | None | 2.1.0 |
degree | int | preview degree: 0,90,180,270 | None | 2.1.0 |
irSurfaceTexture | SurfaceTexture | IR surface | None | 2.1.0 |
rgbSurfaceTexture | SurfaceTexture | RGB surface | None | 2.1.0 |
cameraType | CameraType | camera type | None | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
context | Context | context | None | 2.1.0 |
cameraType | CameraType | camera type | None | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cameraType | CameraType | camera type | None | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cameraType | CameraType | camera type | None | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cameraType | CameraType | camera type | None | 2.1.0 |
Parameter Name | Type | Description | Note | Version Introduced |
size | ScaleManager.Size | preview size | None | 2.1.0 |
cameraType | CameraType | camera type | None | 2.1.0 |
Member | Description | Note | Version Introduced |
RGB | 1 rgb camera | None | 2.1.0 |
IR | 2 ir camera | None | 2.1.0 |
RGB_IR | 3 rgb and ir camera | None | 2.1.0 |
Used in traffic scenes, support Thermal imaging system preview and get the data recall, manage its the lifecycle, monitor its status, and auto co
Get different instances for Thermal imaging system
Get Thermal imaging system
Parameter
Return
ITemperatureCamera
Current Type
Exception
None
Operate Thermal imaging system
Batch Conversion of Temperature
Parameter
Return
Exception
None
Get Centigrade from Temperature Data
Parameter
Return
Centigrade Value
Exception
None
Get Camera Body Temperature
Parameter
None
Return
Camera Body Temperature
Exception
None
Add Thermal imaging system Preview Data Callback
Parameter
Return
None
Exception
None
Initialize Thermal imaging system
Parameter
Return
None
Exception
None
Release Thermal imaging system
Parameter
None
Return
None
Exception
None
Remove Temperature Preview Data Callback
Parameter
Return
None
Exception
None
Start Preview
Parameter
Return
None
Exception
None
Stop Preview
Parameter
None
Return
None
Exception
None
Thermal imaging system Configuration
Parameter
Return
None
Exception
None
Set Auto Shutter Enable
Parameter
Return
None
Exception
None
Open Shutter
Parameter
None
Return
None
Exception
None
Preview Data Callback
Temperature Preview Data Callback: Thermal imaging system outputs the image orientation as the same as its phisical orientation. For example, the human face will output with the vertical orientation.
Parameter
Thermal imaging system Configuration
Description of Properties
Thermal imaging system Type(Enumeration Type)
Description of Properties
Identify the content of the QR code
Temperature measurement algorithm initialization and calculation
Initialize temperature measurement algorithm
ThunderAir supports model 1.7.0 (summer mode) and 1.8.0 (normal mode) ThunderMini supports model 1.3.0 (summer mode), 1.5.0 (normal mode), 1.10.0 (winter mode), 1.11.0 (auto mode) Thunder-E supports model 1.2.0 (summer mode), 1.5.0 (normal mode)
Parameter
Return
Return 0 if the init operation is successful, otherwise return negative value
Exception
None
Calculate temperature
Parameter
Return
If the calculate operation is successful, return temperature data and region (the region is the face rectangle region where to measure the temperature), otherwise return null
Exception
None
Calculate temperature
Parameter
Return
If the calculate is successful, return result array, otherwise return null array
Exception
None
Release temperature measurement resource
Parameter
None
Return
None
Exception
None
Door Access Device Controling Pass and Thunder series devices
Control the overall initialization, configuration, and resource release operations of communication devices such as GPIO ports and serial ports of the control device, and perform specific door opening operations.
Get Door Access Configuration
Parameter
None
Return
Exception
None
Get device reference according to device type
Parameter
Return
Exception
None
Change Open Door Mode
Parameter
Return
None
Exception
None
Close Relay Door
Parameter
None
Return
None
Exception
None
Initialization without serial port number, refer to [void init(String uartName)](#void init(String uartName))
Parameter
None
Return
None
Exception
None
Initialization with serial port number
Parameter
Return
None
Exception
None
Open the door, execute the door opening action according to the set open door mode
Parameter
Return
No
Exception
No
Release Resource
Parameter
None
Return
None
Exception
None
Set Door Access Configuration
Parameter
Return
None
Exception
None
Set Card Read Callback
Parameter
Return
None
Exception
None
Set Custom Wiegand Data Interface Callback
Parameter
Return
No
Exception
No
Set Wiegand Card Number String Parsing Method
Parameter
Return
No
Exception
No
Control some door access devices of Pass and Thunder series
Close Back Light
Parameter
None
Return
None
Exception
None
Enable RS485
Parameter
Return
None
Exception
None
Enable RS485
Parameter
Return
None
Exception
None
Enable RS485
Parameter
Return
None
Exception
None
Open Back Light
Parameter
None
Return
None
Exception
None
press Buzzer (Only support SensePass and SenseThunderE-mini)
Parameter
None
Return
None
Exception
None
press Door Bell
Parameter
Return
None
Exception
None
Press Alarm Bell to Turn the Alarm On
Parameter
None
Return
None
Exception
None
Release Alarm Bell
Parameter
None
Return
None
Exception
None
Buzzer Off (Only supports SensePass020)
Parameter
None
Return
None
Exception
None
Set Door State Callback, Door Open/Close Status Listener
Parameter
Return
None
Exception
None
Door Button On Click Listener
Parameter
Return
None
Exception
None
Receive Fire Sign Listener
Parameter
Return
None
Exception
None
Send Data By RS485
Parameter
Return
None
Exception
None
Turn on IR Light, Support Pass and Thunder series
Parameter
None
Return
None
Exception
None
Turn off IR Light, Support Pass and Thunder series
Parameter
None
Return
None
Exception
None
Door Access Configuration
Door Access Device
Description of Method
WIEGAND Device Card Reader Callback
Description of Method
Wiegand Passthough Data Received Callback
Description of Method
Analysis of Customized Wiegand Card Number Data
Description of Method
Door Magnetism State Callback
Description of Method
Fire Sign Listener
Description of Method
Dismantle Sign Listener
Description of Method
Sensor Data change interface
Description of Method
Ir Listener
Description of Method
RS485 Data Read Listener
Description of Method
RS485 Data Read Time Out Callback
Description of Method
Door Button On Click Listener
Description of Method
Member Function
Description
Version Introduced
boolean checkCalibration(Bitmap rgbFace, Bitmap irFace)
check whether the face calibration is correct
2.1.0
Parameter Name
Type
Description
Note
Version Introduced
rgbFace
Bitmap
RGB face image
None
2.1.0
irFace
Bitmap
IR face image
None
2.1.0
Member Function
Description
Version Introduced
byte[] rotateImage(@NonNull byte[] resBuff, @NonNull MidPixelFormat pixelFormat, int width, int height, int degree)
rotate image
2.1.0
Parameter Name
Type
Description
Note
Version Introduced
resBuff
byte[]
image data
None
2.1.0
pixelFormat
MidPixelFormat
image format
None
2.1.0
width
int
image width
None
2.1.0
height
int
image height
None
2.1.0
degree
MidPixelFormat
image rotation degree
None
2.1.0
Member Function
Description
Version introduced
ITemperatureCamera getTemperatureCamera(CameraType type)
Get instances for Thermal imaging system
2.0.0
Parameter Name
Type
Description
Note
Version introduced
type
CameraType
Thermal imaging system Type
None
2.0.0
Member Function
Description
Version introduced
boolean matrixTemperature(float[] y16Frame, int y16W, int y16H, float distance, int x, int y, int w, int h, float[] tempArray)
Batch Conversion of Temperature
2.0.0
float getCentigradeFromTemperatureData(float temperatureData)
Calculate the Actual Temperature from the Temperature Data
2.0.0
float getCameraBodyTemperature()
get Camera Body Temperature
2.0.0
void addTemperaturePreviewDataCallback
(ITemperaturePreviewDataCallback callback)
add Thermal imaging system Preview Data Callback
2.0.0
void initCamera(Context context)
Initialize the Thermal imaging system
2.0.0
void releaseCamera()
release Thermal imaging system
2.0.0
void removeTemperaturePreviewDataCallback
(ITemperaturePreviewDataCallback callback)
remove Thermal imaging system Preview Data Callback
2.0.0
void startPreview(TextureView textureView)
start Thermal imaging system Preview
2.0.0
void stopPreview()
stop Thermal imaging system Preview
2.0.0
void setConfig(TemperatureCameraConfig config)
Configure Thermal imaging system
2.0.0
void setAutoShutterEnable(boolean enable)
set Auto Shutter Enable
2.0.0
void shutter()
Shutter
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
y16Frame
float[]
Original Temperature Chart
None
2.0.0
y16W
int
Original Temperature Chart Width
None
2.0.0
y16H
int
Original Temperature Chart Height
None
2.0.0
distance
float
Real Temperature Measurement Distance
None
2.0.0
x
int
the Starting x Coordinate to be Converted
None
2.0.0
y
int
the Starting y Coordinate to be Converted
None
2.0.0
w
int
Width to be Converted
None
2.0.0
h
int
Height to be Converted
None
2.0.0
tempArray
float[]
Converted Temperature Array, size is w*h
None
2.0.0
Returned Value
Description
Version Introduced
true
Converted
2.0.0
false
Not Convered
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
temperatureData
float
Temperature Data on Each Pixel, Such as Energy Value
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
ITemperaturePreviewDataCallback
Preview Data Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
context
Context
Context
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
callback
ITemperaturePreviewDataCallback
Temperature Preview Data Callback
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
textureView
TextureView
Android System Native (Used for Data Processing)
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
config
TemperatureCameraConfig
Thermal imaging system Configuration
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
enable
boolean
Set Auto Shutter Enable
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
temperatureBitmap
Bitmap
Temperature rgb Picture
None
2.0.0
temperatureValue
float[]
Temperature Data
None
2.0.0
width
int
Temperature Data Width
None
2.0.0
height
int
Temperature Data Height
None
2.0.0
Member
Type
Description
Note
Version Introduced
environmentTemperature
float
Environment Temperature
None
2.0.0
distance
float
Temperature Measurement Distance
None
2.0.0
transmittance
float
Atmospheric Transmissivity
None
2.0.0
emissity
float
Emissivity
None
2.0.0
Member
Description
Note
Version Introduced
IRAY
IRAY
None
2.0.0
GUIDE120
GUIDE120
None
2.0.0
GUIDE256
GUIDE256
None
2.0.0
Member Function | Description | Version Introduced |
String decodeQRCode(byte[] nv21, int w, int h) | QR code Identification | 2.0.0 |
String decodeQRCode(Bitmap bitmap) | QR code Identification | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
nv21 | byte[] | Preview frame data | None | 2.0.0 |
w | int | Preview width | None | 2.0.0 |
h | int | Preview height | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
bitmap | Bitmap | Image Data | None | 2.0.0 |
Member Function | Description | Version Introduced |
int init(TempMeasureVersion algorithmVersion,iTemperConvertCallback temperConvertCallback ) | Initialize temperature measurement algorithm | 2.0.0 |
TemperInfo temperCalculateObtainRect(FaceInfo faceInfo, float[] imageData, int width, int height, int orient, float envTemper, float topN) | Measure temperature of single person on Sensepass, SenseThunderE, SenseThunderE-mini | 2.0.0 |
TemperInfo multiTemperCalculate(MatchFace[] matchFaces, float[] temperatureData,int temperatureWidth, int temperatureHeight, float envTemper, int orient, float topN) | Measure temperature of multi persons on SenseThunderAir | 2.0.0 |
void release() | Release temperature measurement resource | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
algorithmVersion | TempMeasureVersion | Algorithm version | None | 2.0.0 |
temperConvertCallback | TemperConvertCallback | Temperature measurement callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
faceInfo | FaceInfo | Face information | None | 2.0.0 |
imageData | float[] | Image data | None | 2.0.0 |
width | int | Image width | None | 2.0.0 |
height | int | Image height | None | 2.0.0 |
orient | int | Face orientation | None | 2.0.0 |
envTemper | float | Environment temperature | None | 2.0.0 |
topN | float | Face information(The temperature detection model detects temperature based on the points on the face. TOP N refers to a portion. Input is float such as 100%, 50%.) | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
MatchFace[] | matchFaces | Matched face information array | None | 2.0.0 |
temperatureData | float[] | Image data | None | 2.0.0 |
temperatureWidth | int | Image width | None | 2.0.0 |
temperatureHeight | int | Image height | None | 2.0.0 |
orient | int | Face orientation | None | 2.0.0 |
envTemper | float | Environment temperature | None | 2.0.0 |
topN | float | Face information | None | 2.0.0 |
Member Function | Description | Version Introduced |
DoorAccessConfig getConfig() | Get Door Access Configuration | 2.0.0 |
DoorAccessDevice getDevice(int deviceType) | Get Device | 2.0.0 |
void changeOpenDoorDevice(int mode) | Change Open Door Mode | 2.0.0 |
void closeRelayDoor() | Close Relay Door | 2.0.0 |
void init() | Initialization | 2.0.0 |
void init(String uartName) | Initialization | 2.0.0 |
void openDoor(String cardNumber) | Open Door | 2.0.0 |
void release() | Release Resouce | 2.0.0 |
void setConfig(DoorAccessConfig config) | set Door Access Configuration | 2.0.0 |
void setCardReaderCallback (WiegandReaderDevice.CardReaderCallback cardReaderCallback) | set Wiegand Card Reader Callback | 2.0.0 |
void setCustomWiegandDataReceivedCallback (WiegandReaderDevice.OnDataReceivedCallback dataReceivedCallback) | Set Custom Wiegand Data Interface Callback | 2.0.0 |
void setICardNumberAnalysis (WiegandDoorDevice.ICardNumberAnalysis cardNumberAnalysis) | Set Wiegand Card Number Analysis Mode | 2.0.0 |
Returned Value | Description | Note | Version Introduced |
DoorAccessConfig | Door Access Configuration Instance | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
deviceType | int | Device Type | None | 2.0.0 |
Returned Value | Description | Note | Version Introduced |
DoorAccessDevice | Door Access Device | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
mode | int | Open Door Mode | DoorAccessConfig Door Access Configuration | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
uartName | String | Serial port name | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cardNumber | String | IC Card Number | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
config | DoorAccessConfig | Door Access Configuration | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cardReaderCallback | WiegandReaderDevice.CardReaderCallback | Wiegand Card Reader Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
dataReceivedCallback | WiegandReaderDevice.OnDataReceivedCallback | Wiegand Passthough Data Received Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
cardNumberAnalysis | WiegandDoorDevice.ICardNumberAnalysis | Card Number String Parsing Method | None | 2.0.0 |
Member Function | Description | Version Introduced |
void closeBackLight() | Close Back Light | 2.0.0 |
void enableRS485(RS485Device.RS485ReceiveListener listener) | enable RS485 | 2.0.0 |
void enableRS485(int baudrate, int readBufferSize, RS485Device.RS485ReceiveListener listener) | enable RS485 | 2.0.0 |
void enableRS485(int baudrate, int readBufferSize, RS485Device.RS485ReceiveListener listener, int readTimeout, SerialPortReader.OnReadTimeOutListener timeOutListener) | enable RS485 | 2.0.0 |
void openBackLight() | Open Back Light | 2.0.0 |
void pressBuzzer() | press Buzzer | 2.0.0 |
void pressDoorBell(int pressDownDuration) | press Door Bell | 2.0.0 |
void pressAlarmBell() | press Alarm Bell | 2.0.0 |
void releaseAlarmBell() | release Alarm Bell | 2.0.0 |
void releaseBuzzer() | release Buzzer | 2.0.0 |
void setDoorStateCallback(DoorMagnetismStateCallback callback) | set Door State Callback | 2.0.0 |
void setOnClickDoorButtonListener (DoorButtonDevice.DoorButtonOnClickListener listener) | Door Button On Click Listener | 2.0.0 |
void setReceiveFireSignListener (FireSignalDevice.ReceiveFireSignListener listener) | Fire Sign Listener | 2.0.0 |
void sendDataByRS485(byte[] data) | send Data By RS485 | 2.0.0 |
void turnOnIrLight() | turn On IR Light | 2.0.0 |
void turnOffIrLight() | turn Off IR Light | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
listener | RS485Device.RS485ReceiveListener | Data Receive Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
baudrate | int | baudrate | None | 2.0.0 |
readBufferSize | int | The length of the data to be read | None | 2.0.0 |
listener | RS485Device.RS485ReceiveListener | Data Receive Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
baudrate | int | baudrate | None | 2.0.0 |
readBufferSize | int | The length of the data to be read | None | 2.0.0 |
listener | RS485Device.RS485ReceiveListener | Data Receive Callback | None | 2.0.0 |
readTimeout | int | Data read timeout period | None | 2.0.0 |
timeOutListener | SerialPortReader.OnReadTimeOutListener | Data read timeout callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
pressDownDuration | int | press Down Duration, unit millisecond | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | DoorMagnetismStateCallback | State Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
listener | DoorButtonDevice.DoorButtonOnClickListener | Door Button On Click Listener | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
listener | FireSignalDevice.ReceiveFireSignListener | Fire Sign Listener | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
data | byte[] | Data to be Sent | None | 2.0.0 |
Member | Description | Note | Version Introduced |
static final int OPEN_DOOR_MODE_RELAY | Open Local Relay Door, | constant | 2.0.0 |
static final int OPEN_DOOR_MODE_IP_RELAY | network relay | constant | 2.0.0 |
static final int OPEN_DOOR_MODE_WIEGAND26_24_BIT | WIEGAND26(24bit) | constant | 2.0.0 |
static final int OPEN_DOOR_MODE_WIEGAND26_8_16_BIT | WIEGAND26(8 + 16 bit) | constant | 2.0.0 |
static final int OPEN_DOOR_MODE_WIEGAND32 | WIEGAND32 | constant | 2.0.0 |
static final int OPEN_DOOR_MODE_WIEGAND34 | WIEGAND34 | Constant | 2.0.0 |
static final int OPEN_DOOR_MODE_CUSTOM | Wiegand Custom (Output) | Constant | 2.0.0 |
Member | Description | Note | Version Introduced |
static final int WIEGAND26_24_BIT | WIEGAND26(24bit) | Constant | 2.0.0 |
static final int WIEGAND26_8_16_BIT | WIEGAND26(8 + 16bit) | Constant | 2.0.0 |
static final int WIEGAND32 | WIEGAND32 | Constant | 2.0.0 |
static final int WIEGAND34 | WIEGAND34 | Constant | 2.0.0 |
static final int WIEGAND_INPUT_CUSTOM | WIEGAND CUSTOM (INPUT) | Constant | 2.0.0 |
Member | Description | Note | Version Introduced |
static final int GPIO_IN_NONE | GPIO Input not Configured | Constant | 2.0.0 |
static final int GPIO_IN_DOOR_MAGNETISM | GPIO Input Configuration DOOR MAGNETISM | Constant | 2.0.0 |
static final int GPIO_IN_DOOR_BUTTON | GPIO Input Configuration DOOR BUTTON | Constant | 2.0.0 |
static final int GPIO_IN_FIRE_SIGNAL | GPIO Input Configuration FIRE SIGNAL | Constant | 2.0.0 |
static final int GPIO_OUT_NONE | GPIO Output not configured | Constant | 2.0.0 |
static final int GPIO_OUT_DOOR_BELL | GPIO Output Configuration DOOR BELL | Constant | 2.0.0 |
static final int GPIO_OUT_ALARM | GPIO Output Configuration ALARM | Constant | 2.0.0 |
Member | Description | Note | Version Introduced |
int mOpenDoorTime | Open Door Time | None | 2.0.0 |
int mOpenDoorMode | Open Door Mode | None | 2.0.0 |
int mGpioOut | GPIO Output Port | None | 2.0.0 |
int mGpioInA | GPIO Input A | None | 2.0.0 |
int mGpioInB | GPIO Input B | None | 2.0.0 |
int mWiegandInput | Wiegand Input | None | 2.0.0 |
int mDoorMagnetismTimeout | Door Magnetism Timeout | None | 2.0.0 |
String mRelayIp | Network Relay IP | None | 2.0.0 |
int mRS485BaudRate | RS485 Serial Port Baud Rate | Default 9600 | 2.0.0 |
int mRS485BufferSize | RS485 buffer size | Default 64 | 2.0.0 |
boolean mIsSupportRS485GpioAutoControl | Support RS485 GPIO Auto Control | None | 2.0.0 |
int mPulseCycle | Pulse Cycle | Default 2400 | 2.0.0 |
int mPulseWidth | Pulse Width | Default 380 | 2.0.0 |
boolean mReverseCardNumber | Reverse Card Number | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
DoorAccessConfig build() | Build an Instance of DoorAccessConfig | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
int getDeviceId() | Return Device ID | None | 2.0.0 |
void setConfig(DoorAccessConfig config) | add Device Configuration | None | 2.0.0 |
void destroyDevice() | Destroy Device | None | 2.0.0 |
boolean isDeviceCreated() | Device Created | None | 2.0.0 |
void createDevice() | Create Device | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onRead(String cardNumber) | Card Read Successful and Get Card Number | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onDataReceived(byte[] cardData) | Data Receive Callback | cardData: Customized Wiegand Card Number Data | 2.0.0 |
Member Function | Description | Note | Version Introduced |
byte[] analysis(String cardDataString) | The card string is parsed into byte[] data | cardDataString card Data String Return the custom Wiegand data corresponding to the card | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onDoorStateChanged(int state) | Door Magnetism State Callback | state 0-OFF, 1-ON | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onReceive() | Fire Sign Listener | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onReceive() | Dismantle Sign Listener | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onSensorChanged(String value) | Data Change Callback | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onInfraredSignalRead() | Ir Callback | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onReceive(byte[] data,long dataLength) | RS485 Data Read Listener | dataLength: Data Length; data: Data Read | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onTimeout(byte[] data,long dataLength) | RS485 Data Read Time Out Callback | dataLength: Data Length; data: Data read when timeout | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onClick() | Door Button On Click Callback | None | 2.0.0 |
HTTP interface implementation
Get Image Data
Parameter
Return
Image Data
Exception
None
Get Current Connection Configuration
Parameter
None
Return
ConnectConfigEntity
Exception
None
Alarm Report
Parameter
Return
Result
Exception
None
Bind Default Group
Parameter
None
Return
Result
Exception
No
Check Password
Parameter
Return
Result
Exception
None
Check Tsl Exist
Parameter
Return
Result<TslCheckExistResult>
Exception
None
Check Tsl Language Exist
Parameter
Return
Result<TslLanguageCheckExistResult>
Exception
None
Server Identification
Parameter
Return
Result<FaceSearchResult>
Exception
None
Get Group Index List Bound to the device
Parameter
None
Return
Result<GroupIndex>
Exception
None
Get User Index List in a Group
Parameter
None
Return
Result>
Exception
None
Get User Info List
Parameter
Return
Result>
Exception
None
Get Server Configuration
Parameter
None
Return
Result
Exception
None
Get Group List Bound to the Device
Parameter
None
Return
Result<DeviceGroups>
Exception
None
Get Device DetaiIed Info
Parameter
None
Return
Result<DeviceDetailInfo>
Exception
None
Get Company Info
Parameter
None
Return
Result<Company>
Exception
No
Get User Detailed Info
Parameter
Return
Result<UserDetailInfo>
Exception
None
Get Guest Detailed Info
Parameter
Return
Result<GuestDetailInfo>
Exception
None
Get Server Version
Parameter
None
Return
Result<ServerVersion>
Exception
None
Get Pass Time Table
Parameter
Return
Result<TimeTable>
Exception
None
Log out
Parameter
None
Return
None
Exception
None
QR Code Identification Interface
Parameter
Return
Result<QRResult>
Exception
None
Device Login
Parameter
Return
Result<LoginResult>
Exception
None
Device Registration
Parameter
Return
Result<RegisterResult>
Exception
None
Result reportUserStatus(UserStatusParameter userStatusParameter)
Upload the abnormal status of the user in the local database
Parameter
Return
Result
Exception
None
Upload the abnormal status of the user in the local database
Parameter
Return
Result
Exception
None
Refresh Connect Configuration
Parameter
Return
None
Exception
None
Report Device Event
Parameter
Return
Result
Exception
None
Upload Identification Record
Parameter
Return
Result<RecordResult>
Exception
None
Upload Device Version Info
Parameter
Return
Result
Exception
None
Upload Configuration
Parameter
Return
Result
Exception
None
Upload Tsl
Parameter
Return
Result
Exception
None
Upload Tsl Language Package
Parameter
Return
Result
Exception
None
MQTT Interface implementation
Connect MQTT
Parameter
Return
None
Exception
None
Disconnect MQTT
Parameter
Return
None
Exception
None
Get User List In a Group
Parameter
Return
None
Exception
None
Register Device and User In Group Change Callback
Parameter
Return
None
Exception
None
Register User In Group Change Callback
Parameter
Return
None
Exception
None
Register Warning Action Change Callback
Parameter
Return
None
Exception
None
Register Access Strategy Change Callback
Parameter
Return
None
Exception
None
Register APP and ROM Update Callback
Parameter
Return
None
Exception
None
Register Device Status Change Callback
Parameter
Return
None
Exception
None
Register Device Configuration Change Callback
Parameter
Return
None
Exception
None
Register Device Server End Notification Push Callback
Parameter
Return
None
Exception
None
Register Device Keep Door Open Or Close Schedule Push Callback
Parameter
Return
None
Exception
None
Unregister Device and User In Group Change Callback
Parameter
None
Return
None
Exception
None
Unregister User In Group Change Callback
Parameter
Return
None
Exception
None
Unregister User List of a Group
Parameter
Return
No
Exception
No
Unregister Warning Action Change Callback
Parameter
None
Return
None
Exception
None
Unregister Access Strategy Change Callback
Parameter
None
Return
None
Exception
None
Unregister APP and ROM Update Callback
Parameter
No
Return
No
Exception
No
Unregister Device Status Change Callback
Parameter
None
Return
None
Exception
None
Unregister Device Configuration Change Callback
Parameter
None
Return
None
Exception
None
Unregister Device Server End Notification Push Callback
Parameter
None
Return
None
Exception
None
Unregister Device Keep Door Open Or Close Schedule Push Callback
Parameter
None
Return
None
Exception
None
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Properties
Description of Method
Description of Method
Face feature library management
Delete face feature
Parameter
Return
Return 0 if delete operation is successful, otherwise return -1 if invalid parameters -260 if face feature library is empty -261 if can't find
Exception
None
Get face feature of the image
Parameter
Return
Return face feature byte array
Exception
None
Insert feature library
Parameter
Return
Return 0 if the insert operation is successful, otherwise return -1 if invalid parameters -259 if face feature fails to add into libary -262 if can't get UUID
Exception
None
Member Function
Description
Version Introduced
byte[] getImage(int type, String imageId)
Get Image Data
2.0.0
ConnectConfigEntity getConnectConfigEntity()
Get Current Connection Configuration
2.0.0
Result alarmReport(AlarmReportParameter reportParameter)
Alarm Report
2.0.0
Result bindDefaultGroup()
bind Default Group
2.0.0
Result checkPasswordUseLoginInterface(String password)
check Password
2.0.0
Result<TslCheckExistResult> checkTslExist(String md5)
check Tsl Exist
2.0.0
Result<TslLanguageCheckExistResult> checkTslLanguageExist(Result checkTslLanguageExist(String lang))(String lang)
check Tsl Language Exist
2.0.0
Result<FaceSearchResult> faceSearch(FaceSearchParameter searchParameter)
Server Identification
2.0.0
Result> getGroupIndexList()
Get Group Index List Bound to the device
2.0.0
Result> getUserIndexList(int groupId)
Get User Index List in a Group
2.0.0
Result> getUserInfoList(UserInfoParameter parameter)
Get User Info List
2.0.0
Result getServiceConfigJson()
Get Server Configuration
2.0.0
Result<DeviceGroups> getAllGroupList()
Get Group List Bound to the Device
2.0.0
Result<DeviceDetailInfo> getDeviceDetailInfo()
Get Device DetaiIed Info
2.0.0
Result<Company> getCompanyInfo()
Get Company Info
2.0.0
Result<UserDetailInfo> getUserInfo(long id)
Get User Detailed Info
2.0.0
Result<GuestDetailInfo> getGuestInfo(long id)
Get Guest Detailed Info
2.0.0
Result<ServerVersion> getServerVersion()
Get Server Version
2.0.0
Result<TimeTable> getPassTimeTable(long timetableId)
Get Pass Time Table
2.0.0
void logout()
logout
2.0.0
Result<QRResult> identifyQRCode(IdentifyQRCodeParameter parameter)
QR Code Identification Interface
2.0.0
Result<LoginResult> login(String account, String password,String identifier, String duid)
Device Login
2.0.0
Result<RegisterResult> register( RegisterParameter registerParameter)
Device Registration
2.0.0
Result reportUserStatus(UserStatusParameter userStatusParameter)
Upload the abnormal status of the user in the local database
2.0.0
Result reportUserStatus(UserSyncStatusParameter userSyncStatusParameter)
Upload the abnormal status of the user in the local database
2.0.0
void refreshConnectConfig(ConnectConfigEntity connectConfig)
refresh Connect Configuration
2.0.0
Result reportDeviceEvent(DeviceReportEventParamer param)
Report Device Status
2.0.0
Result<RecordResult> uploadRecord(RecordParameter recordParameter)
Upload Identification Record
2.0.0
Result uploadDeviceVersionInfo(DeviceVersionInfoParameter deviceInfoParameter)
Upload Device Version Info
2.0.0
Result uploadConfig(String deviceConfigKey, Object config)
Upload Configuration
2.0.0
Result uploadTsl(TslUploadParameter parameter)
upload Tsl
2.0.0
Result uploadTslLanguage(TslLanguageUploadParameter parameter)
upload Tsl Language Package
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
type
int
Image Type
1-Base Image in Senselink, 2-Recognition Image
2.0.0
imageId
String
Image ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
reportParameter
AlarmReportParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
password
String
password
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
md5
String
File md5
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
lang
String
Language
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
searchParameter
FaceSearchParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
parameter
UserInfoParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
id
long
User ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
id
long
Guest ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
timetableId
long
Pass Time Table ID
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
parameter
IdentifyQRCodeParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
account
String
Device Login Account
None
2.0.0
password
String
Device Login Password
None
2.0.0
identifier
String
Device Identifier
None
2.0.0
duid
String
Device sn
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
registerParameter
RegisterParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
userStatusParameter
UserStatusParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
userSyncStatusParameter
UserSyncStatusParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
connectConfig
ConnectConfigEntity
Configuration
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
param
DeviceReportEventParamer
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
recordParameter
RecordParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
deviceInfoParameter
DeviceVersionInfoParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
deviceConfigKey
String
Device config key
None
2.0.0
config
Object
config Configuration
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
parameter
TslUploadParameter
Parameter
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
parameter
TslLanguageUploadParameter
Parameter
None
2.0.0
Member Function | Description | Version introduced |
void connectMqtt(IMqttActionListener listener, IConnectionLost connectionLost, boolean useTokenConnect, SocketFactory socketFactory) | Connect MQTT | 2.0.0 |
void disConnectMqtt(IMqttActionListener listener) | Disconnect MQTT | 2.0.0 |
void getUserListInGroup (int groupId, MessageCallback callback) | Get User List In a Group | 2.0.0 |
void registerGroupChangeListener (MessageCallback callback) | Register Device and User In Group Change Callback | 2.0.0 |
void registerUserInGroupChangeListener (int groupId, MessageCallback callback) | Register User In Group Change Callback | 2.0.0 |
void registerWarningAction(MessageCallback callback) | Register Warning Action Change Callback | 2.0.0 |
void registerAccessStrategy (MessageCallback callback) | Register Access Strategy Change Callback | 2.0.0 |
void registerUpgrade (MessageCallback callback) | Register APP and ROM Update Callback | 2.0.0 |
void registerDeviceStatus (MessageCallback callback) | Register Device Status Change Callback | 2.0.0 |
void registerDeviceConfig(MessageCallback callback) | Register Device Configuration Change Callback | 2.0.0 |
void registerDeviceNotify(MessageCallback callback) | Register Device Server End Notification Push Callback | 2.0.0 |
void registerKeepDoorOpenOrCloseSchedule (MessageCallback callback) | Register Device Keep Door Open Or Close Schedule Push Callback | 2.0.0 |
void unRegisterGroupChangeListener() | Unregister Device and User In Group Change Callback | 2.0.0 |
void unegisterUserInGroupChangeListener(int groupId) | Unregister User In Group Change Callback | 2.0.0 |
void unegisterGetUserListInGroup(int groupId) | Unregister User List of a Group | 2.0.0 |
void unRegisterWarningAction() | Unregister Warning Action Change Callback | 2.0.0 |
void unRegisterAccessStrategy() | Unregister Access Strategy Change Callback | 2.0.0 |
void unRegisterUpgrade() | Unregister APP and ROM Update Callback | 2.0.0 |
void unRegisterDeviceStatus() | Unregister Device Status Change Callback | 2.0.0 |
void unRegisterDeviceConfig() | Unregister Device Configuration Change Callback | 2.0.0 |
void unRegisterDeviceNotify() | Unregister Device Server End Notification Push Callback | 2.0.0 |
void unRegisterKeepDoorOpenOrCloseSchedule() | Unregister Device Keep Door Open Or Close Schedule Push Callback | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
listener | IMqttActionListener | Callback | None | 2.0.0 |
connectionLost | IConnectionLost | Connection Lost Callback | None | 2.0.0 |
useTokenConnect | boolean | Use Token Connect | None | 2.0.0 |
socketFactory | SocketFactory | The verification method used to build https | certificate not verified by default | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
listener | IMqttActionListener | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
groupId | int | Group ID | None | 2.0.0 |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
groupId | int | Group ID | None | 2.0.0 |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
callback | MessageCallback | Callback | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
groupId | int | Group ID | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
groupId | int | Group ID | None | 2.0.0 |
Member | Description | Note | Version Introduced |
ZH | Simplified Chinese | None | 2.0.0 |
ZH_TW | Traditional Chinese | None | 2.0.0 |
EN | English | None | 2.0.0 |
JP | Japanese | None | 2.0.0 |
KO | Korean | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
account | String | Account | None | 2.0.0 |
password | String | Password | None | 2.0.0 |
identifier | String | Device Identifier | None | 2.0.0 |
duid | String | Device SN | None | 2.0.0 |
token | String | Device Token | None | 2.0.0 |
ldid | String | Device Background Identification Number | None | 2.0.0 |
companyId | int | Company ID | None | 2.0.0 |
isNewDevice | boolean | Is New Device | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
code | int | Status Code | None | 2.0.0 |
data | T | Data | None | 2.0.0 |
message | String | message | None | 2.0.0 |
desc | String | Description | None | 2.0.0 |
originData | String | Origin Data | None | 2.0.0 |
rawData | byte[] | Binary Data | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
boolean isSuccess() | Request Success | true-success, false-fail | 2.0.0 |
Member | Type | Description | Note | Version Introduced | is it necessary |
traceId | String | Alarm Serial Number | None | 2.0.0 | Y |
alarmPhoto | String | Alarm Photo | None | 2.0.0 | N |
code | int | Alarm Code | 10001 stands for disassembly alarm, 10002 stands for forced door open alarm, 10003 stands for door magnetism overtime alarm, 10004 is password attack alarm, 10005 is Bluetooth power shortage, 10006 indicates thermal imager connection exception, 20001 shows camera contamination, 20002 means a non-liveness attack, 20003 is fire alarm and 40001 stands for feature extraction failure | 2.0.0 | If the parameter "status" is 1, then the parameter "code" is necessary, otherwise it is optional |
description | String | Alarm Description | None | 2.0.0 | N |
eventTime | Long | Event Time | millisecond precision | 2.0.0 | Y |
status | int | Alarm Report Event | 1 means there is an alarm, 2 means alarm clearance failed, 3 means alarm clearance successful | 2.0.0 | Y |
rectangle | List<VerticesItem> | rectangle coordinate | The first is the upper left corner coordinates, the second is the lower right corner coordinates | 2.0.0 | N |
userId | long | User ID | None | 2.0.0 | N |
Member | Type | Description | Note | Version Introduced | is it necessary |
x | int | x Coordinate | None | 2.0.0 | Y |
y | int | y Coordinate | None | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced |
id | long | Guest id | None | 2.0.0 |
avatar | String | Compare Avatar | None | 2.0.0 |
showAvatar | String | Show Avatar | None | 2.0.0 |
name | String | Name | None | 2.0.0 |
groups | List<GroupsItem> | Group | None | 2.0.0 |
mobile | String | Contact Info | None | 2.0.0 |
guestCompany | String | Guest Company | None | 2.0.0 |
birthday | String | Birthday | None | 2.0.0 |
position | String | Position | None | 2.0.0 |
idNumber | String | ID Number | None | 2.0.0 |
icNumber | String | ic Card Number | None | 2.0.0 |
String | None | 2.0.0 |
guestPurpose | String | Guest Purpose | None | 2.0.0 |
receptionUserId | long | reception User id | None | 2.0.0 |
receptionUserName | String | reception User Name | None | 2.0.0 |
dateTimeFrom | String | Effective Time From | None | 2.0.0 |
dateTimeTo | String | Effective Time To | None | 2.0.0 |
level | int | level | None | 2.0.0 |
remark | String | Note | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
id | int | Group ID | None | 2.0.0 |
name | String | Group Name | None | 2.0.0 |
type | int | Group Type | 1:User Group, 2: Guest Group, 5: deny list Group | 2.0.0 |
personCount | int | person Count | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
flag | int | Flag | 0 Not Exist, 1 Exist | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
flag | int | Flag | 0 Not Exist, 1 Exist | 2.0.0 |
md5 | String | File md5 | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
searchResult | List<SearchResultItem> | Search Result | None | 2.0.0 |
gateCtrl | boolean | Door Open | None | 2.0.0 |
timestamp | long | Timestamp uploaded when requested by the client | None | 2.0.0 |
passRuleType | int | Pass Rule Type | 0: Local Pass Rule 1: Server Pass Rule | 2.0.0 |
sign | String | md5, check note for detail | The md5 Value of {timestamp}-{ldid}-{gateCtrl}-{passRuleType} | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
faceCutImage | Content | Face Cut Image | None | 2.0.0 |
score | float | Verify Score | None | 2.0.0 |
userId | int | User ID | None | 2.0.0 |
userCardId | String | User Door Access Card ID | None | 2.0.0 |
userImage | Content | User Library Image | None | 2.0.0 |
trackId | int | id for Face Tracking | None | 2.0.0 |
userName | String | User Name | None | 2.0.0 |
displayMsg | String | display Msg | None | 2.0.0 |
displayColor | String | display Color | None | 2.0.0 |
verifyCode | int | Verification Code | 1: Unactivated, 2: activated, 3: Unauthorized 4: Match failed, 5: Not within the passable time range | 2.0.0 |
type | int | Type | None | 2.0.0 |
idNumber | String | id Number | None | 2.0.0 |
sign | String | md5 | the md5 Value of {verifyCode}-{timestamp}-{ldid}-{userId} | 2.0.0 |
extra | String | Extra String | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
data | String | Original Image Data | Choose it or url | 2.0.0 |
format | String | Image Type | IMAGE_UNKNOWN, IMAGE_JPEG, IMAGE_PNG, IMAGE_BMP, IMAGE_TIFF, IMAGE_GIF | 2.0.0 |
url | String | Image url | choose it or data | 2.0.0 |
Member | Type | Description | Note | Version Introduced | Is it necessary |
targetImages | ImagesItem | Capture several groups of small pictures | small picture is not required if a full picture is uploaded | 2.0.0 | N |
extraInfo | String | Extra String | None | 2.0.0 | N |
receiveTime | long | receive Timestamp | millisecond class | 2.0.0 | N |
fullImage | Content | full picture | full picture is not required if a caputured small picture is uploaded | 2.0.0 | Y |
captureTime | long | Capture Timestamp | millisecond class | 2.0.0 | N |
cameraInfo | CameraInfo | Camera Common Info | None | 2.0.0 | N |
timestamp | long | Timestamp | millisecond class | 2.0.0 | N |
Member | Type | Description | Note | Version Introduced |
detectionMode | String | detection Mode | DETECT_MODE_AUTO: Automatically select the detection frame according to TargetAnnotation.rectangle and the size of the captured image.DETECT_MODE_BOUNDING_ONLY: Only use TargetAnnotation.rectangle.Rectangle must be passed in, otherwise it is an invalid target.DETECT_MODE_FORCE_DETECTION: Mandatory use of detection model for detection | 2.0.0 |
targetInfo | TargetInfo | general capture target information structure | None | 2.0.0 |
content | Content | Image Content | None | 2.0.0 |
imageType | int | Image Type | 1: rgb Image, 2: ir Image | 2.0.0 |
mask | int | Wear Mask | 0 Not pass in, 1 No,2 Yes | 2.0.0 |
bodyTemperature | float | body Temperature | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
trackId | int | Track id | None | 2.0.0 |
angle | Angle | Face Angle Info | None | 2.0.0 |
rectangle | Rectangle | Rectangle | None | 2.0.0 |
landmarks | List<LandmarksItem> | Object key point coordinate | None | 2.0.0 |
quality | float | Target detection quality | [0.0, 1.0] | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
roll | int | Face roll angle | None | 2.0.0 |
pitch | int | Face pitch angle | None | 2.0.0 |
yaw | int | Face yaw angle | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
vertices | List<VerticesItem> | Target rectangular area | coordinates of the upper left corner, coordinates of the lower right corner | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
x | int | x Coordinate | None | 2.0.0 |
y | int | y Coordinate | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
x | int | x Coordinate | None | 2.0.0 |
y | int | y Coordinate | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
placeName | String | Name of the place where the camera is located | None | 2.0.0 |
deviceId | String | Camera Hardware id | None | 2.0.0 |
tollgateId | String | id of the toll gate where the camera is located | None | 2.0.0 |
tollgateName | String | Name of the toll gate where the camera is located | None | 2.0.0 |
cameraId | String | Camera id | None | 2.0.0 |
deviceType | String | Camera HardwareType | None | 2.0.0 |
placeCode | String | code of the place where the camera is located | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
updatedAt | long | Update Timestamp | None | 2.0.0 |
groupId | int | Group ID | None | 2.0.0 |
groupName | String | Group Name | None | 2.0.0 |
createdAt | long | Created Timestamp | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
userUpdatedAt | long | User Update Time | None | 2.0.0 |
userId | int | User ID | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
birthday | String | Birthday | None | 2.0.0 |
modelVersion | String | Model Version | None | 2.0.0 |
String | None | 2.0.0 |
gender | int | Gender | 0-Unknown, 1-Female, 2-Male |
userName | String | User Name | None | 2.0.0 |
phoneSuffix | String | Mobile Number Suffix | None | 2.0.0 |
createdAt | long | Create Timestamp | None | 2.0.0 |
remark | String | Remark | None | 2.0.0 |
addChannel | int | add Channel | 1: web; 2: senseid; 3: QR Code; 4: openapi 5: SenseHi App Self-modification 6: batch tool |
type | int | User Type | 1:User 2:Guest 3 deny list |
avatarShow | String | Art Photo ID | None | 2.0.0 |
dateTimeTo | long | End Timestamp | None | 2.0.0 |
guestCompany | String | Guest Company | None | 2.0.0 |
guestLevel | String | Guest Level | None | 2.0.0 |
feature | String | Face Feature | None | 2.0.0 |
updatedAt | long | Update Timestamp | None | 2.0.0 |
jobNumber | String | Job Number | None | 2.0.0 |
icNumber | String | IC Card Number | None | 2.0.0 |
dateTimeFrom | long | Start Timestamp | None | 2.0.0 |
entryTime | long | Entry Time | None | 2.0.0 |
idNumber | String | ID Number | None | 2.0.0 |
companyId | int | User Company ID | None | 2.0.0 |
departmentId | int | User Department ID | None | 2.0.0 |
departmentName | String | Department Name | None | 2.0.0 |
areaCode | String | Area Code | None | 2.0.0 |
mobile | String | Mobile Number | None | 2.0.0 |
permission | int | Access permission | 0-Permitted, 1-Not Permitted | 2.0.0 |
receptionUserId | int | User id for Guest Reception | None | 2.0.0 |
avatar | String | Avatar ID | None | 2.0.0 |
countryCode | String | Country Code | None | 2.0.0 |
staffType | int | Staff Type | 1-Staff, 2Intern | 2.0.0 |
userId | int | User ID | None | 2.0.0 |
guestPurpose | String | guest Purpose | None | 2.0.0 |
location | String | Location | None | 2.0.0 |
position | String | Position | None | 2.0.0 |
placeCode | String | Place Code | None | 2.0.0 |
prompt | String | Personalized Prompt | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
userIds | List | User id Arrays | Up to 20,000 arrays at a time | 2.0.0 |
modelVersion | String | Model Version | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
id | String | Device ID | None | 2.0.0 |
userGroups | List<GroupsItem> | User Group | None | 2.0.0 |
guestGroups | List<GroupsItem> | Guest Group | None | 2.0.0 |
denyListGroup | List<GroupsItem> | deny list group | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
deviceTypeMaxOnline | DeviceTypeMaxOnline | Device Type Max Online | None | 2.0.0 |
ldid | String | Device LDID | None | 2.0.0 |
typeName | String | Device Type Name | None | 2.0.0 |
userGroup | List<GroupsItem> | User Group | None | 2.0.0 |
guestGroup | List<GroupsItem> | Guest Group | None | 2.0.0 |
typeId | int | Device TypeID | None | 2.0.0 |
name | String | Device Name | None | 2.0.0 |
description | String | Device Description Info | None | 2.0.0 |
location | String | Device Location | None | 2.0.0 |
id | int | Device ID | None | 2.0.0 |
state | int | Device State | 1 - Online, 0-Offline | 2.0.0 |
direction | int | Device In and Out Direction | 0-Default, 1-In, 2-Out | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
companyId | int | Device Company ID | None | 2.0.0 |
serviceConfig | List<ServiceConfigItem> | Server Configuration | None | 2.0.0 |
typeId | int | Device Type ID | None | 2.0.0 |
maxOnlineNum | int | Device Max Online Number | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
name | String | Device Name | None | 2.0.0 |
options | List<Options> | Customized Options | None | 2.0.0 |
id | String | Device ID | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
text | String | Text String | None | 2.0.0 |
value | String | Corresponding Content | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
guestGroupId | int | Guest Group ID | None | 2.0.0 |
validFrom | String | Valid From | None | 2.0.0 |
createBy | String | Creator ID | None | 2.0.0 |
background | String | Background | None | 2.0.0 |
contact | String | Contact | None | 2.0.0 |
validTo | String | Valid To | None | 2.0.0 |
name | String | Company Name | None | 2.0.0 |
updateAt | String | Update Time | None | 2.0.0 |
logo | String | Company logo | None | 2.0.0 |
id | int | Company ID | None | 2.0.0 |
createAt | String | Create Time | None | 2.0.0 |
welcome | String | Welcome Message | None | 2.0.0 |
introduction | String | Company Introduction | None | 2.0.0 |
userGroupId | int | User Group ID | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
empoent | String | e1 | None | 2.0.0 |
module | String | Product of prime numbers | None | 2.0.0 |
rsaId | String | Key ID | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
birthday | String | Birthday | None | 2.0.0 |
icNumber | String | IC Care Number | None | 2.0.0 |
entryTime | String | Entry Time | None | 2.0.0 |
idNumber | String | ID Number | None | 2.0.0 |
String | None | 2.0.0 |
areaCode | String | Area Code | None | 2.0.0 |
phoneSuffix | String | Mobile Number Suffix | None | 2.0.0 |
mobile | String | Mobile Number | None | 2.0.0 |
groups | List<GroupsItem> | Group Info | None | 2.0.0 |
remark | String | Remark | None | 2.0.0 |
avatar | String | Avatar ID | None | 2.0.0 |
avatarShow | String | Art Photo ID | None | 2.0.0 |
countryCode | String | Country Code | None | 2.0.0 |
name | String | User Name | None | 2.0.0 |
location | String | Location | None | 2.0.0 |
departmentRoute | List<DeptItem> | Department | None | 2.0.0 |
id | long | User ID | None | 2.0.0 |
position | String | Position | None | 2.0.0 |
jobNumber | String | job Number | None | 2.0.0 |
placeCode | String | Place Code | None | 2.0.0 |
department | int | Department ID | None | 2.0.0 |
prompt | String | Personalized Prompt | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
name | String | Department Name | None | 2.0.0 |
id | int | Department ID | None | 2.0.0 |
type | int | Department Type | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
date | String | Date | for example 20190815 | 2.0.0 |
edition | String | Edition | for example 1.11.0.2 | 2.0.0 |
provider | String | Provider | ST-BI, ST-JCV | 2.0.0 |
product | String | Product Name | SenseLink, SenseLink GE | 2.0.0 |
coreEdition | String | core Edition | None | 2.0.0 |
appEdition | String | Show app Edition | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
id | long | Access Strategy ID | None | 2.0.0 |
ruleId | long | Rule ID | None | 2.0.0 |
name | String | Pass Time Table Name | None | 2.0.0 |
groupId | int | Pass Group ID | None | 2.0.0 |
monday | String | Monday 24h Access Strategy | None | 2.0.0 |
mondayPeriod | String | Monday Pass Time Period | None | 2.0.0 |
tuesday | String | Tuesday 24h Access Strategy | None | 2.0.0 |
tuesdayPeriod | String | Tuesday Pass Time Period | None | 2.0.0 |
wednesday | String | Wednesday 24h Access Strategy | None | 2.0.0 |
wednesdayPeriod | String | Wednesday Pass Time Period | None | 2.0.0 |
thursday | String | Thursday 24h Access Strategy | None | 2.0.0 |
thursdayPeriod | String | Thursday Pass Time Period | None | 2.0.0 |
friday | String | Friday 24h Access Strategy | None | 2.0.0 |
fridayPeriod | String | Friday Pass Time Period | None | 2.0.0 |
saturday | String | Saturday 24h Access Strategy | None | 2.0.0 |
saturdayPeriod | String | Saturday Pass Time Period | None | 2.0.0 |
sunday | String | Sunday 24h Access Strategy | None | 2.0.0 |
sundayPeriod | String | Sunday Pass Time Period | None | 2.0.0 |
holiday | String | Holiday 24h Access Strategy | None | 2.0.0 |
holidayPeriod | String | Holiday Pass Time Period | None | 2.0.0 |
startTimestamp | long | Start Timestamp | millisecond precision | 2.0.0 |
endTimestamp | long | End Timestamp | millisecond precision | 2.0.0 |
specialDayList | List<SpecialDay> | Special Date | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
id | long | Special Date Id | None | 2.0.0 |
date | String | Date | None | 2.0.0 |
remark | String | Note | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
entryTimeLeft | int | Number of Passes Remaining | None | 2.0.0 |
entryHint | String | Entry Hint | None | 2.0.0 |
idNumber | String | ID Number | None | 2.0.0 |
userId | int | User ID | None | 2.0.0 |
userImage | Content | User Library Image | None | 2.0.0 |
userCardId | String | User Door Access Card ID | None | 2.0.0 |
userName | String | User Name | None | 2.0.0 |
entryStatus | int | Status code | 1-Pass; 2-QR code illegal; 3-QR code decryption failed; 4-QR code content error; 5-QR code invalid; 6-QR code is not within the validity period; 7-QR code has no passes; 8-The user corresponding to the QR code is invalid | 2.0.0 |
sign | String | md5 | The md5 Value of {entryStatus}-{timestamp}-{ldid}-{userId}-{passRuleType} | 2.0.0 |
type | int | User Type | 1:Staff; 2:Guest;3:Stranger; 4:Non-liveness; 5-denyList | 2.0.0 |
timestamp | long | Timestamp Uploaded by the Client | None | 2.0.0 |
passRuleType | int | Pass Rule Type | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced | Is it necessary |
content | String | QR Code Content | None | 2.0.0 | Y |
timestamp | long | Timestamp | None | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced |
defaultUserGroupId | int | default User Group ID | None | 2.0.0 |
role | int | Role | None | 2.0.0 |
companyId | int | Company ID | None | 2.0.0 |
defaultGuestGroupId | int | default User Group ID | None | 2.0.0 |
threshold | int | Face Detection Threshold | None | 2.0.0 |
newDeviceKey | boolean | New Device | None | 2.0.0 |
token | String | Token | None | 2.0.0 |
deviceTypeMaxOnline | DeviceTypeMaxOnline | Maximum online device information | None | 2.0.0 |
accountId | int | Account ID | None | 2.0.0 |
name | String | Name | None | 2.0.0 |
userRspVO | UserRspVO | User Info | None | 2.0.0 |
company | Company | Company Info | None | 2.0.0 |
lang | String | Language | None | 2.0.0 |
device | Device | Device Info | None | 2.0.0 |
account | String | Account Name | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
birthday | String | Birthday | None | 2.0.0 |
icNumber | String | IC Number | None | 2.0.0 |
entryTime | String | entry Time | None | 2.0.0 |
idNumber | String | ID Number | None | 2.0.0 |
String | None | 2.0.0 |
areaCode | String | Place Code | None | 2.0.0 |
phoneSuffix | String | Mobile Number Suffix | None | 2.0.0 |
mobile | String | Mobile Number | None | 2.0.0 |
groups | List<GroupsItem> | User Group ID | None | 2.0.0 |
remark | String | Note | None | 2.0.0 |
avatar | String | Avatar ID | None | 2.0.0 |
avatarShow | String | Art Photo ID | None | 2.0.0 |
countryCode | String | Country Code | None | 2.0.0 |
name | String | Name | None | 2.0.0 |
departmentRoute | List<DepartmentRouteItem> | Department | None | 2.0.0 |
location | String | Location | None | 2.0.0 |
id | Integer | User ID | None | 2.0.0 |
jobNumber | String | Job Number | None | 2.0.0 |
placeCode | String | Area Code | None | 2.0.0 |
position | String | Position | None | 2.0.0 |
department | Integer | Department ID | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
name | String | Department Name | None | 2.0.0 |
id | int | Department ID | None | 2.0.0 |
type | int | Department Type | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
ldid | String | Device UDID | None | 2.0.0 |
companyId | int | Device Compay ID | None | 2.0.0 |
typeId | int | Device Type | None | 2.0.0 |
name | String | Device Name | None | 2.0.0 |
updateAt | String | Update Time | None | 2.0.0 |
description | String | Description | None | 2.0.0 |
location | String | Device Location | None | 2.0.0 |
id | int | Device ID | None | 2.0.0 |
softwareVersion | String | Device Software Version | None | 2.0.0 |
createAt | String | Create Time | None | 2.0.0 |
direction | int | Device In and Out Direction | None | 2.0.0 |
info | String | Info | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
recordId | String | identification record id | None | 2.0.0 |
type | int | Misrecognition Type | 1 Other person, 2 Stranger, 3 Non-liveness, 4 Stranger Break, 5 Non-liveness Break | 2.0.0 |
content | String | Remark | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
ldid | String | Device LDID | None | 2.0.0 |
companyId | int | Device Compay ID | None | 2.0.0 |
typeId | int | Device TypeID | None | 2.0.0 |
name | String | Device Name | None | 2.0.0 |
updateAt | String | Update Time | None | 2.0.0 |
description | String | Device Description | None | 2.0.0 |
location | String | Device Location | None | 2.0.0 |
id | int | Device ID | None | 2.0.0 |
softwareVersion | String | Device Software Version | None | 2.0.0 |
createAt | String | Create Time | None | 2.0.0 |
direction | int | Device In and Out Direction | None | 2.0.0 |
info | String | Device Info | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced | Is it necessary |
name | String | Device Name | None | 2.0.0 | Y |
direction | int | Device Direction | 0-Default, 1-In, 2-Out | 2.0.0 | Y |
location | String | Device Location Description | None | 2.0.0 | N |
description | String | Device Description | None | 2.0.0 | N |
softwareVersion | String | Software Version | None | 2.0.0 | N |
info | String | Other Info | None | 2.0.0 | N |
Member | Type | Description | Note | Version Introduced |
exceptionList | List<ExceptionListItem> | Exception List | None | 2.0.0 |
verifyModelVersion | String | Verify Model Version | None | 2.0.0 |
totalUserCount | int | Total User Count | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
code | int | Status Code | None | 2.0.0 |
userId | int | User ID | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced | Is it necessary |
statusList | List<UserStatusListItem> | User Status List | None | 2.0.0 | Y |
verifyModelVersion | String | Verify Model Version | None | 2.0.0 | Y |
totalUserCount | int | Total User Count | None | 2.0.0 | Y |
action | int | Type | 0-Upload the Status of All Device Users, 1-Upload the Status of Abnormal Device Users | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced |
status | int | Status Code | 1-Synchronizing, 2-Features Normal, 3-Image download failed, 4-Image parsing failed, 5-Feature extraction failed | 2.0.0 |
userIds | int[] | User ID Arrays | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced | Is it necessary |
type | int | Event Type | 1-Door Magnetism Event; 2-Bluetooth power; 3-Thermal Imager Status | 2.0.0 | Y |
content | BaseDeviceReportEventContent | content corresponding to the event | 1: DoorMagnetismReportEventContent, 2: BluetoothReportEventContent, 3: ThermalImagerReportEventContent | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced | Is it necessary |
status | int | Event Status | 1-ON, 2-OFF, 3-No | 2.0.0 | Y |
timestamp | long | Event Time | millisecond precision | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced | Is it necessary |
power | int | Power Remained | 0-100 | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced | Is it necessary |
status | int | Event Status | 0-Unknown, 1-Connected, 2-Unconnected | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced |
recordId | String | RecordID | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced | Is it necessary |
userId | int | User ID | None | 2.0.0 | N |
username | String | User Name | None | 2.0.0 | N |
signAvatar | String | Facial Image | None | 2.0.0 | N |
signBgAvatar | String | Background Image | None | 2.0.0 | N |
signTime | long | Clock Time | None | 2.0.0 | Y |
type | int | Personnel Type | 1:Staff; 2:Guest; 3: Stranger; 4: Non Liveness; 999: Others | 2.0.0 | Y |
abnormalType | int | Abnormal Record Type | 0-No; 10001-Person and ID mismatch;10002-Person and Card mismatch;10003-Person and Code mismatch;20001-The guest is not within the validity period; 20002-Not within the passable time range; 30001-Invalid id card; 30002-Invalid IC Card; 30003-Invalid QR Code | 2.0.0 | N |
idNumber | String | ID Number | None | 2.0.0 | N |
icNumber | String | work card | None | 2.0.0 | N |
idInfo | String | other information of ID card | Json String | 2.0.0 | N |
inTime | int | Whether uploaded timely | Yes: 1; No: 0 | 2.0.0 | Y |
mode | int | Device Mode | 1: Swipe Face or Card; 2: Swipe Face+Card; 3: Swipe Face or ID Card; 4: Swipe Face+ID Card; 5: Swipe Face+ID Card for Appointment; 6: Swipe Face or QR Code; 7: Swipe Face and QR Code; 8: Bluetooth; 9: Face; 10: Face or QR Code or Swipe Card | 2.0.0 | Y |
rectangle | List<VerticesItem> | rectangle | Coordinates of the upper left corner, coordinates of the lower right corner | 2.0.0 | N |
entryMode | int | Entry Mode | 1: Swipe Face; 2: QR Code; 3: Swipe Card; 4: Swipe Face+Card; 5: Swipe ID Card; 6: Swipe Face+ID Card; 7: Swipe Face+ID Card for Appointment; 8: Swipe Face and QR Code; 9: Bluetooth | 2.0.0 | N |
pushOption | int | Push Record | 1, Yes, 0 No | 2.0.0 | N |
wearMaskType | int | Mask Status | 0: No Status (Mask Identification not activated) 1: Without Mask 2: With Mask | 2.0.0 | N |
verifyScore | float | Verify Score | None | 2.0.0 | N |
docPhoto | String | ID card photo | None | 2.0.0 | N |
heatAvatar | String | thermodynamic diagram | None | 2.0.0 | N |
bodyTemperature | float | Body Temperatur | None | 2.0.0 | N |
remark | String | Note | None | 2.0.0 | N |
Member | Type | Description | Note | Version Introduced | Is it necessary |
apkVersionName | String | apk Version Name | None | 2.0.0 | Y |
romHardwareVersion | String | ROM Hardware Version | None | 2.0.0 | Y |
apkVersionCode | String | apk Version Code | None | 2.0.0 | Y |
packageName | String | package Name | None | 2.0.0 | Y |
model | String | Model | None | 2.0.0 | Y |
serialNumber | String | Device serial Number | None | 2.0.0 | Y |
romSoftwareVersion | String | ROM Software Version | None | 2.0.0 | Y |
manufacturer | String | manufacturer | None | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced |
images | List<ImagesItem> | Data | None | 2.0.0 |
depth | Depth | Depth Data | None | 2.0.0 |
userId | int | User ID | None | 2.0.0 |
recordId | int | Recordid | None | 2.0.0 |
type | int | Data Type | 1-In the Library, 2-Stranger, 3-Liveness, 4-Non-liveness | 2.0.0 |
Member | Type | Description | Note | Version Introduced |
data | String | Depth Data Content | None | 2.0.0 |
width | int | Depth Data Width | None | 2.0.0 |
height | int | Depth Data Height | None | 2.0.0 |
Member | Type | Description | Note | Version Introduced | Is it necessary |
content | String | Tsl json String | None | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced | Is it necessary |
content | String | Language Package Content | None | 2.0.0 | Y |
lang | String | Language | en,zh,zh-tw | 2.0.0 | Y |
Member | Type | Description | Note | Version Introduced |
mobile | String | Mobile Number | None | 2.0.0 |
areaCode | String | Area Code | None | 2.0.0 |
event | MessageEventEnum | Event | None | 2.0.0 |
captcha | String | authentication code | None | 2.0.0 |
Member | Description | Note | Version Introduced |
LOGIN | Login | None | 2.0.0 |
CHANGE_INFO | Change Info | None | 2.0.0 |
VALIDATE | Validate | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void onConnectionLost(Throwable cause) | Callback on Connection Lost | None | 2.0.0 |
Member Function | Description | Note | Version Introduced |
void success(MqttMessage msg) | Callback on Receiving Message | None | 2.0.0 |
void error(int code, String msg, Throwable throwable) | Callback on Failure | None | 2.0.0 |
Member Function | Description | Version Introduced |
int delete(int userId) | Delete face feature of user id | 2.0.0 |
byte[] getFeature( Bitmap avatar) | Get face feature of the image | 2.0.0 |
int insert(int userId, byte[] feature) | Insert feature library | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
userId | int | Face feature ID | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
avatar | Bitmap | Clear image of the face for a single person | None | 2.0.0 |
Parameter Name | Type | Description | Note | Version Introduced |
userId | int | Face feature ID | None | 2.0.0 |
feature | byte[] | Face feature byte array | None | 2.0.0 |
Initialize LinkSDK, set network request parameters
Get CA Verification
Parameter
None
Return
Exception
None
Get Connect Timeout
Parameter
None
Return
Connect Timeout (millisecond precision)
Exception
None
Get Read Timeout
Parameter
None
Return
Read Timeout (millisecond precision)
Exception
None
Get Write Timeout
Parameter
None
Return
Write Timeout (millisecond precision)
Exception
No
Add Interceptor
Parameter
Return
Current Object
Exception
None
Get Language Type
Parameter
None
Return
LanguageTypeEnum
Exception
None
Initialize
Parameter
Return
Current Object
Exception
None
Set URL
Parameter
Return
Current Object
Exception
None
set CA Verification
Parameter
Return
Current Object
Exception
None
Set Connect Timeout
Parameter
Return
Current Object
Exception
None
Set read timeout
Parameter
Return
Current Object
Exception
None
Set Write timeout
Parameter
Return
Current Object
Exception
None
BatchAdd interceptors
Parameter
Return
Current Object
Exception
None
Get Interceptor List
Parameter
None
Return
Interceptor List
Exception
None
Set Language Type
Parameter
Return
Current Object
Exception
None
Get URL
Parameter
None
Return
Server Address
Exception
None
Member Function
Description
Version Introduced
boolean isCAVerify()
get CA Verification
2.0.0
int getConnectTimeout()
get Connect Timeout
2.0.0
int getReadTimeout()
get Read Timeout
2.0.0
int getWriteTimeout()
get Write Timeout
2.0.0
LinkSDKHelper addInterceptor(Interceptor interceptor)
add Interceptor
2.0.0
LanguageTypeEnum getLanguageType()
get Language Type
2.0.0
LinkSDKHelper init(String url,Context context)
Initialization
2.0.0
LinkSDKHelper setUrl(String url)
Set URL
2.0.0
LinkSDKHelper setCAVerify(boolean caVerify)
set CA Verification
2.0.0
LinkSDKHelper setConnectTimeout(int connectTimeout)
set Connect Timeout
2.0.0
LinkSDKHelper setReadTimeout(int readTimeout)
set Read Timeout
2.0.0
LinkSDKHelper setWriteTimeout(int writeTimeout)
set Write Timeout
2.0.0
LinkSDKHelper setInterceptorList(List interceptorList)
Batch Add Interceptor
2.0.0
List getInterceptorList()
get Interceptor List
2.0.0
LinkSDKHelper setLanguage(LanguageTypeEnum type)
set Language Type
2.0.0
String getUrl()
Get URL
2.0.0
Returned Value
Description
Version Introduced
true
All network connections will verify the CA certificate
2.0.0
false
All network connections will not verify the CA certificate
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
interceptor
Interceptor
Interceptor
okhttp Interceptor
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
url
String
server address
None
2.0.0
context
Context
Context
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
url
String
server address
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
caVerify
boolean
set CA Verification
None
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
connectTimeout
int
Connect Timeout
millisecond precision
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
readTimeout
int
read Timeout
millisecond precision
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
writeTimeout
int
write Timeout
millisecond precision
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
interceptorList
List
Interceptor List
Okhttp Interceptor
2.0.0
Parameter Name
Type
Description
Note
Version Introduced
type
LanguageTypeEnum
Language Type
None
2.0.0