---
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/plugins/mlkit/subject-segmentation.png
---

[ Skip to content](#capacitor-mlkitsubject-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/)
* [  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/)
* [  Usage ](#usage)
* [  API ](#api)
* [  Enums ](#enums)
* [  Terms & Privacy ](#terms-privacy)
* [  Changelog ](#changelog)
* [  License ](#license)
* [  Translation ](/docs/plugins/mlkit/translation/)
* [  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

* [  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)

[ ![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 |

## 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)<uses-permission android:name="android.permission.CAMERA" />
`

You also need to add the following meta data **in** the `application` tag in your `AndroidManifest.xml`:

`[](#%5F%5Fcodelineno-4-1)<meta-data android:name="com.google.mlkit.vision.DEPENDENCIES" android:value="subject_segment"/>
[](#%5F%5Fcodelineno-4-2)<!-- To use multiple models: android:value="face,model2,model3" -->
`

## 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<ProcessImageResult>
`

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<IsGoogleSubjectSegmentationModuleAvailableResult>
`

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<void>
`

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<PluginListenerHandle>
`

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<void>
`

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<void> |

#### 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