Skip to Content
PlatformsFlutter

Flutter SDK

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

The best way to get started is to download and build the example app - available here on GitHub . The example provides easy customization to kickstart creating new apps with the SDK.

Installing the SDK package

To start working with the SDK, you’ll need to download the SDK package and extract it somewhere in your flutter codebase. The SDK is packaged as a Flutter Plugin that you can reference locally in the filesystem (as opposed to the public registry).

See the Customer Portal for SDK downloads.

Specify the relative path to the extracted SDK in pubspec.yaml

pubspec.yaml
dependencies:
  ...
  shenai_sdk:
    path: ./shenai_sdk

Custom frame input

Flutter exposes CameraMode.customFrames, so you can configure the SDK not to start a camera:

final settings = InitializationSettings()
  ..cameraMode = CameraMode.customFrames;
 
await ShenaiSdk.initialize(API_KEY, USER_ID, settings: settings);

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

Further steps

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

ConfigurationReact Native