Package selection guidance compiled from public package information, community data, and project usage.
A Flutter plugin that leverages Google's ML Kit Selfie Segmentation API to accurately distinguish a user from their background in real time. It enables developers to create immersive experiences by isolating the foreground person, ideal for virtual backgrounds, photo editing, and interactive apps. The plugin supports both Android and iOS platforms with seamless integration via Flutter. It runs efficiently on-device, ensuring privacy and low latency. Designed for simplicity, it requires minimal setup to implement advanced segmentation features.
Use cases
Real-time background replacement
Enhanced video conferencing
Interactive photo filters
Augmented reality applications
User-focused image editing
Key features
On-device inference
Real-time segmentation
Simple API integration
Cross-platform support (Android & iOS)
Privacy-preserving processing
Suitable for
Developers building AR/VR apps
Video conferencing app creators
Photo editing tool builders
Apps requiring foreground isolation
Considerations
Requires camera access permission
Performance varies on older devices
Limited to selfie-style front-facing scenes
No support for multiple people segmentation
Depends on Google ML Kit backend
Original README
Original README snapshot from the linked source repository. Visit the repository for the latest content.
⚠️ Important: GenAI APIs are built on top of AICore and will not support all Android devices. These APIs require devices with AICore support. Please check device compatibility before using these features in production.
⚠️ Production Disclaimer: Using GenAI plugins in production is the responsibility of the developers consuming the plugins, not the authors. The authors provide these plugins as-is and are not responsible for any issues, failures, or compatibility problems that may arise from using these plugins in production environments.
PLEASE READ THIS before continuing or posting a new issue:
Google's ML Kit was build only for mobile platforms: iOS and Android apps. Web or any other platform is not supported, you can request support for those platform to Google in their repo.
This plugin is not sponsored or maintained by Google. The authors are developers excited about Machine Learning that wanted to expose Google's native APIs to Flutter.
Google's ML Kit APIs are only developed natively for iOS and Android. This plugin uses Flutter Platform Channels as explained here.
Messages are passed between the client (the app/plugin) and host (platform) using platform channels as illustrated in this diagram:
Messages and responses are passed asynchronously, to ensure the user interface remains responsive. To read more about platform channels go here.
Because this plugin uses platform channels, no Machine Learning processing is done in Flutter/Dart, all the calls are passed to the native platform using MethodChannel in Android and FlutterMethodChannel in iOS, and executed using Google's native APIs. Think of this plugin as a bridge between your app and Google's native ML Kit APIs. This plugin only passes the call to the native API and the processing is done by Google's API. It is important that you understand this concept when it comes to debugging errors for your ML model and/or app.
Since the plugin uses platform channels, you may encounter issues with the native API. Before submitting a new issue, identify the source of the issue. You can run both iOS and/or Android native example apps by Google and make sure that the issue is not reproducible with their native examples. If you can reproduce the issue in their apps then report the issue to Google. The authors do not have access to the source code of their native APIs, so you need to report the issue to them. If you find that their example apps are okay and still you have an issue using this plugin, then look at our closed and open issues. If you cannot find anything that can help you then report the issue and provide enough details. Be patient, someone from the community will eventually help you.
Migrating from ML Kit for Firebase to the new standalone ML Kit SDK
When Migrating from ML Kit for Firebase to the new standalone ML Kit SDK read this guide.
Until https://github.com/flutter/flutter/issues/145961 is resolved, the most recent version of the camera package doesn't support the required image formats. To make things work, manually add the legacy plugin via the instructions from https://pub.dev/packages/camera_android.
Contributing
Contributions are welcome.
In case of any problems look at existing issues, if you cannot find anything related to your problem then open an issue.
Create an issue before opening a pull request for non trivial fixes.
In case of trivial fixes open a pull request directly.