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.

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.

Interact with RtcEngine/AgoraRtcEngineKit on Android/iOS

agora_rtc_engine has not implemented all the features of agora native (Android/iOS) sdk, due to performance reasons, such as Custom Audio Source and Renderer, Custom Video Source and Renderer, Raw Audio Data, etc. agora_rtc_engine provides RtcEnginePlugin/RtcEnginePlugin, allowing you to to interact with the RtcEngine created on the Flutter side in the Android/iOS code, you can implement your own plugin by inheriting RtcEnginePlugin/RtcEnginePlugin, and get the RtcEngine/AgoraRtcEngineKit in the onRtcEngineCreated callback. Please note that you should not call the RtcEngine.destroy/AgoraRtcEngineKit.destroy function on Android/iOS code, because it will affect the RtcEngine on the Flutter side. To see how to use RtcEnginePlugin, please check the custom audio source example:

Android：CustomAudioPlugin.kt

iOS：CustmoAudioSourcePlugin.swift

Error handling

Android build error

The error log like Could not find com.github.agorabuilder:native-full-sdk:3.4.2.

pls refer to AgoraIO-Extensions#321 (comment)

API

• Flutter API
• Android API
• iOS API

Feedback

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

How to contribute

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

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

License

The sample projects are under the MIT license.