Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/AgoraIO-Community/Agora-Flutter-Quickstart
Quickstart guide for the Agora Flutter SDK(Android/iOS)
https://github.com/AgoraIO-Community/Agora-Flutter-Quickstart
android dart flutter ios
Last synced: about 2 months ago
JSON representation
Quickstart guide for the Agora Flutter SDK(Android/iOS)
- Host: GitHub
- URL: https://github.com/AgoraIO-Community/Agora-Flutter-Quickstart
- Owner: AgoraIO-Community
- License: mit
- Created: 2019-02-04T11:46:15.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-08-08T02:50:56.000Z (over 2 years ago)
- Last Synced: 2024-08-03T06:02:35.467Z (5 months ago)
- Topics: android, dart, flutter, ios
- Language: Dart
- Homepage:
- Size: 533 KB
- Stars: 506
- Watchers: 49
- Forks: 197
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-agora - Agora Flutter Quickstart
README
# Agora Flutter Quickstart
This tutorial describes how to create an Agora account and build a sample app with Agora using [Flutter](https://flutter.io/).
## Other Languages：
[简体中文](README.zh.md)_
## Prerequisites
- Agora.io [Developer Account](https://dashboard.agora.io/signin/)
- [Flutter](https://flutter.io/) 1.0.0
## Quick Start
This repository shows you how to use Agora Flutter SDK to build a simple video call app. It demonstrates you how to:
- Join / leave a channel
- Mute / unmute audio
- Switch camera views
- Layout multiple video views
### Create an Account and Obtain an App ID
To build and run the sample application, first obtain an app ID:
1. Create a developer account at [agora.io](https://dashboard.agora.io/signin/). Once you finish the sign-up process, you are redirected to the dashboard.
2. Navigate in the dashboard tree on the left to **Projects** > **Project List**.
3. Copy the app ID that you obtain from the dashboard into a text file. You will use this when you launch the app.
### Update and Run the Sample Application
Open the [settings.dart](lib/src/utils/settings.dart) file and add the app ID.
```dart
const APP_ID = "";
```
Run the `packages get` command in your project directory:
```bash
# install dependencies
flutter pub get
```
Once the build is complete, run the `run` command to start the app.
```bash
# start app
flutter run
```
#### We recommend you to use IDE to control overall build process during development
Details about how to set up the IDE please take a look at [here](https://flutter.io/docs/get-started/editor?tab=vscode)
## Error handling
### 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](https://github.com/flutter/engine/pull/14326)
### Android Black screen
`Tips: please make sure your all configurations are correct, but still black screen`
if your MainActivity extends `io.flutter.embedding.android.FlutterActivity` and override the `configureFlutterEngine` function
please don't forget add `super.configureFlutterEngine(flutterEngine)`
please don't add `GeneratedPluginRegistrant.registerWith(flutterEngine)`, plugins will be registered auto now
[you can refer to official documents](https://flutter.dev/docs/development/packages-and-plugins/plugin-api-migration)
### Android Release crash
it causes by code obfuscation because of flutter set `android.enableR8=true` by the default
Add the following line in the **app/proguard-rules.pro** file to prevent code obfuscation:
```proguard
-keep class io.agora.**{*;}
```
## Reporting an issue
Please ensure you provide following information when you report an issue,
### Environment
#### Flutter Doctor
run `flutter doctor` and copy the log output.
#### Agora SDK Logs
Insert below code
```dart
AgoraRtcEngine.setParameters("{\"rtc.log_filter\": 65535}");
```
to `call.dart`
The eventual outcome would look like this,
```dart
...
_initAgoraRtcEngine();
_addAgoraEventHandlers();
AgoraRtcEngine.enableWebSdkInteroperability(true);
AgoraRtcEngine.setParameters('{\"che.video.lowBitRateStreamParameter\":{\"width\":320,\"height\":180,\"frameRate\":15,\"bitRate\":140}}');
AgoraRtcEngine.setParameters("{\"rtc.log_filter\": 65535}");
AgoraRtcEngine.joinChannel(null, widget.channelName, null, 0);
...
```
and then start the app. Our sdk log will print directly to console in this case.
## Resources
- Complete [API documentation](https://docs.agora.io/en/) at the Developer Center
- [File bugs about this sample](https://github.com/AgoraIO-Community/Agora-Flutter-Quickstart/issues)
- [Flutter lab: Write your first Flutter app](https://flutter.io/docs/get-started/codelab)
- [Flutter cookbook: Useful Flutter samples](https://flutter.io/docs/cookbook)
- [Flutter online documentation](https://flutter.io/docs), which offers tutorials, samples, guidance on mobile development, and a full API reference.
## Credit
https://pub.dartlang.org/packages/permission_handler
## License
This software is under the MIT License (MIT).