agora_rtc_engine 3.0.1-dev.3

Flutter plugin for Agora Video SDK.

agora_rtc_engine

This Flutter plugin is a wapper for Agora Video SDK.

Agora.io provides building blocks for you to add real-time voice and video communications through a simple and powerful SDK. You can integrate the Agora SDK to enable real-time communications in your own application quickly.

Note: This plugin is still under development, and some APIs might not be available yet.

Usage

To use this plugin, add agora_rtc_engine as a dependency in your pubspec.yaml file.

Getting Started

• See the example directory for a sample app using AgoraRtcEngine.
• Or checkout this tutorial for a simple video call app using Agora Flutter SDK.

Device Permission

Agora Video SDK requires camera and microphone permission to start video call.

Android

Open the AndroidManifest.xml file and add the required device permissions to the file.

<manifest>
    ...
    <uses-permission android:name="android.permission.READ_PHONE_STATE"/>
    <uses-permission android:name="android.permission.INTERNET" />
    <uses-permission android:name="android.permission.RECORD_AUDIO" />
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
    
    <!-- The Agora SDK requires Bluetooth permissions in case users are using Bluetooth devices.-->
    <uses-permission android:name="android.permission.BLUETOOTH" />
    ...
</manifest>

iOS

Open the info.plist and add:

• Privacy - Microphone Usage Description, and add a note in the Value column.
• Privacy - Camera Usage Description, and add a note in the Value column.

Your application can still run the voice call when it is switched to the background if the background mode is enabled. Select the app target in Xcode, click the Capabilities tab, enable Background Modes, and check Audio, AirPlay, and Picture in Picture.

Error handling

iOS black screen

Our SDK use PlatformView, you should set io.flutter.embedded_views_preview to YES in your info.plist

iOS memory leak

If your flutter channel is stable, PlatformView will cause memory leak, you can run flutter channel beta

You can refer to this pull request

Android black screen

Tips: please make sure your all configurations are correct, but still black screen

If your MainActivity extends io.flutter.embedding.android.FlutterActivity and override the configureFlutterEngine method

stable flutter channel

The FlutterEngine class will register all plugins auto

The GeneratedPluginRegistrant.registerWith(flutterEngine) method has been added by default, so it causes the plugin register twice, our SDK may not work

If you remove the GeneratedPluginRegistrant.registerWith(flutterEngine) method, so some other plugins may not work because the plugin can't get the activity instance when register by FlutterEngine,

We suggest you don't use the stable channel, because the iOS platform also has memory leak bug

others flutter channel

The io.flutter.embedding.android.FlutterActivity will register all plugins auto by the configureFlutterEngine method

• Don't forget add super.configureFlutterEngine(flutterEngine)
• Don't add GeneratedPluginRegistrant.registerWith(flutterEngine)

You can refer to the official documents

Android Release crash

It causes by code obfuscation because of flutter set android.enableR8=true by the default

Add the following line in the app/proguard-rules.pro file to prevent code obfuscation:

-keep class io.agora.**{*;}

API

• Flutter API
• Android API
• iOS API

How to contribute

To help work on this sdk, see our contributor guide.