https://github.com/waterbustech/waterbus-flutter-sdk
Flutter SDK for real-time audio/video with Waterbus.
https://github.com/waterbustech/waterbus-flutter-sdk
av1-codec conferencing flutter flutter-sdk flutter-webrtc realtime-messaging video video-call voip webrtc webrtc-video websocket
Last synced: 8 months ago
JSON representation
Flutter SDK for real-time audio/video with Waterbus.
- Host: GitHub
- URL: https://github.com/waterbustech/waterbus-flutter-sdk
- Owner: waterbustech
- License: apache-2.0
- Created: 2023-10-30T03:40:45.000Z (over 2 years ago)
- Default Branch: migration/v3
- Last Pushed: 2025-06-11T08:45:39.000Z (about 1 year ago)
- Last Synced: 2025-06-19T02:46:03.103Z (12 months ago)
- Topics: av1-codec, conferencing, flutter, flutter-sdk, flutter-webrtc, realtime-messaging, video, video-call, voip, webrtc, webrtc-video, websocket
- Language: Dart
- Homepage: https://docs.waterbus.tech
- Size: 3.87 MB
- Stars: 29
- Watchers: 2
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Flutter [Waterbus](https://docs.waterbus.tech) SDK
Flutter plugin of [Waterbus](https://docs.waterbus.tech). Build video call or online meeting application with SFU model. Supports iOS, Android. [ExampleApp](https://github.com/waterbustech/waterbus)
## ⚡ Current supported features
| Feature | Subscribe/Publish | Screen Sharing | Picture in Picture | Virtual Background | Beauty Filters | End to End Encryption |
| ------------------ | ----------------- | -------------- | ------------------ | ------------------ | -------------- | --------------------- |
| Android | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 |
| iOS | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 | 🟢 |
| Web | 🟢 | 🟢 | 🟢 | 🟢 | 🟡 | 🟢 |
| MacOS | 🟢 | 🟢 | 🔴 | 🟢 | 🟢 | 🟢 |
| Linux | 🟢 | 🟢 | 🔴 | 🟡 | 🟢 | 🟢 |
| Windows | 🟢 | 🟢 | 🔴 | 🟡 | 🟢 | 🟢 |
🟢 = Available
🟡 = Coming soon (Work in progress)
🔴 = Not currently available (Possibly in the future)
## Installation
### Install Rust via [rustup](https://rustup.rs/).
### Add dependency
Add the dependency from command-line
```bash
$ flutter pub add waterbus_sdk
```
The command above will add this to the `pubspec.yaml` file in your project (you can do this manually):
```yaml
dependencies:
waterbus_sdk: ^1.3.15
```
## Configuration
### Android
Ensure the following permission is present in your Android Manifest file, located in `/android/app/src/main/AndroidManifest.xml`:
```xml
```
If you need to use a Bluetooth device, please add:
```xml
```
The Flutter project template adds it, so it may already be there.
Also you will need to set your build settings to Java 8, because official WebRTC jar now uses static methods in `EglBase` interface. Just add this to your app level `build.gradle`:
```groovy
android {
//...
compileOptions {
sourceCompatibility JavaVersion.VERSION_1_8
targetCompatibility JavaVersion.VERSION_1_8
}
}
```
### iOS
Add the following entry to your _Info.plist_ file, located in `/ios/Runner/Info.plist`:
```xml
NSCameraUsageDescription
$(PRODUCT_NAME) Camera Usage!
NSMicrophoneUsageDescription
$(PRODUCT_NAME) Microphone Usage!
```
This entry allows your app to access camera and microphone.
### Note for iOS.
The WebRTC.xframework compiled after the m104 release no longer supports iOS arm devices, so need to add the `config.build_settings['ONLY_ACTIVE_ARCH'] = 'YES'` to your ios/Podfile in your project
ios/Podfile
```ruby
post_install do |installer|
installer.pods_project.targets.each do |target|
flutter_additional_ios_build_settings(target)
target.build_configurations.each do |config|
# Workaround for https://github.com/flutter/flutter/issues/64502
config.build_settings['ONLY_ACTIVE_ARCH'] = 'YES' # <= this line
end
end
end
```
## Usage
## Initialization
Before using any feature, initialize the SDK with server and encryption config:
```dart
import 'package:waterbus_sdk/waterbus_sdk.dart';
void main() async {
final config = SdkConfig(
serverConfig: ServerConfig(
url: "https://services.waterbus.tech",
suffixUrl: "/busapi/v3/",
),
messageEncryptionKey: 'your-secret-message-key',
webrtcE2eeKey: 'your-e2ee-key',
);
await WaterbusSdk.instance.initialize(config: config);
}
```
---
## Authentication
### Create Token
Create a new session using a token:
```dart
final Result result = await WaterbusSdk.instance.createToken(
AuthPayload(fullName: "Waterbus", externalId: "unique-id"),
);
```
### Refresh Token
```dart
await WaterbusSdk.instance.renewToken();
```
### Delete Token
Delete token for disconnect websocket and prepare for create new token
```dart
await WaterbusSdk.instance.deleteToken();
```
---
## User Management
### Get user profile
```dart
final profile = await WaterbusSdk.instance.getProfile();
```
### Update profile
```dart
await WaterbusSdk.instance.updateProfile(user: updatedUser);
```
### Change username
```dart
await WaterbusSdk.instance.updateUsername(username: "new_username");
```
## Room Management
### Create room
```dart
final RoomParams params = RoomParams(
room: Room(title: 'Daily Meeting'),
password: '123123',
userId: 'user-id',
);
final result = await WaterbusSdk.instance.createRoom(params: params);
```
### Join room
```dart
final JoinRoomParams params = JoinRoomParams(
roomId: 'room-id',
password: 123123',
userId: 'user-id',
);
final Result result = await WaterbusSdk.instance.joinRoom(params: params);
```
### Leave room
```dart
await WaterbusSdk.instance.leaveRoom();
```
## Media Controls
```dart
await WaterbusSdk.instance.prepareMedia();
await WaterbusSdk.instance.toggleVideo();
await WaterbusSdk.instance.toggleAudio();
await WaterbusSdk.instance.switchCamera();
```
### Screen sharing
```dart
await WaterbusSdk.instance.startScreenSharing();
// Stop
await WaterbusSdk.instance.stopScreenSharing();
```
### Raise or lower hand
```dart
WaterbusSdk.instance.toggleRaiseHand();
```
### Virtual Background
```dart
await WaterbusSdk.instance.enableVirtualBackground(
backgroundImage: yourImageBytes,
thresholdConfidence: 0.7,
);
// Disable:
await WaterbusSdk.instance.disableVirtualBackground();
```
## Additional Utilities
Get supported codecs
```dart
final codecs = await WaterbusSdk.instance.getSupportedVideoCodecs();
```
Picture-in-Picture
```dart
await WaterbusSdk.instance.setPictureInPictureEnabled(
textureId: 'your_texture_id',
enabled: true,
);
```
## Contributing
Contributions are welcome! Please feel free to submit a pull request or open an issue if you encounter any problems or have suggestions for improvements.
## Contact Information
If you have any questions or suggestions related to this application, please contact me via email: lambiengcode@gmail.com.
## Reference
[flutter_webrtc](https://github.com/flutter-webrtc/flutter-webrtc)
## License
Apache License 2.0