# Visionkit-SampleCode-interactiveLivenessDemo-ArkTS

**Repository Path**: bookcube/visionkit-sample-code-arkts

## Basic Information

- **Project Name**: Visionkit-SampleCode-interactiveLivenessDemo-ArkTS
- **Description**: 本示例展示了人脸活体检测能力、卡证识别能力和文档扫描能力。
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 4
- **Created**: 2024-11-05
- **Last Updated**: 2024-11-05

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# 人脸活体检测控件

## 介绍

本示例展示了使用视觉类AI能力中的人脸活体检测能力。

本示例模拟了在应用里，跳转人脸活体检测控件，获取到检测结果并展示出来。

需要使用人脸活体检测接口@kit.VisionKit.d.ts。

## 效果预览

|         **主窗口**          |                 **开始检测**                  |           **检测成功**           |          **检测失败**           |         **检测结果成功**          |            **检测结果失败**             |
|:------------------------:|:-----------------------------------------:|:----------------------------:|:---------------------------:|:---------------------------:|:---------------------------------:|
| ![](screenshots/app.png) | ![](screenshots/interactionDetection.png) | ![](screenshots/success.png) | ![](screenshots/failed.png) | ![](screenshots/resultSuccess.png) | ![](screenshots/resultFailed.png) | 

使用说明：

1. 在手机的主屏幕，点击”faceDetectionDemo“，启动应用。
2. 点击“Start detection”按钮，进入人脸活体检测控件。
3. 检测结束后获取到检测结果并展示出来。


## 工程目录

```
├─entry/src/main/ets                         // 代码区  
│  ├─entryability
│  │  └─EntryAbility.ets                     // 入口Ability
│  └─pages
│     └─Index.ets                            // 主页界面
└─screenshots                                // 截图
```

## 具体实现

本示例展示的控件在@kit.VisionKit.d.ts定义了人脸活体检测API：
```ts
/**
 * Entry to the face liveness detection page.
 *
 * @permission ohos.permission.CAMERA
 * @param { InteractiveLivenessConfig } config detection configuration item.
 * @returns { Promise<boolean> } Result of entering the liveness detection control.
 * @throws { BusinessError } 1008301002 Route switching failed.
 * @syscap SystemCapability.AI.Component.LivenessDetect
 * @atomicservice
 * @since 5.0.0(12)
 * */
function startLivenessDetection(config: InteractiveLivenessConfig): Promise<boolean>;

/**
 * Obtains the face and liveness detection result.
 *
 * @returns { Promise<InteractiveLivenessResult> } The results of the liveness test.
 * @throws { BusinessError } 1008302000 Detection algorithm initialization.
 * @throws { BusinessError } 1008302001 Detection timeout.
 * @throws { BusinessError } 1008302002 Action mutual exclusion error.
 * @throws { BusinessError } 1008302003 Continuity Check Failure.
 * @throws { BusinessError } 1008302004 The test is not complete.
 * @syscap SystemCapability.AI.Component.LivenessDetect
 * @atomicservice
 * @since 5.0.0(12)
 * */
function getInteractiveLivenessResult(): Promise<InteractiveLivenessResult>;
```

业务使用时，需要先进行import导入interactiveLiveness。
调用进入活体控件接口和检测结果接口，接收处理返回的结果。参考entry/src/main/ets/pages/Index.ets.

## 相关权限

ohos.permission.CAMERA。

## 依赖

不涉及。

## 约束与限制

1. 本实例仅支持标准系统上运行，支持设备：华为手机、华为平板。
2. HarmonyOS系统：HarmonyOS NEXT Developer Beta1及以上。
3. DevEco Studio版本：DevEco Studio NEXT Developer Beta1及以上。
4. HarmonyOS SDK版本：HarmonyOS NEXT Developer Beta1 SDK及以上。