agora_rtc_engine 3.1.2

Flutter Android iOS

Flutter plugin for Agora Video SDK.

agora_rtc_engine #

pub package

中文

This Flutter plugin is a wrapper 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.

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 about one to one video chat app which using agora_rtc_engine.
  • Or checkout this Tutorial for a sample about live broadcasting app which using agora_rtc_engine.

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 video cant show (Android works fine) #

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

API #

How to contribute #

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