Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Michaël Villeneuve committed Jul 19, 2017
1 parent 44fa7e2 commit 80cf96f
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,18 +65,18 @@ class YourComponent extends Component {
| contrast | `1` | `float` | Increase or decrease camera contrast. Normal as default |

## Each rectangle detection
| Prop | Params | Type | Description |
| :------ | :------: | :--------:| :--------|
| onRectangleDetect | `{ stableCounter, lastDetectionType }` | `object` | See below |
| Props | Params | Type | Description |
|-------------------|----------------------------------------|----------|-------------|
| onRectangleDetect | `{ stableCounter, lastDetectionType }` | `object` | See below |

The returned object includes the following keys :

`stableCounter`
---
- `stableCounter`

Number of correctly formated rectangle found (this number triggers capture once it goes above `detectionCountBeforeCapture`)

`lastDetectionType`
---
- `lastDetectionType`

Enum (0, 1 or 2) corresponding to the type of rectangle found
0. Correctly formated rectangle
1. Wrong perspective, bad angle
Expand All @@ -86,7 +86,7 @@ Enum (0, 1 or 2) corresponding to the type of rectangle found
## Returned image

| Prop | Params | Type | Description |
| :----------- | :-------: | :--------:| :----------|
| :----------- |:-------:| :--------:| :----------|
| onPictureTaken | `data` | `object` | Returns the captured image in an object `{ image: 'BASE64 string'}` |


Expand Down

0 comments on commit 80cf96f

Please sign in to comment.