# arcsoft-idcard

> Arcsoft IdcardVeri Engine

Latest version **1.0.4** (published 2020-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install arcsoft-idcard
pnpm add arcsoft-idcard
yarn add arcsoft-idcard
bun add arcsoft-idcard
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2020-12-26 |
| First published | 2020-12-25 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 12.0 |
| Dependencies | 4 |
| Unpacked size | 13.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | LiuPeng |
| Maintainers | laoshu1997 |
| Keywords | face-idcard-compare |

## Links

- npm: https://www.npmjs.com/package/arcsoft-idcard
- Repository: https://github.com/Liupeng8/arcsoft-idcard
- Homepage: https://github.com/Liupeng8/arcsoft-idcard#readme
- Issues: https://github.com/Liupeng8/arcsoft-idcard/issues
- npm.io page: https://npm.io/package/arcsoft-idcard

## Dependencies (4)

- [jimp](https://npm.io/package/jimp.md) ^0.16.1
- [ffi-napi](https://npm.io/package/ffi-napi.md) ^3.1.0
- [ref-napi](https://npm.io/package/ref-napi.md) ^3.0.1
- [ref-array-di](https://npm.io/package/ref-array-di.md) ^1.2.2

## Alternatives

- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads

## Recent versions

- 1.0.4 (latest) — 2020-12-26
- 1.0.3 — 2020-12-26
- 1.0.2 — 2020-12-25
- 1.0.1 — 2020-12-25
- 1.0.0 — 2020-12-25

## README

# Arcsoft-Idcard
### Arcsoft Idcard Cognition Engine.

 [Arcsoft](http://www.arcsoft.com.cn/ai/arcface.html) is a __Face Cognition Engine__, which contains __Face Detection__, __Face Recognition__, __Face Tracking__ and __Idcard Compare__. 

This module is a __Non-Official__ wrapper of ArcFace C++ SDK used for nodejs.

## Installation
Step 1
install windows-build-tools
```bash
$ npm i -g windows-build-tools
```

Step 2
with npm
```bash
$ npm install arcsoft-idcard --save
```
or with yarn
```bash
$ yarn add arcsoft-idcard
```

## TODO

```
const path = require('path');
const IdCard = require('../lib');

const idcard = new IdCard();

(async function () {
  try {
    const activeRes = idcard.onlineActive({
      appId: 'BQxjZiDZuxi5Yyyx74GpddjyDw4EefRYjdsxmnD8aARa',
      sdkKey: '6QD8ib78kHtWhnREBvtC1ArWmsa6xhdAibzQwKL5qEdx'
    })
    console.log(activeRes)

    const initRes = idcard.initEngine()
    console.log(initRes)

    const compareRes = idcard.faceIdcardCompare({
      type: 0, // 1:视频，0:图片
      threshold: 0.82, // 比对阈值
      idcardData: await idcard.parseImage(path.join(__dirname, './img/f1.jpg')),
      faceData: await idcard.parseImage(path.join(__dirname, './img/f2.jpg'))
    })
    console.log(compareRes)

    const uninitRes = idcard.uninitialEngine()
    console.log(uninitRes)

  } catch (err) {
    console.error(err);
  }
})();
```

## License

MIT

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