Tools and resources
Nosmai Effects adds real-time beauty, makeup, backgrounds, face-tracked AR, and processed camera output to mobile and Web apps. Start with a camera preview, then add the effects your app needs.
Start building
Choose the SDK that matches your app's framework. If you use Flutter or React Native, follow that framework's row for both Android and iOS.
| Your app | Install | Run the quickstart |
|---|---|---|
| Native Android | Android installation | Android quickstart |
| Native iOS | iOS installation | iOS quickstart |
| Flutter | Flutter installation | Flutter quickstart |
| React Native | React Native installation | React Native quickstart |
| Web | Web installation | Web quickstart |
- Install the SDK using the matching guide above.
- Create a licence key for your app's Android application ID, iOS bundle identifier, or Web origin.
- Follow the matching quickstart to initialize the SDK and display a camera preview.
- Add a direct effect control or a compatible effect package, with the required feature access enabled for your key.
Find example apps and version-specific setup in Samples. Use Platform support to check the features and requirements for your SDK.
What Nosmai Effects is
The SDK processes camera or input frames and exposes controls for effects, preview, and media output. Your app owns its interface and integration flow. Camera ownership and output APIs depend on the SDK you choose.
There are two main ways to add effects:
- Direct controls: adjust supported beauty, makeup, reshape, hair colour, background, or colour settings from your app's UI.
- Effect packages: apply a compatible
.nosmaifile containing an authored look or AR experience. Your app can bundle a local package or download an approved item through Cloud Filters.
Create custom packages in Nosmai Studio or choose licensed ready-made effects. Filters and effects explains these options. Cloud Filters explains catalog access, downloads, and caching.
Product capabilities
Feature availability, parameters, and output formats vary by SDK and licence. See the platform comparison for the exact integration you intend to use.
| Capability | What it adds |
|---|---|
| Beauty, makeup, and reshape | Skin retouching, face-shape controls, eye colour, contour, highlighter, foundation, freckles, and supported makeup layers |
| AR effects and face overlays | Face masks, stickers, particles, animated props, and 3D content through compatible authored packages; direct runtime sticker controls depend on the SDK |
| Hair colouring | Adjustable tint and intensity for existing hair |
| Backgrounds | Blur, colour, image, video, and authored background effects where supported |
| Colour adjustment | Full-frame colour controls and supported LUT workflows |
| Cloud Filters | List, download, cache, and apply effects available to the project |
| Capture and streaming output | Processed photos, recordings, and output for a live-streaming integration, using the selected SDK's APIs |
The documented releases support single-face detection and tracking. Hair-colour controls change tint; hairstyle length or shape changes are outside those controls. For package-specific reactions, see authored triggers.
Effect assets and access to licensed features are separate from installing the SDK. Choose the assets and feature access needed for your evaluation.
How it works

The app connects a camera or supported frame source to the SDK. Nosmai applies the selected controls or package, then provides a processed preview and the output supported by that integration.
Flutter and React Native connect to the native mobile SDKs. Web runs in the browser with WebAssembly and WebGL2 and serves its runtime assets from your app's configured asset location.
Read how the pipeline works for frame ordering, effect composition, and output ownership.
Platform availability
This documentation covers native iOS and Android 3.0.7, Flutter 2.0.2, React Native 2.0.1, and the public npm release of Web SDK 1.0.0.
Platform support lists the release packages, OS and architecture requirements, browser requirements, capability differences, and published artifact sizes. Use that comparison to plan device and browser coverage before choosing an integration.
Essential terminology
| Term | Meaning |
|---|---|
| SDK | The software package your app uses to integrate Nosmai camera effects |
| AR | Digital content positioned in the camera view, such as a face mask or tracked object |
| Effect package | A .nosmai file containing an authored effect that a compatible SDK can apply |
| Cloud Filter | An approved effect your app can list and download from its cloud catalog |
| Processed preview | The live camera view after Nosmai has applied the selected effects |
| App-bound licence key | A project key associated with an Android application ID, iOS bundle identifier, or Web origin |
Before production
- Register the final application ID, bundle identifier, or Web origin for the licence key used by each target.
- Keep one active camera owner and follow your SDK's cleanup steps when leaving the preview or switching screens.
- Test the exact effects on supported physical mobile devices and target Web browsers, including camera permissions and media output.
- Measure frame rate, memory, and device behaviour with your app's intended resolution, effects, and recording or streaming workload.
See Platform support and Limits and performance for the platform-specific requirements and evaluation guidance.