API Overview
Welcome to the Orga React Native SDK API Reference.
This section documents every hook, component, and type available in @orga‑ai/react‑native.
The React Native SDK brings Orga’s real‑time AI capabilities to mobile,
providing hooks, provider components, and native camera/audio controls built on react‑native‑webrtc.
Sections
- Hooks — Control sessions, devices, permissions, and AI interactions using
useOrgaAI(). - Components — UI primitives such as
<OrgaAICameraView>and<OrgaAIControls>for live video and media control. - Types — TypeScript types and enums exported by the SDK, including React Native–specific additions.
đź’ˇ 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).
Check the Changelog for release notes.
Recommended Reading
If you’re new to the SDK, start with:
- Quick Start → Step‑by‑step setup and backend integration.
- Architecture → Understand how each layer (UI → SDK → core → backend) works together.
- Troubleshooting → Diagnose permission and build issues.
Next Steps
- Hooks → Control sessions, devices, permissions, and AI interactions using
useOrgaAI(). - Components → UI primitives such as
<OrgaAICameraView>and<OrgaAIControls>for live video and media control. - Types → TypeScript types and enums exported by the SDK, including React Native–specific additions.