Commit 0144779a by Chokmongkhon Jansanom

chore: add readme.

parent 28eeb459
......@@ -2,14 +2,47 @@
Connect luxand made easy.
## Getting Started
### Face enrollment
This project is a starting point for a Flutter
[plug-in package](https://flutter.dev/developing-packages/),
a specialized package that includes platform-specific implementation code for
Android and/or iOS.
```
EnrollFace(
licenseKey: Env.luxandLicenseKey,
onFinish: (templates) {
Get.off(LivenessPage(templates: templates));
},
)
```
For help getting started with Flutter development, view the
[online documentation](https://flutter.dev/docs), which offers tutorials,
samples, guidance on mobile development, and a full API reference.
| Parameter Name | Description | Default value |
|------------------------|---------------------------------------------------------|-----------------------|
| licenseKey | Luxand license key | None |
| imageStreamMilliSecond | Capture image every this value and send image to luxand | 100 ms |
| templateCount | Total template for this enrollment | 3 |
| topMessage | Display message that show on top of face rectangle | 'Please touch screen' |
### Active liveness detection
```
ActiveLivenessVerifier(
licenseKey: Env.luxandLicenseKey,
onFinish: (success, template) {},
)
```
| Parameter Name | Description | Default value |
|------------------------|---------------------------------------------------------------------------------------------------------------------------------------------|---------------|
| licenseKey | Luxand license key | None |
| imageStreamMilliSecond | Capture image every this value and send image to luxand | 200 ms |
| failAcceptableInSecond | Widget will finish and return false if luxand cannot detect face in picture in 1 / imageStreamInMillisecond / 1000 x failAcceptableInSecond | 3 s |
### Matching face template
:warning: this widget can match template but not yet send data to user (in development).
```
MatchTemplateScanner(
licenseKey: Env.luxandLicenseKey,
templates: con.templates,
onFinish: (success, template) {},
)
```
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment