https://github.com/AgoraIO-Community/VideoUIKit-Flutter
Flutter plugin to simply integrate Agora Video Calling or Live Video Streaming to your app with just a few lines of code.
https://github.com/AgoraIO-Community/VideoUIKit-Flutter
agora agora-flutter agora-sdk agoraio android flutter hacktoberfest ios rtc video-call
Last synced: 8 months ago
JSON representation
Flutter plugin to simply integrate Agora Video Calling or Live Video Streaming to your app with just a few lines of code.
- Host: GitHub
- URL: https://github.com/AgoraIO-Community/VideoUIKit-Flutter
- Owner: AgoraIO-Community
- License: mit
- Archived: true
- Created: 2021-06-17T14:02:02.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-11-05T20:59:43.000Z (11 months ago)
- Last Synced: 2024-11-05T21:41:33.413Z (11 months ago)
- Topics: agora, agora-flutter, agora-sdk, agoraio, android, flutter, hacktoberfest, ios, rtc, video-call
- Language: Dart
- Homepage: https://agora-flutter-uikit.vercel.app/
- Size: 712 KB
- Stars: 141
- Watchers: 9
- Forks: 81
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# [ARCHIVED] Agora VideoUIKit for Flutter
**⚠️ This project is no longer maintained and has been archived.**
Please note that this repository is now in a read-only state and will not receive any further updates or support.
We recommend migrating to the following alternatives:
- **Agora SDK**: For developers seeking a customizable solution with full control over the user experience. [Learn more](https://www.agora.io/en/products/video-call/)
- **Agora App Builder**: For those preferring a no-code approach to integrate real-time engagement features. [Get started](https://appbuilder.agora.io/)
For documentation and support, please visit the [Agora Documentation](https://docs.agora.io/en/).
Instantly integrate Agora video calling or video streaming into your Flutter application.
> NOTE: The Flutter VideoUIKit( >version 1.1.0) uses the latest version of the Agora 4.x SDK. To know more about the changes and the new features in the 4.x SDK, kindly take a look at the [docs](https://docs.agora.io/en/video-calling/reference/release-notes?platform=flutter).
## Getting started
### Roadmap
- [ ] Add Usernames
- [x] More Event Callbacks
- [x] Add RTM SDK
- [x] Screen Sharing (Currently in Beta)
- [x] Layout for One to One Video Call
- [ ] Layout for Voice Calls
- [ ] Re-orderable list view (Floating Layout)
- [ ] Cloud recording
- [ ] Promoting an audience member to a broadcaster role.
- [x] Muting/Unmuting a remote member
- [x] Flutter Web Support as a pre-release
- [ ] Flutter Desktop Support as a pre-release
### Requirements
- [An Agora developer account](https://www.agora.io/en/blog/how-to-get-started-with-agora)
- An Android or iOS Device
- A Flutter Project
### Installation
In your Flutter application, add the `agora_uikit` as a dependency inside your `pubspec.yaml` file.
In your Android level `build.gradle` add this at the end of the repositories:
```css
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
### 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.
```xml
...
...
```
#### iOS
Open `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.
## Usage
```dart
// Instantiate the client
final AgoraClient client = AgoraClient(
agoraConnectionData: AgoraConnectionData(
appId: "<--Add Your App Id Here-->",
channelName: "test",
),
);
// Initialize the Agora Engine
@override
void initState() {
super.initState();
initAgora();
}
void initAgora() async {
await client.initialize();
}
// Build your layout
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
body: SafeArea(
child: Stack(
children: [
AgoraVideoViewer(client: client),
AgoraVideoButtons(client: client),
],
),
),
),
);
}
```
## VideoUIKits
The plan is to grow this library and have similar offerings across all supported platforms. There are already similar libraries for [Android](https://github.com/AgoraIO-Community/VideoUIKit-Android/), [iOS](https://github.com/AgoraIO-Community/VideoUIKit-iOS/), [React Native](https://github.com/AgoraIO-Community/ReactNative-UIKit), and [Web React](https://github.com/AgoraIO-Community/VideoUIKit-Web-React), so be sure to check them out.