ksegla / deepar-flutter-plugin

Deep AR SDK for Flutter.

This plugin is the official SDK for DeepAR. Platforms supported: Android & iOS.

The current version of plugin supports:

• Live AR previews ✅
• Take screenshots ✅
• Record Videos ✅
• Flip camera ✅
• Toggle Flash ✅

Support	Android	iOS
	SDK 23+	iOS 13.0+

Installation

Please visit our developer website to create a project and generate your separate license keys for both platforms.

Once done, please add the latest deepar_flutter dependency to your pubspec.yaml.

Android:

1. compileSdkVersion should be 33 or more.
2. minSdkVersion should be 23 or more.
3. Download the native android dependencies from our downloads section and paste it in your flutter project at android/app/libs/deepar.aar.
4. Make sure to pub clean & flutter pub upgrade to fetch latest working code.

Also add the following permission requests in your AndroidManifest.xml

<uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"  />
<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
<uses-permission android:name="android.permission.RECORD_AUDIO"/>
<uses-permission android:name="Manifest.permission.CAPTURE_AUDIO_OUTPUT"  />
<uses-permission android:name="android.permission.CAMERA" />

Ensure to add these rules to proguard-rules.pro else app might crash in release build

-keepclassmembers class ai.deepar.ar.DeepAR { *; }
-keepclassmembers class ai.deepar.ar.core.videotexture.VideoTextureAndroidJava { *; }
-keep class ai.deepar.ar.core.videotexture.VideoTextureAndroidJava

iOS:

1. Ensure your app iOS deployment version is 13.0+.
2. Do a flutter clean & install pods.
3. To handle camera and microphone permissions, please add the following strings to your info.plist.
4. Make sure to pub clean & flutter pub upgrade to fetch latest working code.

<key>NSCameraUsageDescription</key>
<string>---Reason----</string>
<key>NSMicrophoneUsageDescription</key>
<string>---Reason----</string>

6. Also add the following to your Podfile file:

post_install do |installer|
  installer.pods_project.targets.each do |target|

    # Start of the deepar configuration
    target.build_configurations.each do |config|
    
      config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64'

	  config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
        '$(inherited)',

        ## dart: PermissionGroup.camera
         'PERMISSION_CAMERA=1',

        ## dart: PermissionGroup.microphone
         'PERMISSION_MICROPHONE=1',    
      ]

    end 
    # End of the permission_handler configuration
  end
end

Run on iOS Simulator:

1. Download latest DeepAR SDK and copy simulator/DeepAR.framework (IMPORTANT) folder and paste it at ~/.pub-cache/hosted/pub.dartlang.org/deepar_flutter-<plugin-version>/ios this will replace the DeepAR.framework already available at that path.
2. Inside your iOS project on flutter side open Podfile and add config.build_settings['EXCLUDED_ARCHS[sdk=iphonesimulator*]'] = 'arm64' (Refer example app)
3. Clean project/pub and install pods again.

VERY IMPORTANT (incase testing with iOS Simulator)

• If you had configured app to run on iOS simulator like above, when creating a release archive make sure to clean pub-cache and download the default plugin code again with already added DeepAR.framework this will ensure you are building the app against correct framework for real device.
• OR simply copy DeepAR.framework from SDK parent folder and paste it at ~/.pub-cache/hosted/pub.dartlang.org/deepar_flutter-<plugin-version>/ios

Flutter:

1. Initialize DeepArController by passing in your license keys for both platforms.

final  DeepArController _controller = DeepArController();
_controller.initialize(
	androidLicenseKey:"---android key---",
	iosLicenseKey:"---iOS key---",
	resolution: Resolution.high);

2. Place the DeepArPreview widget in your widget tree to display the preview.

@override

Widget  build(BuildContext  context) {
return  DeepArPreview(
            _controller,
            onViewCreated: () {
              // set any initial effect, filter etc
              // _controller.switchEffect(
              //     _assetEffectsPath + 'viking_helmet.deepar');
            },
          );
}

To display the preview in full screen, wrap DeepArPreview with Transform.scale() and use the correct scale factor as per preview area size. More info here.

3. Load effect of your choice by passing the asset file to it in switchPreview

_controller.switchEffect(effect);

4. To take a picture, use takeScreenshot() which return the picture as file.

final File file = await _controller.takeScreenshot();

5. To record a video, please use :

if (_controller.isRecording) {
_controller.stopVideoRecording();
} else {
final File videoFile = _controller.startVideoRecording();
}

For more info, please visit: Developer Help.