Skip to content

Flutter wrapper around the Agora RTC SDKs for Android and iOS

License

Notifications You must be signed in to change notification settings

eventbeep/Agora-Flutter-SDK

 
 

Repository files navigation

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

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

How to contribute

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

About

Flutter wrapper around the Agora RTC SDKs for Android and iOS

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • Dart 60.2%
  • Swift 15.1%
  • Kotlin 14.9%
  • Java 3.3%
  • C++ 3.2%
  • CMake 1.8%
  • Other 1.5%