videosdk 5.0.0-beta.2
videosdk: ^5.0.0-beta.2 copied to clipboard
Video SDK Flutter to simply integrate Audio & Video Calling API or Live Video Streaming API to your app with just a few lines of code.
Video SDK Flutter #
Video SDK Flutter to simply integrate Audio & Video Calling API or Live Video Streaming API to your app with just a few lines of code.
Upgrading from 3.12.x? Your Dart code does not change — every exported type keeps the same name and signature. There are four setup items to check, and Web/macOS/Windows are not in 4.0 yet. See MIGRATION.md.
Functionality #
4.0 runs the meeting on VideoSDK's native Android and iOS SDKs. Web, macOS and
Windows are not supported in this release — stay on 3.12.x for those; see
MIGRATION.md.
| Feature | Android | iOS |
|---|---|---|
| Audio/Video | ✓ | ✓ |
| Recorder | ✓ | ✓ |
| HLS | ✓ | ✓ |
| RTMP Live | ✓ | ✓ |
| Simulcast | ✓ | ✓ |
| Screen Share | ✓ | ✓ |
| Transcription & Translation | ✓ | ✓ |
| PubSub & Realtime Store | ✓ | ✓ |
| Whiteboard | ✓ | ✓ |
| End-to-end encryption | planned for 4.1 | planned for 4.1 |
Getting Started #
Setup Guide #
Add videosdk as a dependency in your pubspec.yaml file.
Android Setup #
Update AndroidManifest.xml file for the permissions #
Ensure the following permission is present in your Android Manifest file, located in <project root>/android/app/src/main/AndroidManifest.xml:
<uses-feature android:name="android.hardware.camera" />
<uses-feature android:name="android.hardware.camera.autofocus" />
<uses-permission android:name="android.permission.INTERNET"/>
<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.WAKE_LOCK" />
If you need to use a Bluetooth device, please add:
<uses-permission android:name="android.permission.BLUETOOTH" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
The Flutter project template adds it, so it may already be there.
Also you will need to set your build settings to Java 17, because official WebRTC jar now uses static methods in EglBase interface. Just add this to your app level build.gradle:
android {
//...
compileOptions {
sourceCompatibility JavaVersion.VERSION_17
targetCompatibility JavaVersion.VERSION_17
}
}
If necessary, in the same
build.gradleyou will need to increaseminSdkVersionofdefaultConfigup to26(currently default Flutter generator set it to23).
If necessary, in the same
build.gradleyou will need to increasecompileSdkVersionandtargetSdkVersionup to36(currently default Flutter generator set it to33).
iOS Setup #
- Add the following entry to your Info.plist file, located in
<project root>/ios/Runner/Info.plist:
<key>NSCameraUsageDescription</key>
<string>$(PRODUCT_NAME) Camera Usage!</string>
<key>NSMicrophoneUsageDescription</key>
<string>$(PRODUCT_NAME) Microphone Usage!</string>
This entry allows your app to access camera and microphone.
- Update the minimum iOS platform version to
13.0. You can update it in theios/Podfile.
platform: ios, "13.0";
- The iOS side ships as a Swift Package. If your project is CocoaPods-only, turn on Flutter's SPM support once:
flutter config --enable-swift-package-manager
- Screen sharing uses ReplayKit and needs a Broadcast Upload Extension in your app, plus
RTCScreenSharingExtensionandRTCAppGroupIdentifierin yourInfo.plist. The extension has to be signed with your own team and bundle id, so the SDK cannot ship one — MIGRATION.md has the steps andexample/has a working setup.
macOS Setup #
Not applicable to 4.0 — macOS is not supported in this release. These steps are kept for apps on
3.12.xand for when the platform returns.
These entries allows your app to access camera, microphone and open outgoing network connections.
- Add the following entry to your
Info.plistfile, located in<project root>/macos/Runner/Info.plist:
<key>NSCameraUsageDescription</key>
<string>$(PRODUCT_NAME) Camera Usage!</string>
<key>NSMicrophoneUsageDescription</key>
<string>$(PRODUCT_NAME) Microphone Usage!</string>
- Add the following entry to your
DebugProfile.entitlementsfile, located in<project root>/macos/Runner/DebugProfile.entitlements:
<key>com.apple.security.network.client</key>
<true/>
<key>com.apple.security.device.camera</key>
<true/>
<key>com.apple.security.device.microphone</key>
<true/>
- Add the following entry to your
Release.entitlementsfile, located in<project root>/macos/Runner/Release.entitlements:
<key>com.apple.security.network.server</key>
<true/>
<key>com.apple.security.network.client</key>
<true/>
<key>com.apple.security.device.camera</key>
<true/>
<key>com.apple.security.device.microphone</key>
<true/>
Import it #
Now in your Dart code, you can use:
import "package:videosdk/videosdk.dart";