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
mainbranch is major update base on the Agora Native SDK 4.x, which introduces some break changes. previous releases please see the following branches(the version < 6.0.0):
To use this plugin, please add agora_rtc_engine as a dependency to
your pubspec.yaml file.
- Get some basic and advanced examples from the example folder.
Agora Video SDK requires Camera and Microphone permission to start a video call.
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>Open the Info.plist and add:
Privacy - Microphone Usage Description，and add some description into theValuecolumn.Privacy - Camera Usage Description, and add some description into theValuecolumn.
The
agora_rtc_enginefor web is currently in alpha stage, and the documentation is incomplete and it has only been tested on desktop web at this time.The
agora_rtc_engineweb is built on top of iris_web, a wrapper for the Agora Web SDK 4.x. This helps align the Native SDK (Android/iOS/macOS/Windows) APIs through the Agora Web SDK 4.x. Please note that the agora_rtc_engine web utilizes the Agora Web SDK 4.x underneath, so only a subset of the Native SDK APIs can be implemented on the web. If the APIs returnAgoraRtcExceptionwith a-4error code, this means these APIs are not supported at this time.
Download the iris_web(see the link below) artifact and include it as a <script /> tag in your <your-project>/web/index.html file. For example:
Project structure
<your-project>
|__web
|__index.html
|__iris-web-rtc_<x.y.z>.js
<!-- <your-project>/web/index.html -->
<!DOCTYPE html>
<html>
...
<body>
...
<script src="iris-web-rtc_<x.y.z>.js"></script>
</body>
</html>Download: https://download.agora.io/staging/iris-web-rtc_n423_w4182_0.3.0.js
For Testing Purposes
You can directly depend on the Agora CDN for testing purposes:
<!-- <your-project>/web/index.html -->
<!DOCTYPE html>
<html>
...
<body>
...
<script src="https://download.agora.io/staging/iris-web-rtc_n423_w4182_0.3.0.js"></script>
</body>
</html>If you have any problems or suggestions regarding the sample projects, feel free to file an issue OR pull request.
To help work on this sdk, please refer to CONTRIBUTING.md.
- 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.
The project is under the MIT license.
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "github-actions[bot]")
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent