agora_uikit 0.0.2 agora_uikit: ^0.0.2 copied to clipboard
Flutter plugin to simply integrate Agora Video Calling or Live Video Streaming to your app with just a few lines of code.
Agora UI Kit for Flutter #
Instantly integrate Agora video calling or video streaming into your Flutter application.
Getting started #
Requirements #
- An Agora developer account
- 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:
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.
<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 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 #
final AgoraClient client = AgoraClient(
agoraConnectionData: AgoraConnectionData(
appId: "<--Add Your App Id Here-->",
channelName: "test",
),
enabledPermission: [
Permission.camera,
Permission.microphone,
],
);
@override
Widget build(BuildContext context) {
return MaterialApp(
home: Scaffold(
body: SafeArea(
child: Stack(
children: [
AgoraVideoViewer(client: client),
AgoraVideoButtons(client: client),
],
),
),
),
);
}
UIKits #
The plan is to grow this library and have similar offerings across all supported platforms. There are already similar libraries for Android, React Native, and iOS, so be sure to check them out.