# Nosmai Moderation

> On-device content and text moderation SDK for mobile apps. It flags NSFW imagery, detects weapons, drugs, cigarettes and alcohol, and moderates toxic text. Everything runs fully offline on the device, so no frame or message ever leaves the phone. Thresholds are tunable at runtime. Available for iOS, Android, Flutter and React Native.

Nosmai Moderation is one of the Nosmai SDKs (alongside Nosmai Effects). One license key unlocks four surfaces from a single on-device engine:

- Image: moderate a single photo with `analyzeImage`.
- Video: sample and aggregate a recorded clip with `analyzeVideo`.
- Text: moderate a chat message or comment with `moderateText` (a keyword blocklist plus an AI classifier).
- Live camera: real-time per-frame moderation with `startStream` and `pushFrame`.

Visual objects (`NosmaiCategory`): weapon, drug, cigarette, alcohol. NSFW verdict (`NosmaiNsfwVerdict`): safe, warn, block. Text categories (`NosmaiTextCategory`): profanity, toxic, hate, harassment, threat, safe. Every image or live result is a `NosmaiResult` with `isUnsafe`, `detections`, `nsfw` and per-class scores. The license key is verified online on first launch, then cached for 24h with a further 24h offline grace.

## Getting started

- [Moderation overview](https://nosmai.com/docs/moderation/introduction): what it detects, the result shape, and tunable thresholds.
- [Quickstart](https://nosmai.com/docs/moderation/quickstart): install the SDK, add your key, and render the first result.
- [Concepts](https://nosmai.com/docs/moderation/concepts): how on-device moderation, surfaces and verdicts fit together.
- [Authentication and licensing](https://nosmai.com/docs/moderation/authentication): app id vs secret keys, the license model, and offline grace.

## Platform guides

- [iOS](https://nosmai.com/docs/moderation/ios): CocoaPods install (`pod 'NosmaiModerationSDK'`), Info.plist keys, and full usage (image, video, text, live).
- [Android](https://nosmai.com/docs/moderation/android): AAR install, minSdk 24, arm64, Kotlin 2.2+, and full usage.
- [Flutter](https://nosmai.com/docs/moderation/flutter): pub.dev package `nosmai_moderation_sdk`, the Android AAR step, and full usage.
- [React Native](https://nosmai.com/docs/moderation/react-native): npm package `@nosmai/moderation-react-native`, the Android AAR step, and full usage.

## Guides

- [Live streaming (Agora)](https://nosmai.com/docs/moderation/live-streaming): moderate a live Agora stream in real time by tapping captured frames, with working examples for iOS, Android, Web and Flutter ([moderation-agora-examples](https://github.com/nosmai/moderation-agora-examples)).

## Reference

- [Errors](https://nosmai.com/docs/moderation/errors): error codes and how to handle license, network and runtime failures.

## Optional

- [Nosmai Moderation product page](https://nosmai.com/moderation): overview and pricing.
- [Nosmai Effects SDK](https://nosmai.com/effects): the companion real-time filters and AR SDK.
- [Dashboard (get a license key)](https://nosmai.com/): create an app and copy its key.
- [About Nosmai](https://nosmai.com/about): company and platform overview.