--- description: Unofficial Capacitor plugin for Google ML Kit Selfie Segmentation SDK to segment the foreground from the background in images. title: Capacitor Selfie Segmentation Plugin for Android & iOS - Capawesome image: https://capawesome.io/docs/assets/images/social/plugins/mlkit/selfie-segmentation.png --- [ Skip to content](#capacitor-mlkitselfie-segmentation) [ 🎉 Introducing **Capawesome Platform** — one platform for Live Updates, Native Builds, App Store Publishing, and Insider SDKs.](https://capawesome.io) * [ Formbricks ](/docs/plugins/formbricks/) * [ Geocoder ](/docs/plugins/geocoder/) * [ Google Sign-In ](/docs/plugins/google-sign-in/) * [ Grafana Faro ](/docs/plugins/grafana-faro/) * [ libSQL ](/docs/plugins/libsql/) * [ Live Update ](/docs/plugins/live-update/) * [ Managed Configurations ](/docs/plugins/managed-configurations/) * [ Media Session ](/docs/plugins/media-session/) * [ ML Kit ](/docs/plugins/mlkit/) * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Terms & Privacy ](#terms-privacy) * [ Changelog ](#changelog) * [ License ](#license) * [ Subject Segmentation ](/docs/plugins/mlkit/subject-segmentation/) * [ Translation ](/docs/plugins/mlkit/translation/) * [ Navigation Bar ](/docs/plugins/navigation-bar/) * [ NFC ](/docs/plugins/nfc/) * [ OAuth ](/docs/plugins/oauth/) * [ Pedometer ](/docs/plugins/pedometer/) * [ Photo Editor ](/docs/plugins/photo-editor/) * [ PostHog ](/docs/plugins/posthog/) * [ Printer ](/docs/plugins/printer/) * [ Purchases ](/docs/plugins/purchases/) * [ RealtimeKit ](/docs/plugins/realtimekit/) * [ Screen Orientation ](/docs/plugins/screen-orientation/) * [ Screenshot ](/docs/plugins/screenshot/) * [ Secure Preferences ](/docs/plugins/secure-preferences/) * [ Speech Recognition ](/docs/plugins/speech-recognition/) * [ Speech Synthesis ](/docs/plugins/speech-synthesis/) * [ Share Target ](/docs/plugins/share-target/) * [ Square Mobile Payments ](/docs/plugins/square-mobile-payments/) * [ SQLite ](/docs/plugins/sqlite/) * [ Superwall ](/docs/plugins/superwall/) * [ Torch ](/docs/plugins/torch/) * [ Wifi ](/docs/plugins/wifi/) * [ Zip ](/docs/plugins/zip/) * [ Cloud ](/docs/cloud/) * [ Live Updates ](/docs/cloud/live-updates/) * Advanced * Integrations * [ Native Builds ](/docs/cloud/native-builds/) * [ Configuration ](/docs/cloud/native-builds/configuration/) * [ Environments ](/docs/cloud/native-builds/environments/) * Guides * [ Sample Projects ](/docs/cloud/native-builds/sample-projects/) * [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/) * [ Automations ](/docs/cloud/automations/) * [ Assist ](/docs/cloud/assist/) * Account * Organizations * [ Organization and User Management ](/docs/cloud/organizations/memberships/) * [ Single Sign-On (SSO) ](/docs/cloud/organizations/sso/) * [ Teams ](/docs/cloud/organizations/teams/) * [ Two-Factor Authentication ](/docs/cloud/organizations/two-factor-authentication/) * [ Integrations ](/docs/cloud/integrations/) * [ License Keys ](/docs/cloud/license-keys/) * [ Webhooks ](/docs/cloud/webhooks/) * [ Pricing ](https://capawesome.io/pricing/) * [ FAQ ](/docs/cloud/faq/) * [ Support ](/docs/cloud/support/) * [ Contributing ](/docs/contributing/) * [ LLMs ](/docs/llms/) * [ Insiders ](/docs/insiders/) * [ License ](https://capawesome.io/legal/eula/) * [ Support ](/docs/insiders/support/) * [ FAQ ](/docs/insiders/faq/) * [ Blog ](/blog/) * Categories * [ iOS ](#ios) * [ Configuration ](#configuration) * [ Demo ](#demo) * [ Usage ](#usage) * [ API ](#api) * [ Terms & Privacy ](#terms-privacy) * [ Changelog ](#changelog) * [ License ](#license) # @capacitor-mlkit/selfie-segmentation[¶](#capacitor-mlkitselfie-segmentation "Permanent link") Unofficial Capacitor plugin for [ML Kit Selfie Segmentation](https://developers.google.com/ml-kit/vision/selfie-segmentation).[1](#fn:1) [ ![Deliver Live Updates to your Capacitor app with Capawesome Cloud](../../../assets/external/cloud.capawesome.io/assets/banners/cloud-build-and-deploy-capacitor-apps.69628c3f.png) ](https://cloud.capawesome.io/) ## Newsletter[¶](#newsletter "Permanent link") Stay up to date with the latest news and updates about the Capawesome, Capacitor, and Ionic ecosystem by subscribing to our [Capawesome Newsletter](https://cloud.capawesome.io/newsletter/). ## Compatibility[¶](#compatibility "Permanent link") | Plugin Version | Capacitor Version | Status | | -------------- | ----------------- | -------------- | | 8.x.x | \>=8.x.x | Active support | | 7.x.x | 7.x.x | Deprecated | | 6.x.x | 6.x.x | Deprecated | ## Installation[¶](#installation "Permanent link") You can use our **AI-Assisted Setup** to install the plugin. Add the [Capawesome Skills](https://github.com/capawesome-team/skills) to your AI tool using the following command: `[](#%5F%5Fcodelineno-0-1)npx skills add capawesome-team/skills --skill capacitor-plugins ` Then use the following prompt: `` [](#%5F%5Fcodelineno-1-1)Use the `capacitor-plugins` skill from `capawesome-team/skills` to install the `@capacitor-mlkit/selfie-segmentation` plugin in my project. `` If you prefer **Manual Setup**, install the plugin by running the following commands and follow the platform-specific instructions below: `[](#%5F%5Fcodelineno-2-1)npm install @capacitor-mlkit/selfie-segmentation [](#%5F%5Fcodelineno-2-2)npx cap sync ` **Attention**: This plugin **only supports CocoaPods** for iOS dependency management. Swift Package Manager (SPM) is not supported for the ML Kit SDK, see [this comment](https://github.com/googlesamples/mlkit/issues/180#issuecomment-1298964099). ### Android[¶](#android "Permanent link") #### Variables[¶](#variables "Permanent link") If needed, you can define the following project variable in your app’s `variables.gradle` file to change the default version of the dependency: * `$mlkitSelfieSegmentationVersion` version of `com.google.mlkit:segmentation-selfie` (default: `16.0.0-beta6`) This can be useful if you encounter dependency conflicts with other plugins in your project. ### iOS[¶](#ios "Permanent link") #### Minimum Deployment Target[¶](#minimum-deployment-target "Permanent link") Make sure to set the deployment target in your `ios/App/Podfile` to at least `15.5`: `[](#%5F%5Fcodelineno-3-1)platform :ios, '15.5' ` ## Configuration[¶](#configuration "Permanent link") No configuration required for this plugin. ## Demo[¶](#demo "Permanent link") A working example can be found here: [robingenz/capacitor-mlkit-plugin-demo](https://github.com/robingenz/capacitor-mlkit-plugin-demo) | Android | iOS | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ![Android demo of the Selfie Segmentation plugin](../../../assets/external/github.com/capawesome-team/capacitor-mlkit/assets/13857929/1cef9ea9-570e-47d9-a751-d778535ffdff.gif) | ![iOS demo of the Selfie Segmentation plugin](../../../assets/external/github.com/capawesome-team/capacitor-mlkit/assets/13857929/b9caa88c-31b9-4a25-a731-961625207af4.gif) | ## Usage[¶](#usage "Permanent link") `[](#%5F%5Fcodelineno-4-1)import { SelfieSegmentation } from '@capacitor-mlkit/selfie-segmentation'; [](#%5F%5Fcodelineno-4-2) [](#%5F%5Fcodelineno-4-3)const processImage = async () => { [](#%5F%5Fcodelineno-4-4) const { path } = await SelfieSegmentation.processImage({ [](#%5F%5Fcodelineno-4-5) path: 'path/to/image.jpg', [](#%5F%5Fcodelineno-4-6) confidence: 0.7, [](#%5F%5Fcodelineno-4-7) }); [](#%5F%5Fcodelineno-4-8) return path; [](#%5F%5Fcodelineno-4-9)}; ` ## API[¶](#api "Permanent link") * [processImage(...)](#processimage) * [Interfaces](#interfaces) ### processImage(...)[¶](#processimage "Permanent link") `[](#%5F%5Fcodelineno-5-1)processImage(options: ProcessImageOptions) => Promise ` Performs segmentation on an input image. Only available on Android and iOS. | Param | Type | | ----------- | ------------------------------------------- | | **options** | [ProcessImageOptions](#processimageoptions) | **Returns:** `Promise<[ProcessImageResult](#processimageresult)>` **Since:** 5.2.0 --- ### Interfaces[¶](#interfaces "Permanent link") #### ProcessImageResult[¶](#processimageresult "Permanent link") | 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[¶](#processimageoptions "Permanent link") | 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[¶](#terms-privacy "Permanent link") This plugin uses the [Google ML Kit](https://developers.google.com/ml-kit): * [Terms & Privacy](https://developers.google.com/ml-kit/terms) * [Android Data Disclosure](https://developers.google.com/ml-kit/android-data-disclosure) * [iOS Data Disclosure](https://developers.google.com/ml-kit/ios-data-disclosure) ## Changelog[¶](#changelog "Permanent link") See [CHANGELOG.md](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/selfie-segmentation/CHANGELOG.md). ## License[¶](#license "Permanent link") See [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/selfie-segmentation/LICENSE). --- 1. This project is not affiliated with, endorsed by, sponsored by, or approved by Google LLC or any of their affiliates or subsidiaries. [↩](#fnref:1 "Jump back to footnote 1 in the text") May 17, 2026 Back to top