---
description: Unofficial Capacitor plugin for Google ML Kit Subject Segmentation SDK to segment subjects in images.
title: Capacitor ML Kit Subject Segmentation Plugin for Android - Capawesome
image: https://capawesome.io/docs/assets/images/social/sdks/capacitor/mlkit/subject-segmentation.png
---
[ Skip to content](#capacitor-mlkitsubject-segmentation)
[ π Introducing the **Capacitor Vault** plugin β store secrets behind biometrics or a device passcode.](/blog/announcing-the-capacitor-vault-plugin/)
* [ SDKs ](/docs/sdks/)
* [ Formbricks ](/docs/sdks/capacitor/formbricks/)
* [ Geocoder ](/docs/sdks/capacitor/geocoder/)
* [ Google Sign-In ](/docs/sdks/capacitor/google-sign-in/)
* [ Grafana Faro ](/docs/sdks/capacitor/grafana-faro/)
* [ libSQL ](/docs/sdks/capacitor/libsql/)
* [ Live Update ](/docs/sdks/capacitor/live-update/)
* [ Managed Configurations ](/docs/sdks/capacitor/managed-configurations/)
* [ Media Session ](/docs/sdks/capacitor/media-session/)
* [ ML Kit ](/docs/sdks/capacitor/mlkit/)
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Terms & Privacy ](#terms-privacy)
* [ Changelog ](#changelog)
* [ License ](#license)
* [ Translation ](/docs/sdks/capacitor/mlkit/translation/)
* [ Navigation Bar ](/docs/sdks/capacitor/navigation-bar/)
* [ NFC ](/docs/sdks/capacitor/nfc/)
* [ OAuth ](/docs/sdks/capacitor/oauth/)
* [ Pedometer ](/docs/sdks/capacitor/pedometer/)
* [ Photo Editor ](/docs/sdks/capacitor/photo-editor/)
* [ PostHog ](/docs/sdks/capacitor/posthog/)
* [ Printer ](/docs/sdks/capacitor/printer/)
* [ Purchases ](/docs/sdks/capacitor/purchases/)
* [ RealtimeKit ](/docs/sdks/capacitor/realtimekit/)
* [ Screen Orientation ](/docs/sdks/capacitor/screen-orientation/)
* [ Screenshot ](/docs/sdks/capacitor/screenshot/)
* [ Secure Preferences ](/docs/sdks/capacitor/secure-preferences/)
* [ Speech Recognition ](/docs/sdks/capacitor/speech-recognition/)
* [ Speech Synthesis ](/docs/sdks/capacitor/speech-synthesis/)
* [ Share Target ](/docs/sdks/capacitor/share-target/)
* [ Square Mobile Payments ](/docs/sdks/capacitor/square-mobile-payments/)
* [ SQLite ](/docs/sdks/capacitor/sqlite/)
* [ Superwall ](/docs/sdks/capacitor/superwall/)
* [ Torch ](/docs/sdks/capacitor/torch/)
* [ Vault ](/docs/sdks/capacitor/vault/)
* [ Wifi ](/docs/sdks/capacitor/wifi/)
* [ Zip ](/docs/sdks/capacitor/zip/)
* [ Cordova ](/docs/sdks/cordova/)
* [ Cloud ](/docs/cloud/)
* [ Integrations ](/docs/cloud/live-updates/integrations/)
* Concepts
* Reference
* [ Troubleshooting ](/docs/cloud/live-updates/troubleshooting/)
* [ FAQ ](/docs/cloud/live-updates/faq/)
* [ Native Builds ](/docs/cloud/native-builds/)
* [ Set Up Environments ](/docs/cloud/native-builds/environments/)
* [ Overwrite Native Configurations ](/docs/cloud/native-builds/native-configurations/)
* [ Auto-Increment Build Numbers ](/docs/cloud/native-builds/auto-incrementing-build-numbers/)
* [ Configure the Web Build Script ](/docs/cloud/native-builds/web-build-script/)
* [ Build from a Monorepo ](/docs/cloud/native-builds/monorepo/)
* [ Use pnpm or Yarn ](/docs/cloud/native-builds/package-managers/)
* [ Install Private npm Packages ](/docs/cloud/native-builds/npm-private-registry/)
* [ Override the Java Version ](/docs/cloud/native-builds/override-java-version/)
* [ Custom iOS Provisioning Profiles ](/docs/cloud/native-builds/custom-ios-provisioning-profiles/)
* [ Build without Git ](/docs/cloud/native-builds/build-without-git/)
* [ Access Git Behind a Firewall ](/docs/cloud/native-builds/firewall-access/)
* [ Integrations ](/docs/cloud/native-builds/integrations/)
* Reference
* [ Troubleshooting ](/docs/cloud/native-builds/troubleshooting/)
* [ FAQ ](/docs/cloud/native-builds/faq/)
* [ App Store Publishing ](/docs/cloud/app-store-publishing/)
* [ Submit a Build ](/docs/cloud/app-store-publishing/submit-a-build/)
* [ Submit Automatically After a Build ](/docs/cloud/app-store-publishing/submit-automatically/)
* [ Troubleshooting ](/docs/cloud/app-store-publishing/troubleshooting/)
* [ FAQ ](/docs/cloud/app-store-publishing/faq/)
* [ Automations ](/docs/cloud/automations/)
* [ Reference ](/docs/cloud/automations/reference/)
* [ Troubleshooting ](/docs/cloud/automations/troubleshooting/)
* [ FAQ ](/docs/cloud/automations/faq/)
* [ Assist ](/docs/cloud/assist/)
* [ CLI ](/docs/cloud/cli/)
* APIs and SDKs
* [ Webhooks ](/docs/cloud/webhooks/)
* [ Integrations ](/docs/cloud/integrations/)
* Account
* [ Organization ](/docs/cloud/organizations/)
* [ Two-Factor Enforcement ](/docs/cloud/organizations/two-factor-authentication/)
* [ Audit Logs ](/docs/cloud/organizations/audit-logs/)
* [ Billing ](/docs/cloud/organizations/billing/)
* [ License Keys ](/docs/cloud/license-keys/)
* [ AI ](/docs/ai/)
* [ Insiders ](/docs/insiders/)
* [ Billing & Plans ](/docs/insiders/billing-and-plans/)
* [ FAQ ](/docs/insiders/faq/)
* [ License ](https://capawesome.io/legal/eula/)
* [ Support ](/docs/support/)
* [ Contributing ](/docs/contributing/)
* Contributing code
* [ Code of Conduct ](/docs/contributing/code-of-conduct/)
* [ Questions ](https://docs.github.com/en/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion#creating-a-discussion)
* [ Blog ](/blog/)
* Categories
* [ Usage ](#usage)
* [ API ](#api)
* [ Enums ](#enums)
* [ Terms & Privacy ](#terms-privacy)
* [ Changelog ](#changelog)
* [ License ](#license)
# @capacitor-mlkit/subject-segmentation[ΒΆ](#capacitor-mlkitsubject-segmentation "Permanent link")
Unofficial Capacitor plugin for [ML Kit Subject Segmentation](https://developers.google.com/ml-kit/vision/subject-segmentation).[1](#fn:1)
[  ](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 |
## 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/subject-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/subject-segmentation
[](#%5F%5Fcodelineno-2-2)npx cap sync
`
### Android[ΒΆ](#android "Permanent link")
#### API level[ΒΆ](#api-level "Permanent link")
This plugin requires a minimum API level of 24.
#### Permissions[ΒΆ](#permissions "Permanent link")
This API requires the following permissions be added to your `AndroidManifest.xml` before the `application` tag:
`[](#%5F%5Fcodelineno-3-1)
`
You also need to add the following meta data **in** the `application` tag in your `AndroidManifest.xml`:
`[](#%5F%5Fcodelineno-4-1)
[](#%5F%5Fcodelineno-4-2)
`
## Usage[ΒΆ](#usage "Permanent link")
`[](#%5F%5Fcodelineno-5-1)import { SubjectSegmentation } from '@capacitor-mlkit/subject-segmentation';
[](#%5F%5Fcodelineno-5-2)
[](#%5F%5Fcodelineno-5-3)const processImage = async () => {
[](#%5F%5Fcodelineno-5-4) const { path } = await SubjectSegmentation.processImage({
[](#%5F%5Fcodelineno-5-5) path: 'path/to/image.jpg',
[](#%5F%5Fcodelineno-5-6) confidence: 0.7,
[](#%5F%5Fcodelineno-5-7) });
[](#%5F%5Fcodelineno-5-8) return path;
[](#%5F%5Fcodelineno-5-9)};
`
## API[ΒΆ](#api "Permanent link")
* [processImage(...)](#processimage)
* [isGoogleSubjectSegmentationModuleAvailable()](#isgooglesubjectsegmentationmoduleavailable)
* [installGoogleSubjectSegmentationModule()](#installgooglesubjectsegmentationmodule)
* [addListener('googleSubjectSegmentationModuleInstallProgress', ...)](#addlistenergooglesubjectsegmentationmoduleinstallprogress-)
* [removeAllListeners()](#removealllisteners)
* [Interfaces](#interfaces)
* [Enums](#enums)
### processImage(...)[ΒΆ](#processimage "Permanent link")
`[](#%5F%5Fcodelineno-6-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:** 7.2.0
---
### isGoogleSubjectSegmentationModuleAvailable()[ΒΆ](#isgooglesubjectsegmentationmoduleavailable "Permanent link")
`[](#%5F%5Fcodelineno-7-1)isGoogleSubjectSegmentationModuleAvailable() => Promise
`
Check if the Google Subject Segmentation module is available.
If the Google Subject Segmentation module is not available, you can install it by using `installGoogleSubjectSegmentationModule()`.
Only available on Android.
**Returns:** `Promise<[IsGoogleSubjectSegmentationModuleAvailableResult](#isgooglesubjectsegmentationmoduleavailableresult)>`
**Since:** 7.2.0
---
### installGoogleSubjectSegmentationModule()[ΒΆ](#installgooglesubjectsegmentationmodule "Permanent link")
`[](#%5F%5Fcodelineno-8-1)installGoogleSubjectSegmentationModule() => Promise
`
Install the Google Subject Segmentation module.
**Attention**: This only starts the installation. The `googleSubjectSegmentationModuleInstallProgress` event listener will notify you when the installation is complete.
Only available on Android.
**Since:** 7.2.0
---
### addListener('googleSubjectSegmentationModuleInstallProgress', ...)[ΒΆ](#addlistenergooglesubjectsegmentationmoduleinstallprogress "Permanent link")
`[](#%5F%5Fcodelineno-9-1)addListener(eventName: 'googleSubjectSegmentationModuleInstallProgress', listenerFunc: (event: GoogleSubjectSegmentationModuleInstallProgressEvent) => void) => Promise
`
Called when the Google Subject Segmentation module is installed.
Only available on Android.
| Param | Type |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| **eventName** | 'googleSubjectSegmentationModuleInstallProgress' |
| **listenerFunc** | (event: [GoogleSubjectSegmentationModuleInstallProgressEvent](#googlesubjectsegmentationmoduleinstallprogressevent)) => void |
**Returns:** `Promise<[PluginListenerHandle](#pluginlistenerhandle)>`
**Since:** 7.2.0
---
### removeAllListeners()[ΒΆ](#removealllisteners "Permanent link")
`[](#%5F%5Fcodelineno-10-1)removeAllListeners() => Promise
`
Remove all listeners for this plugin.
Only available on Android.
**Since:** 7.2.0
---
### Interfaces[ΒΆ](#interfaces "Permanent link")
#### ProcessImageResult[ΒΆ](#processimageresult "Permanent link")
| Prop | Type | Description | Since |
| ---------- | ------ | ------------------------------------- | ----- |
| **path** | string | The path to the segmented image file. | 7.2.0 |
| **width** | number | Returns the width of the image file. | 7.2.0 |
| **height** | number | Returns the height of the image file. | 7.2.0 |
#### ProcessImageOptions[ΒΆ](#processimageoptions "Permanent link")
| Prop | Type | Description | Default | Since |
| -------------- | ------ | --------------------------------------------------------------------------------------- | ------- | ----- |
| **path** | string | The local path to the image file. | 7.2.0 | |
| **width** | number | Scale the image to this width. If no height is given, it will respect the aspect ratio. | 7.2.0 | |
| **height** | number | Scale the image to this height. If no width is given, it will respect the aspect ratio. | 7.2.0 | |
| **confidence** | number | Sets the confidence threshold. | 0.9 | 7.2.0 |
#### IsGoogleSubjectSegmentationModuleAvailableResult[ΒΆ](#isgooglesubjectsegmentationmoduleavailableresult "Permanent link")
| Prop | Type | Description | Since |
| ------------- | ------- | ------------------------------------------------------------------- | ----- |
| **available** | boolean | Whether or not the Google Subject Segmentation module is available. | 7.2.0 |
#### PluginListenerHandle[ΒΆ](#pluginlistenerhandle "Permanent link")
| Prop | Type |
| ---------- | ------------------- |
| **remove** | () => Promise |
#### GoogleSubjectSegmentationModuleInstallProgressEvent[ΒΆ](#googlesubjectsegmentationmoduleinstallprogressevent "Permanent link")
| Prop | Type | Description | Since |
| ------------ | ------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | ----- |
| **state** | [GoogleSubjectSegmentationModuleInstallState](#googlesubjectsegmentationmoduleinstallstate) | The current state of the installation. | 7.2.0 |
| **progress** | number | The progress of the installation in percent between 0 and 100. | 7.2.0 |
### Enums[ΒΆ](#enums "Permanent link")
#### GoogleSubjectSegmentationModuleInstallState[ΒΆ](#googlesubjectsegmentationmoduleinstallstate "Permanent link")
| Members | Value | Since |
| -------------------- | ----- | ----- |
| **UNKNOWN** | 0 | 7.2.0 |
| **PENDING** | 1 | 7.2.0 |
| **DOWNLOADING** | 2 | 7.2.0 |
| **CANCELED** | 3 | 7.2.0 |
| **COMPLETED** | 4 | 7.2.0 |
| **FAILED** | 5 | 7.2.0 |
| **INSTALLING** | 6 | 7.2.0 |
| **DOWNLOAD\_PAUSED** | 7 | 7.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/subject-segmentation/CHANGELOG.md).
## License[ΒΆ](#license "Permanent link")
See [LICENSE](https://github.com/capawesome-team/capacitor-mlkit/blob/main/packages/subject-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