React Native SDK Reference
This page is the definitive source for everything exposed by @orga-ai/react-native: hooks, components, and exported types for mobile integrations built on react-native-webrtc and react-native-incall-manager. Use it when you need prop names, return signatures, or compatibility notes—tutorials and conceptual guides live elsewhere.
Sections
- Hooks —
useOrgaAI()contract for session control, device management, and parameter updates. - Components —
<OrgaAICameraView>,<OrgaAIControls>, and provider components tuned for native media. - Types — TypeScript definitions exported alongside the React Native SDK.
đź’ˇ Tip:
The React Native SDK mirrors the structure of the web SDK (@orga‑ai/react)
but integrates native modules (react‑native‑webrtc,react‑native‑incall‑manager) for media and routing.
Structure
Each reference page includes:
- Concise description of the API surface.
- TypeScript/JSX examples for quick integration.
- Tables describing parameters, props, and return values.
- Notes covering lifecycle, performance, and platform specifics.
Development Environment Requirements
Because the SDK uses native modules, your dev setup must include:
| Requirement | Description |
|---|---|
| React Native ≥0.72 | Required baseline version. |
| Expo SDK ≥50 (optional) | Enables API Routes with secure server‑side env variables. |
| react-native-webrtc | Handles WebRTC camera and audio streaming. |
| react-native-incall-manager | Controls speaker routing and call audio modes. |
| Physical device or simulator with camera | Required for real‑time session testing. |
⚠️ Expo Go is not supported — build a custom development client or use a bare React Native project.
Versioning
The React Native SDK follows the same semantic versioning as the other Orga SDKs.
Breaking changes are indicated by major version increments (e.g., 1.x → 2.x).
Recommended Reading
If you’re new to the SDK, start with:
- React Native tutorial – end-to-end Expo/bare setup.
- React Native architecture explanation – layering and media flow.
- React Native troubleshooting how-to – common mobile-specific fixes.