Installation and permissions

Installation

The fastest way to arrive at a working setup is to try out our example apps on GitHub: https://github.com/mxlaboratories/shenai-sdk

To add the SDK to an existing app, see documentation for the relevant platform:

See Flutter for installation instructions.

For the Linux headless SDKs (beta), see Linux headless C SDK and Linux headless Python SDK.

Permissions

To utilize the SDK, your app will need to have the Network and Camera permissions.

Add the following lines to your AndroidManifest.xml.


<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" android:required="false" />
<uses-permission android:name="android.permission.INTERNET"/>

You can use permission_handler plugin to request the permissions:


import 'package:permission_handler/permission_handler.dart';
 
...
 
Permission.camera.request().then((permission) async {
    if (permission == PermissionStatus.granted || permission == PermissionStatus.limited) {
        // Proceed with SDK initialization
    }
});

Add the following lines to your AndroidManifest.xml:

android/app/src/main/AndroidManifest.xml


<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" android:required="false" />
<uses-permission android:name="android.permission.INTERNET"/>

You’ll also need to add a camera usage description to your Info.plist file:

ios/project_name/Info.plist


<dict>
  ...
  <key>NSCameraUsageDescription</key>
  <string>Capture and analyze facial video</string>
</dict>

Camera permissions are requested automatically when the plugin initializes. Make sure to add camera usage descriptions to both Info.plist and AndroidManifest.xml.

You’ll need to add the camera permission to your Info.plist file:


<dict>
  ...
  <key>NSCameraUsageDescription</key>
  <string>Capture and analyze facial video</string>
</dict>

Add camera usage description to your Info.plist and camera and internet permissions to your AndroidManifest.xml.

Add the following lines to your AndroidManifest.xml.


<uses-permission android:name="android.permission.CAMERA" />
<uses-feature android:name="android.hardware.camera" android:required="false" />
<uses-permission android:name="android.permission.INTERNET"/>

Depending on which camera your app uses (front/back), you may modify the uses-feature field accordingly.