Choose your SDK
Nosmai Effects is available for iOS, Android, Flutter, React Native, and Web. Choose the SDK that matches your application's framework. Flutter and React Native apps should use their framework's package and guide for both mobile targets. Native iOS and Android guides are for apps integrating those SDKs directly.
Here, native means the SDK built directly for iOS or Android. Flutter and React Native connect to those native mobile SDKs. Web 1.0.0 is distributed publicly through npm and runs in the browser. Its APIs, browser requirements, and package-specific limits are described below.
| Platform | Current release | Release status | Start here |
|---|---|---|---|
| iOS | NosmaiCameraSDK 3.0.7 | Supported | Install for iOS |
| Android | nosmai-sdk-3.0.7.aar | Supported | Install for Android |
| Flutter | nosmai_effects_sdk 2.0.2 | Supported | Install for Flutter |
| React Native | @nosmai/react-native-effects-sdk 2.0.1 | Supported | Install for React Native |
| Web | @nosmai/web-sdk 1.0.0 | Public npm release | Install for Web |
Supported means the documented native or framework integration is available for production use on the stated targets. Available identifies a public Web 1.0.0 API. Browser-dependent features require the relevant browser APIs and permissions. Package-dependent features require compatible authored content; test the exact package on your intended targets. Feature access also depends on your licence.
Core capability matrix
| Capability | iOS | Android | Flutter | React Native | Web |
|---|---|---|---|---|---|
| Real-time camera preview | Supported | Supported | Supported | Supported | Available |
| Front/back camera and switching | Supported | Supported | Supported | Supported | Available; camera-dependent |
| Camera lifecycle and rotation | Supported | Supported | Supported | Supported | Start/stop/dispose; browser-dependent rotation |
| Direct beauty and makeup controls | Supported | Supported | Supported | Supported | Available |
| Contour, highlighter, freckles, foundation, and dark-circle correction | Supported | Supported | Supported | Supported | Available |
| Hair colouring | Supported | Supported | Supported | Supported | Available |
| Runtime PNG, JPEG, or animated GIF face stickers | Supported | Supported | Supported | Supported | No direct sticker API |
| Direct colour adjustments | Supported | Supported | Supported | Supported | Available |
| Effect packages | Supported | Supported | Supported | Supported | Package-dependent |
| Face-tracked AR packages | Supported | Supported | Supported | Supported | Package-dependent |
| 3D authored content | Supported | Supported | Supported | Supported | Package-dependent |
| Authored triggers | Supported | Supported | Supported | Supported | Package-dependent |
| Runtime package parameters | Supported | Supported | Supported | Supported | Numeric and string controls |
| Background blur, colour, and image | Supported | Supported | Supported | Supported | Available |
| Background video | Supported | Supported | Supported | Supported | Available; browser playback rules |
| Cloud Filters catalog and download | Supported | Supported | Supported | Supported | Available; requires Cloud Filters access |
Capture and streaming matrix
| Capability | iOS | Android | Flutter | React Native | Web |
|---|---|---|---|---|---|
| Processed photo capture | Supported | Use app capture flow | Supported | Supported | Available (Blob) |
| Processed video recording | Supported | Supported | Supported | Supported | Available; browser-dependent |
| Processed frame or texture access | Supported | Supported | Supported | Supported | MediaStream / MediaStreamTrack |
| Agora integration | Supported | Supported | Supported | Not currently documented | Custom track; example |
| LiveKit integration | Supported | Supported | Supported | Not currently documented | Custom track; example |
| Raw WebRTC integration | Supported | Supported | Not currently documented | Not currently documented | Custom track; guide |
“Use app capture flow” means the host application captures the documented processed output rather than calling a dedicated Nosmai photo helper. “Not currently documented” is not a promise of incompatibility; it means no verified public integration guide is available for that combination.
System requirements
| Requirement | iOS | Android | Flutter | React Native | Web |
|---|---|---|---|---|---|
| Minimum target | iOS 15 | Android API 24 | iOS 15 or Android API 24 | iOS 15 or Android API 24 | HTTPS or localhost |
| Architecture | Physical ARM64 device | Physical arm64-v8a or armeabi-v7a device | iOS arm64; Android arm64-v8a or armeabi-v7a | iOS arm64; Android arm64-v8a or armeabi-v7a | Browser with WebAssembly SIMD and WebGL2 |
| Primary toolchain | CocoaPods, Swift or Objective-C | Java 11, compile SDK 35 | Flutter 3.29, Dart 3 | React Native 0.81.5, React 19.1, New Architecture | Node 18+ or the bundler's higher minimum, ESM bundler |
| Camera access | iOS camera permission | Android camera permission | Native camera permissions | Native camera permissions | Browser camera permission |
| Simulator or emulator | Not supported | Not qualified | Use physical devices | Use physical devices; Expo Go unsupported | Browser testing supported |
Web requirements and limits
Web 1.0.0 requires WebGL2, WebAssembly SIMD, Web Crypto, and camera access in a secure context. Use a current browser with hardware acceleration and test the devices your users will use.
- Serve the package's
engine/,engine-baseline/, andmodels/directories from the configuredassetBase. The SDK selects a compatible engine automatically; deploy both engine directories from the same SDK release. - The page and any embedding iframe must permit camera access. Content Security Policy and CORS must allow runtime assets, licence verification, and effect downloads. Register the application's Web origin for licensing.
- Face detection and tracking handle one face at a time. Multi-face tracking is unavailable in this release.
- Hair controls tint existing hair. Changing hairstyle length or shape is outside the hair-colouring API.
- Use compatible authored packages for face overlays. The public Web API does not expose a standalone runtime image-sticker API.
- Check
sdk.recording.isSupportedbefore recording. The available video format depends on browser support; photo capture returns aBlob. - Processed streaming output is a video-only
MediaStreamorMediaStreamTrack. Handle the microphone separately. Effect audio is excluded from published output and recordings.
The Web installation guide covers asset hosting and browser security. The Web API reference lists methods, ranges, events, and licence checks. Measure performance with your actual resolution, effects, and recording or streaming workload.
Distribution and application size
| SDK | Distribution | Published artifact size |
|---|---|---|
iOS 3.0.7 | CocoaPods or verified framework ZIP | Framework files: 42,614,663 bytes (40.6 MiB); release ZIP: 27,200,994 bytes (25.9 MiB) |
Android 3.0.7 | Verified release AAR | 40,433,979 bytes (38.6 MiB), including both supported ARM ABIs |
Flutter 2.0.2 | pub.dev package plus native dependencies | Wrapper is small; native artifacts resolve separately |
React Native 2.0.1 | npm package plus native dependencies | 249,401 bytes (243.6 KiB) packed; native artifacts resolve separately |
Web 1.0.0 | Public npm package with JavaScript, both engines, and model assets | 17,848,349 bytes (17.0 MiB) packed; 33,214,195 bytes (31.7 MiB) unpacked |
Published artifact size is not the final store-download increase. Store compression, app thinning, ABI splits, symbols, and existing dependencies all affect the shipped app. Measure the signed release build that users will download.
For Web, the npm package contains both engines; a browser loads the selected engine and the model assets from your app's asset host. Measure application JavaScript, runtime assets, and effect downloads separately, including cache behaviour on repeat visits. Effect assets and licensed feature access are separate from installing the npm package.
Verify platform eligibility
Before integration, confirm that:
- The target meets the minimum OS and architecture requirement.
- The required feature is available and its platform-specific limitations are acceptable.
- A physical device is available for native camera testing.
- The final application identifier or Web origin is registered for licensing.
- The exact authored packages are tested on every target platform.
- Performance is measured with the intended camera resolution and effects.
Common errors
| Symptom | Likely cause | Resolution |
|---|---|---|
Android reports INSTALL_FAILED_NO_MATCHING_ABIS | The device or app build includes neither arm64-v8a nor armeabi-v7a | Use a supported physical ARM device and keep at least one supported ABI |
| iOS linker reports a Simulator architecture mismatch | The current framework is device-only | Build and run on a physical iPhone or iPad |
Web reports webglUnavailable | Graphics support is unavailable or runtime startup failed | Check the underlying error and asset responses; use a browser with WebGL2 and WebAssembly SIMD and enable hardware acceleration |
| Web runtime or model requests return 404 | Assets were not copied or assetBase points to the wrong public URL | Follow the Web installation guide and verify the deployed asset paths |
Web Cloud Filters report FEATURE_NOT_LICENSED | Verification is pending or the key does not grant Cloud Filters access | Wait for licence verification and check sdk.isCloudFilterEnabled |
| React Native preview does not start | The camera view is not mounted or the required architecture is disabled | Mount the documented view and use the supported New Architecture setup |
Next steps
- Follow an iOS quickstart
- Follow an Android quickstart
- Follow a Flutter quickstart
- Follow a React Native quickstart
- Follow the Web quickstart
- Review limits and performance