Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
nacmartin committed Mar 12, 2023
1 parent 7dc680e commit 3ef3a6f
Showing 1 changed file with 30 additions and 1 deletion.
31 changes: 30 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,5 +98,34 @@ export interface GestureEventParams {
}
```

*Note: It is possible to train mediapipe to recognize more gestures, but this library does not have support for custom gestures yet.*
*Note: It is possible to train mediapipe to recognize more gestures. See mediapipe docs and provide a model in config*

## Configure

The method `init()` accepts an optional argument with a configuration object:

```typescript
interface ManitasConfig {
gestureThreshold: number;
handednessThreshold: number;
activeThreshold: number;
videoHeight: string;
videoWidth: string;
videoId: string;
delegate: "GPU" | "CPU";
modelAssetPath: string;
mediapipeWasmPath: string;
}
```

* gestureThreshold: Confidence threshold to decide if a gesture has been detected.
* handednessThreshold: Confidence threshold to decide if a gesture has been detected.
* activeThreshold: Threshold to decide if the user is pointing.
* videoId: Id of a video element to attach the webcam stream;
* videoHeight: Height of the video element;
* videoWidth: Width of the video element;
* delegate: "GPU" | "CPU", Are we using GPU or CPU for estimation?
* modelAssetPath: Custom model if you have defined custom gestures.
* mediapipeWasmPath: Path to mediapipe wasm.


0 comments on commit 3ef3a6f

Please sign in to comment.