Skip to content

Commit 19d5d4a

Browse files
cloudwebrtccloudwebrtc
committed
update.
1 parent e9c8ab8 commit 19d5d4a

File tree

16 files changed

+271
-83
lines changed

16 files changed

+271
-83
lines changed

‎README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,13 @@ GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy
3131
```
3232

3333
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
34+
35+
## i18n
36+
37+
```console
38+
npm run write-translations -- --locale zh-cn
39+
```
40+
41+
```console
42+
npm run start -- --locale zh-cn
43+
```

‎docs/dart-sip-ua/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Dart SIP UA - API",
2+
"label": "Dart SIP UA",
33
"position": 3
44
}

‎docs/dart-sip-ua/introduction.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Introduction
6+
7+
Dart SIP UA is a SIP protocol stack developed by dart-lang. You can use it to develop cross-platform VOIP applications. This project relies on the flutter-webrtc plugin, so you can get a high-quality audio and video call experience. SIP signaling uses WSS ( WebSocket Secure), all data is encrypted, you don't need to worry about eavesdropping on the call.
8+
9+
## Overview
10+
11+
- Use pure [dart-lang](https://dart.dev)
12+
- SIP over WebSocket (use real SIP in your flutter mobile, [desktop](https://flutter.dev/desktop), [web](https://flutter.dev/web) apps)
13+
- High-quality Audio/video calls ([flutter-webrtc](https://github.com/cloudwebrtc/flutter-webrtc)) and instant messaging
14+
- Support with standard SIP servers such as OpenSIPS, Kamailio, Asterisk and FreeSWITCH.
15+
- Support RFC2833 or INFO to send DTMF.
16+
17+
## Thanks
18+
19+
Thanks to the original authors of [JsSIP](https://github.com/versatica/JsSIP) for developed the JS version, which makes it possible to port the [dart-lang](https://dart.dev) version.
20+
21+
- [José Luis Millán](https://github.com/jmillan)
22+
- [Iñaki Baz Castillo](https://github.com/ibc)
23+
- [Saúl Ibarra Corretgé](https://github.com/saghul)
24+
25+
## Sponsors
26+
27+
The first version was sponsored by Suretec Systems Ltd. T/A [SureVoIP](https://www.surevoip.co.uk).

‎docs/dart-sip-ua/manage-docs-versions.md

Lines changed: 0 additions & 55 deletions
This file was deleted.

‎docs/docs.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,9 @@ Let's discover **Flutter-WebRTC in less than 5 minutes**.
1212

1313
Flutter-WebRTC community is an open source project derived from the [dart/flutter](https://flutter.dev/) framework. We packaged the [WebRTC](https://webrtc.org/) library into a flutter plugin to create modern WebRTC/VoIP applications that can cross all platforms.
1414

15+
We have developed the dart-lang version of the SIP protocol stack, so you can develop cross-platform VOIP applications in easy way.
16+
17+
All projects use MIT license agreement, You can use it freely in the project. If you make a profit from this project, please [sponsor this project](https://opencollective.com/flutter-webrtc).
1518

1619
### Projects under maintenance
1720

@@ -21,10 +24,13 @@ Flutter-WebRTC community is an open source project derived from the [dart/flutte
2124
- [flutter-webrtc-server](https://github.com/flutter-webrtc/flutter-webrtc-server) - A simple WebRTC signaling server for flutter-webrtc.
2225
- [flutter-webrtc-demo](https://github.com/flutter-webrtc/flutter-webrtc-demo) - Simple p2p call example based on flutter-webrtc.
2326

24-
### About this Docs.
27+
### About this Docs
2528

2629
This document site will cover all projects under the Flutter-WebRTC community.
2730

28-
### How to help the open source community？
29-
31+
### How to contribute to this projects
3032

33+
- Create an issue with related PR.
34+
- Help others when you can solve a issue.
35+
- Translate documents to other languages.
36+
- Provide [financial sponsorship](https://opencollective.com/flutter-webrtc).

‎docs/flutter-webrtc/_category_.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Flutter WebRTC - API",
2+
"label": "Flutter WebRTC",
33
"position": 2
44
}

‎docs/flutter-webrtc/get-stared.md

Lines changed: 115 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
---
2+
sidebar_position: 2
3+
---
4+
5+
# Get Started
6+
7+
Please refer to https://flutter.dev/docs to deploy the Flutter development environment.
8+
9+
and make sure your Flutter SDK version is 2.x
10+
11+
## Usage
12+
13+
Add `flutter_webrtc` as a [dependency in your pubspec.yaml file](https://flutter.io/using-packages/).
14+
15+
You can find the latest version here [![pub package](https://img.shields.io/pub/v/flutter_webrtc.svg)](https://pub.dartlang.org/packages/flutter_webrtc)
16+
17+
```yaml
18+
flutter_webrtc: ^x.y.z
19+
```
20+
21+
then run `flutter pub get` in your project.
22+
23+
## Platform related settings
24+
25+
### iOS
26+
27+
Add the following entry to your _Info.plist_ file,
28+
29+
located in `<project root>/ios/Runner/Info.plist`:
30+
31+
```xml
32+
<key>NSCameraUsageDescription</key>
33+
<string>$(PRODUCT_NAME) Camera Usage!</string>
34+
<key>NSMicrophoneUsageDescription</key>
35+
<string>$(PRODUCT_NAME) Microphone Usage!</string>
36+
```
37+
38+
This entry allows your app to access camera and microphone.
39+
40+
### Android
41+
42+
Ensure the following permission is present in your Android Manifest file,
43+
44+
located in `<project root>/android/app/src/main/AndroidManifest.xml`:
45+
46+
```xml
47+
<uses-feature android:name="android.hardware.camera" />
48+
<uses-feature android:name="android.hardware.camera.autofocus" />
49+
<uses-permission android:name="android.permission.CAMERA" />
50+
<uses-permission android:name="android.permission.RECORD_AUDIO" />
51+
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
52+
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
53+
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
54+
```
55+
56+
If you need to use a Bluetooth device, please add:
57+
58+
```xml
59+
<uses-permission android:name="android.permission.BLUETOOTH" />
60+
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" />
61+
```
62+
63+
The Flutter project template adds it, so it may already be there.
64+
65+
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`:
66+
67+
```groovy
68+
android {
69+
//...
70+
compileOptions {
71+
sourceCompatibility JavaVersion.VERSION_1_8
72+
targetCompatibility JavaVersion.VERSION_1_8
73+
}
74+
}
75+
```
76+
77+
If necessary, in the same `build.gradle` you will need to increase `minSdkVersion` of `defaultConfig` up to `21` (currently default Flutter generator set it to `16`).
78+
79+
### Important reminder
80+
81+
When you compile the release apk, you need to add the following operations,
82+
83+
Edit `<project root>/android/app/build.gradle`
84+
85+
```diff
86+
buildTypes {
87+
release {
88+
// TODO: Add your own signing config for the release build.
89+
// Signing with the debug keys for now, so `flutter run --release` works.
90+
signingConfig signingConfigs.debug
91+
92+
+ minifyEnabled true
93+
+ useProguard true
94+
+
95+
+ proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
96+
}
97+
}
98+
```
99+
100+
And create new file `<project root>/android/app/proguard-rules.pro`
101+
102+
```
103+
## Flutter wrapper
104+
-keep class io.flutter.app.** { *; }
105+
-keep class io.flutter.plugin.** { *; }
106+
-keep class io.flutter.util.** { *; }
107+
-keep class io.flutter.view.** { *; }
108+
-keep class io.flutter.** { *; }
109+
-keep class io.flutter.plugins.** { *; }
110+
-dontwarn io.flutter.embedding.**
111+
112+
## Flutter WebRTC
113+
-keep class com.cloudwebrtc.webrtc.** { *; }
114+
-keep class org.webrtc.** { *; }
115+
```

‎docs/flutter-webrtc/introduction.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,4 +4,21 @@ sidebar_position: 1
44

55
# Introduction
66

7-
Docusaurus can manage multiple versions of your docs.
7+
We package this plug-in based on Google WebRTC, and you will have high-quality audio and video calls. Using this plug-in, you can develop p2p calls, video conferences, live broadcasts, online education, etc.
8+
9+
Flutter-WebRTC is a cross-platform plugin, the platform support is as follows.
10+
11+
## Functionality And Platform Support
12+
13+
[![pub package](https://img.shields.io/pub/v/flutter_webrtc.svg)](https://pub.dartlang.org/packages/flutter_webrtc)
14+
15+
| Feature | Android | iOS | [Web](https://flutter.dev/web) | macOS | Windows | Linux | [Fuchsia](https://fuchsia.dev/) | [Embedded](https://github.com/sony/flutter-embedded-linux) |
16+
| :-------------: | :-------------:| :-----: | :-----: | :-----: | :-----: | :-----: | :-----: | :-----: |
17+
| Audio/Video | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | [WIP] | | |
18+
| Data Channel | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | [WIP] | | |
19+
| Screen Capture | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | | | | | |
20+
| Unified-Plan | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | [WIP] | | | |
21+
| Simulcast | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | [WIP] | | | |
22+
| MediaRecorder| :warning: | :warning: | :heavy_check_mark: | | | | | |
23+
24+
We are trying to port the flutter-webrtc plugin for more platforms. In the near future, we will port this plugin for embedded platforms.

‎docs/fqa.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
sidebar_position: 9
3+
---
4+
5+
# FQA

‎docs/intro.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
sidebar_position: 4
33
---
44

5-
# Tutorial Intro
5+
# Tutorial
66

77
Let's discover **Docusaurus in less than 5 minutes**.
88

‎docusaurus.config.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,11 @@ module.exports = {
3535
label: 'Docs',
3636
},
3737
{to: '/blog', label: 'Blog', position: 'left'},
38+
{
39+
href: 'https://opencollective.com/flutter-webrtc',
40+
label: 'Sponsor',
41+
position: 'left',
42+
},
3843
{
3944
href: 'https://github.com/flutter-webrtc',
4045
label: 'GitHub',

‎i18n/zh-cn/code.json

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -167,5 +167,32 @@
167167
},
168168
"Make WebRTC/VoIP development easier.": {
169169
"message": "让WebRTC/VoIP 应用开发更容易."
170+
},
171+
"homepage.features.modern-and-simple.title": {
172+
"message": "现代 & 简单",
173+
"description": "Title of features on the home page"
174+
},
175+
"Develop WebRTC/VoIP app for multi-platform the easy way.": {
176+
"message": "用简单的方式开发WebRTC/VoIP应用"
177+
},
178+
"homepage.features.modern-and-simple.description": {
179+
"message": "基于Flutter框架,使得开发跨平台WebRTC/VoIP应用变得容易, 用更少的代码开发更漂亮的应用.",
180+
"description": "Description of features on the home page"
181+
},
182+
"homepage.features.one-codebase-simple.title": {
183+
"message": "一套代码, 更多平台",
184+
"description": "Title of features on the home page"
185+
},
186+
"homepage.features.one-codebase.description": {
187+
"message": "支持移动端 (iOS, Android), 桌面(Windows, macOS, Linux) 和网页端, 甚至可以是嵌入式开发板.",
188+
"description": "Description of features on the home page"
189+
},
190+
"homepage.features.standardized-integeratable-simple.title": {
191+
"message": "标准化 和 互通性",
192+
"description": "Title of features on the home page"
193+
},
194+
"homepage.features.standardized-integeratable.description": {
195+
"message": "参考 W3C WebRTC API 封装以及互通性支持, 您只需参考文档便可与您的 WebRTC/SIP 服务进行互通.",
196+
"description": "Description of features on the home page"
170197
}
171198
}

‎i18n/zh-cn/docusaurus-plugin-content-docs/current.json

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,19 @@
44
"description": "The label for version current"
55
},
66
"sidebar.tutorialSidebar.category.Flutter WebRTC - API": {
7-
"message": "Flutter WebRTC - API",
7+
"message": "Flutter WebRTC",
88
"description": "The label for category Flutter WebRTC - API in sidebar tutorialSidebar"
99
},
1010
"sidebar.tutorialSidebar.category.Dart SIP UA - API": {
11-
"message": "Dart SIP UA - API",
11+
"message": "Dart SIP UA",
1212
"description": "The label for category Dart SIP UA - API in sidebar tutorialSidebar"
13+
},
14+
"sidebar.tutorialSidebar.category.Flutter WebRTC": {
15+
"message": "Flutter WebRTC",
16+
"description": "The label for category Flutter WebRTC in sidebar tutorialSidebar"
17+
},
18+
"sidebar.tutorialSidebar.category.Dart SIP UA": {
19+
"message": "Dart SIP UA",
20+
"description": "The label for category Dart SIP UA in sidebar tutorialSidebar"
1321
}
1422
}

‎i18n/zh-cn/docusaurus-theme-classic/navbar.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,5 +14,9 @@
1414
"item.label.GitHub": {
1515
"message": "GitHub",
1616
"description": "Navbar item with label GitHub"
17+
},
18+
"item.label.Sponsor": {
19+
"message": "Sponsor",
20+
"description": "Navbar item with label Sponsor"
1721
}
1822
}

0 commit comments

Comments
 (0)