# yitu-face

> face sdk

Latest version **1.0.3** (published 2020-09-04) · ISC license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install yitu-face
pnpm add yitu-face
yarn add yitu-face
bun add yitu-face
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 1.0.3 |
| Published | 2020-09-04 |
| First published | 2020-09-04 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 991.5 KB |
| Known vulnerabilities | 0 (+25 in 1 direct dependencies) |
| Install scripts | no |
| Author | Leo |
| Maintainers | gc767781724 |

## Links

- npm: https://www.npmjs.com/package/yitu-face
- npm.io page: https://npm.io/package/yitu-face

## Dependencies (2)

- [axios](https://npm.io/package/axios.md) ^0.20.0
- [@types/axios](https://npm.io/package/@types/axios.md) ^0.14.0

## Recent versions

- 1.0.3 (latest) — 2020-09-04
- 1.0.2 — 2020-09-04
- 1.0.1 — 2020-09-04

## README

# 人脸活检web

## 注意事项

部署项目时请使用https域名，由于http不受浏览器信任，无法打开摄像头进行人脸捕捉
拉去代码后 记得```npm install```拉取依赖包。

## sdk打包命令

```node
yarn build
//or
npm run build
```

## 本地运行

注意事项1：本地运行时，访问localhost页面比对接口会受到跨域影响，请使用本机ip进行访问，已在webpack配置代理
注意事项2：由于http不浏览器信任，无法打开摄像头，可以在chrome浏览器地址栏输入 ```chrome://flags/```， 搜索 ```unsafely```，enabled 并填入要授信的域名，PC和移动端一致。
![avatar](https://upload-images.jianshu.io/upload_images/8722346-840f0f853b24d129.png?imageMogr2/auto-orient/strip|imageView2/2/w/1200/format/webp)

```node
yarn dev
//or
npm run dev
```

## 打包demo

此命令会将example文件下的示例页面打包展示出来

```node
yarn build:demo
//or
npm run build:demo
```

## 活检接口

| FaceView       | FaceDetection |
|----------------|---------------|
| 人脸识别UI插件 | 人脸识别接口  |

### FaceView 调用示例代码

```javascript

const face=new FaceView(options);
face.onReset();
face.onClose();

```

### FaceView Api

| 参数    | 功能         | 是否必传 | 参数类型     | 其它                    |
|---------|------------|---------|--------------|-------------------------|
| parent  | 父级dom      | 否       | HTMLElement  | 不传父级，默认插入body下 |
| apiUrl  | 比对接口地址 | 是       | string       | 必传参数                |
| success | 识别完成回调 | 否       | (void)=>void | void返回比对结果        |
| option  | 配置参数     | 否       | option       | -                       |

#### FaceView Option Api

| width            | height           | matchedScore | spacing              | lineWidth  | barColor   |
|------------------|------------------|--------------|----------------------|------------|------------|
| 人脸识别区域宽度 | 人脸识别区域高度 | 辨识级别0-1  | 人脸区域和进度条间隙 | 进度条宽度 | 进度条颜色 |

#### FaceView 方法

| onReset  | onClose              |
|----------|----------------------|
| 重新识别 | 关闭摄像头和人脸识别 |

### FaceDetection 调用示例代码

```javascript
new FaceDetection({
    dom: { videoDom: document.querySelector('.face_video') },
    callBack: (task)=>{console.log(task)}
});
```

### FaceDetection Api

| 参数         | 功能                  | 是否必传 | 参数类型     | 其它                 |
|--------------|---------------------|---------|--------------|----------------------|
| dom          | 人脸识别需要video标签 | 是       | DomType      | -                    |
| matchedScore | 人脸识别级别          | 否       | number       | -                    |
| callback     | 识别回调              | 否       | (task)=>void | task会返回识别的信息 |

#### DomType

| 参数      | 类型              | 是否必传 | 其它                          |
|-----------|-------------------|---------|-------------------------------|
| videoDom  | HTMLVideoElement  | 是       | -                             |
| canvasDom | HTMLCanvasElement | 否       | 传入canva会在识别时添加人脸框 |

---
_Source: https://npm.io/package/yitu-face · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._