Identify Manager
Support Human Face 1:1 Verification, Local 1:N Identification, Server 1:N Identification and Face Mask Detection.
Description of functional types
IdentifyManager
Entrance for the Identify Manager
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 |
Description of Member Function
boolean setIdentifyTarget(Bitmap avatar)
Set Individual Identification Feature
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
avatar | Bitmap | Individual ID Photo | None | 2.0.0 |
Return
Returned Value | Description | Note | Version Introduced |
true | Set Success | None | 2.0.0 |
false | Set Fail | None | 2.0.0 |
Exception
None
ImageConfig getImageConfig()
Get Image Configuration
Parameter
None
Return
ImageConfig
Exception
None
IdentifyConfig getIdentifyConfig()
Get Identify Manager Workflow Configuration
Parameter
None
Return
IdentifyConfig
Exception
None
ThresholdConfig getThresholdConfig()
Get Threshold Configuration
Parameter
None
Return
ThresholdConfig
Exception
None
void addFaceFilterInterceptor(IFaceFilterInterceptor faceFilterInterceptor)
Add Face Filter Interceptor
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
faceFilterInterceptor | IFaceFilterInterceptor | Face Filter Interceptor | None | 2.0.0 |
Return
None
Exception
None
void handleRgbData(byte[] data)
Handle rgb Data
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
data | byte[] | Image Data | None | 2.0.0 |
Return
None
Exception
None
void handleIrData(byte[] data)
Handle irb Data
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
data | byte[] | Image Data | None | 2.0.0 |
Return
None
Exception
None
void handleTemperatureData(Bitmap temperatureBitmap,float[] temperatureValue, int width, int height, FaceOrientation temperatureOrientation)
Handle Thermodynamic Diagram and Related Data
Parameter
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 |
Return
None
Exception
None
void init(ImageConfig imageConfig, IIdentifyResultCallback identifyResultCallback)
Initialize
Parameter
Type | Parameter Name | Description | Note | Version Introduced |
ImageConfig | imageConfig | Image Configuration | None | 2.0 |
IIdentifyResultCallback | identifyResultCallback | Identification Result Callback | None | 2.0.0 |
Return
None
Exception
None
void pause()
Pause Face Identification
Parameter
None
Return
None
Exception
None
void resume()
Resume Face Identification
Parameter
None
Return
None
Exception
None
void release()
Release Resource
Parameter
None
Return
None
Exception
None
void removeFaceFilterInterceptor(IFaceFilterInterceptor faceFilterInterceptor)
Remove Face Filter Interceptor
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
faceFilterInterceptor | IFaceFilterInterceptor | Face Filter Interceptor | None | 2.0 |
Return
None
Exception
None
void removeIdentifyTarget()
Remove the Set Individual Identification Feature
Parameter
None
Return
None
Exception
None
void start()
Start Identification
Parameter
None
Return
None
Exception
None
void stop()
Stop Identification
Parameter
None
Return
None
Exception
None
void setIdentifyCallback(IIdentifyResultCallback iIdentifyCallback)
Set Identification Result Callback
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
iIdentifyCallback | IIdentifyResultCallback | Identification Result Callback | None | 2.0 |
Return
None
Exception
None
void setVerifyMode(VerifyModeEnum verifyMode)
Set the Verification Mode for the Identification Manager
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
verifyMode | VerifyModeEnum | Verification Mode | None | 2.0 |
Return
None
Exception
None
void setThresholdConfig(ThresholdConfig thresholdConfig)
Set Threshold Configuration
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
thresholdConfig | ThresholdConfig | Threshold Configuration | None | 2.0 |
Return
None
Exception
None
void setIdentifyConfig(IdentifyConfig identifyConfig)
Set Identification Manager Workflow Configuration
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
identifyConfig | IdentifyConfig | Identification Manager Workflow Configuration | None | 2.0 |
Return
None
Exception
None
void setServerVerifyAction(IServerVerifyAction serverVerifyAction)
Set Server Verification Logic
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
serverVerifyAction | IServerVerifyAction | Server Verification Logic | None | 2.0 |
Return
None
Exception
None
void setTemperatureSdkAction(ITemperatureSdkAction temperatureSdkAction)
Set Temperature Measurement Sdk Action
Parameter
Parameter Name | Type | Description | Note | Version Introduced |
temperatureSdkAction | ITemperatureSdkAction | Temperature Measurement Sdk Action | None | 2.0 |
Return
None
Exception
None
Description of Entities
ImageConfig
Description of Properties
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 |
MidPixelFormat
Description of Properties
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 |
FaceOrientation
Description of Properties
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 |
IdentifyConfig
Description of Properties
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 |
ThresholdConfig
Description of Properties
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 |
IFaceFilterInterceptor
Description of Method
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 |
FaceInfo
Description of Properties
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 |
VerifyModeEnum
Description of Properties
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 |
IIdentifyResultCallback
Description of Method
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 |
FaceFilterResult
Description of Properties
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 |
AttributeFilterResult
Description of Properties
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 |
AttributeResult
Description of Properties
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 |
FrameIdentifyResult
Description of Properties
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 |
FaceIdentifyResult
Description of Properties
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 |
TrackAndTemperatureResult
Description of Properties
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 |
IdentifyResultTypeEnum
Description of Properties
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 |
FaceSearchResult
Description of Properties
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 |
IServerVerifyAction
Description of Method
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 |
ITemperatureSdkAction
Description of Properties
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 |
Last updated