Skip to Content
PlatformsReact Native

React Native SDK

Using our React Native SDK makes it easy to integrate Shen.AI into a new or existing cross-platform (iOS and Android) React Native app.

The best way to get started is to build the example app - available here on GitHub .

The Shen AI SDK supports Expo. The minimal Expo example is available here on GitHub .

Installing the SDK package

The React Native SDK is published to npm as @shenai/react-native-sdk.

npm install @shenai/react-native-sdk

Use the equivalent command for your package manager if you use yarn, pnpm, or another npm-compatible client.

For iOS projects, install pods after changing dependencies:

cd ios
pod install

The package resolves the Android SDK from Maven Central and the iOS SDK from CocoaPods during the native build.

Custom frame input

React Native exposes CameraMode.CUSTOM_FRAMES, so you can configure the SDK not to start a camera:

import { initialize, CameraMode } from "@shenai/react-native-sdk"
 
await initialize(API_KEY, USER_ID, {
  cameraMode: CameraMode.CUSTOM_FRAMES
})

CustomFrames in React Native only configures the session. The React Native binding does not provide a raw frame-submission API, so frames must be submitted from native Android/iOS code through the native SDK APIs shown on the Android and iOS pages.

Further steps

Please see permissions, initialization, configuration and video measurement for further steps.

FlutteriOS