5.4.0 • Published 1 year ago
@jigra-mlkit/selfie-segmentation v5.4.0
@jigra-mlkit/selfie-segmentation
Unofficial Jigra plugin for ML Kit Selfie Segmentation.^1
Installation
npm install @jigra-mlkit/selfie-segmentation
npx jig syncVariables
This plugin will use the following project variables (defined in your app’s variables.gradle file):
$mlkitSelfieSegmentationVersionversion ofcom.google.mlkit:segmentation-selfie(default:16.0.0-beta4)
Configuration
No configuration required for this plugin.
Usage
import { SelfieSegmentation } from '@jigra-mlkit/selfie-segmentation';
const processImage = async () => {
const { path } = await SelfieSegmentation.processImage({
path: 'path/to/image.jpg',
confidence: 0.7,
});
return path;
};API
processImage(...)
processImage(options: ProcessImageOptions) => Promise<ProcessImageResult>Performs segmentation on an input image.
Only available on Android and iOS.
| Param | Type |
|---|---|
options | ProcessImageOptions |
Returns: Promise<ProcessImageResult>
Since: 5.2.0
Interfaces
ProcessImageResult
| Prop | Type | Description | Since |
|---|---|---|---|
path | string | The path to the segmented image file. | 5.2.0 |
width | number | Returns the width of the image file. | 5.2.0 |
height | number | Returns the height of the image file. | 5.2.0 |
ProcessImageOptions
| Prop | Type | Description | Default | Since |
|---|---|---|---|---|
path | string | The local path to the image file. | 5.2.0 | |
width | number | Scale the image to this width. If no height is given, it will respect the aspect ratio. | 5.2.0 | |
height | number | Scale the image to this height. If no width is given, it will respect the aspect ratio. | 5.2.0 | |
confidence | number | Sets the confidence threshold. | 0.9 | 5.2.0 |
Terms & Privacy
This plugin uses the Google ML Kit:
License
See LICENSE.
^1: This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries.