agora_rtc_engine 6.0.0-rc.2

Flutter plugin of Agora RTC SDK, allow you to simply integrate Agora Video Calling or Live Video Streaming to your app with just a few lines of code.

agora_rtc_engine

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.

NOTE

The main branch is major update base on the Agora Native SDK 4.x, which introduces some break changes. If you want to get the legacy version(the version < 6.0.0), please visit the master branch for reference.

Usage

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

Getting Started

• Get some basic and advanced examples from the example folder.

Privacy Permission

Agora Video SDK requires Camera and Microphone permission to start a video call.

Android

See the required device permissions from the AndroidManifest.xml 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" />
  <uses-permission android:name="android.permission.BLUETOOTH" />
  <uses-permission android:name="android.permission.ACCESS_WIFI_STATE" />
  <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />
  <uses-permission android:name="android.permission.WAKE_LOCK" />
  <uses-permission android:name="android.permission.READ_PRIVILEGED_PHONE_STATE"
    tools:ignore="ProtectedPermissions" />
  ...
</manifest>

iOS & macOS

Open the Info.plist and add:

• Privacy - Microphone Usage Description，and add some description into the Value column.
• Privacy - Camera Usage Description, and add some description into the Value column.

Multiple Platforms

The agora_rtc_engine supports Android/iOS/macOS/Windows, but not support Web yet.

API Reference Resources

• Flutter
• Android
• iOS/macOS
• Windows
• Web

Feedback

If you have any problems or suggestions regarding the sample projects, feel free to file an issue OR pull request.

How to contribute

To help work on this sdk, please refer to CONTRIBUTING.md.

Related resources

• Check our FAQ to see if your issue has been recorded.
• Dive into Agora SDK Samples to see more tutorials.
• Take a look at Agora Use Case for more complicated real use case.
• Repositories managed by developer communities can be found at Agora Community.
• If you encounter problems during integration, feel free to ask questions in Stack Overflow.
• Release notes.

License

The project is under the MIT license.