Master

.gitignore

@@ -1,6 +1,12 @@
 # Dependency directory
 # https://www.npmjs.org/doc/misc/npm-faq.html#should-i-check-my-node_modules-folder-into-git
 node_modules
-ios/RCTWebRTC.xcodeproj/xcuserdata
-ios/RCTWebRTC.xcodeproj/project.xcworkspace
+xcuserdata
+project.xcworkspace
 .DS_Store
+.idea
+android/build
+Podfile.lock
+WebRTC.xcframework
+WebRTC.dSYMs
+

.npmignore

@@ -0,0 +1,5 @@
+Documentation/
+examples/
+apple/WebRTC.xcframework
+apple/WebRTC.dSYMs
+

Documentation/AndroidInstallation.md

@@ -1,70 +1,96 @@
+## Android installation
 
+`npm install react-native-webrtc --save`  
 
-1.) In `android/app/src/main/AndroidManifest.xml` add these permissions
+Starting with React Native 0.60 auto-linking works out of the box, so there are no extra steps.
 
-```xml
-<uses-permission android:name="android.permission.CAMERA" />
-<uses-feature android:name="android.hardware.camera" />
-<uses-feature android:name="android.hardware.camera.autofocus"/>
-
-<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE"/>
-<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
-<uses-permission android:name="android.permission.RECORD_AUDIO" />
-<uses-permission android:name="android.permission.WAKE_LOCK" />
-<uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
-```
+See a sample app in the `examples/GumTestApp` directory.
+
+### Manual linking
+
+This is not needed with React Native >= 0.60.
+
+<details><summary>Show instructions</summary>
+
+In `android/settings.gradle`, add WebRTCModule:
 
-2.) In `android/settings.gradle`, includes WebRTCModule
 ```gradle
 include ':WebRTCModule', ':app'
 project(':WebRTCModule').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-webrtc/android')
 ```
 
-3.) In `android/app/build.gradle`, add WebRTCModule to dependencies
+In `android/app/build.gradle`, add WebRTCModule to dependencies:
+
 ```gradle
 dependencies {
   ...
   compile project(':WebRTCModule')
 }
-
 ```
 
-4.) In `android/app/src/main/java/com/xxx/MainApplication.java`
+In your `MainApplication.java`:
 
-After 0.19.0
 ```java
-import com.oney.WebRTCModule.WebRTCModulePackage;  // <--- Add this line
-...
-    @Override
-    protected List<ReactPackage> getPackages() {
-      return Arrays.<ReactPackage>asList(
+@Override
+protected List<ReactPackage> getPackages() {
+    return Arrays.<ReactPackage>asList(
         new MainReactPackage(),
-        new WebRTCModulePackage()                  // <--- Add this line
-      );
-    }
+        new com.oney.WebRTCModule.WebRTCModulePackage() // <-- Add this line
+    );
+}
 ```
-Before 0.18.0
-```java
-import com.oney.WebRTCModule.WebRTCModulePackage;  // <--- Add this line
-...
 
- public class MainActivity extends Activity implements DefaultHardwareBackBtnHandler {
- ...
+</details>
+
+### Declaring permissions
+
+Locate your app's `AndroidManifest.xml` file and add these permissions:
+
+```xml
+    <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+    <uses-permission android:name="android.permission.BLUETOOTH" />
+    <uses-permission android:name="android.permission.CAMERA" />
+    <uses-permission android:name="android.permission.INTERNET" />
+    <uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
+    <uses-permission android:name="android.permission.RECORD_AUDIO" />
+    <uses-permission android:name="android.permission.SYSTEM_ALERT_WINDOW" />
+    <uses-permission android:name="android.permission.WAKE_LOCK" />
+```
+
+### Enable Java 8 support
+
+In `android/app/build.gradle` add this inside the `android` section:
 
-     .addPackage(new MainReactPackage())
-     .addPackage(new WebRTCModulePackage())        // <--- Add this line
-     .setUseDeveloperSupport(BuildConfig.DEBUG)
+```gradle
+compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+}
 ```
 
+## FAQ
 
-## CLEAN PROCESS
+##  Fatal Exception: java.lang.UnsatisfiedLinkError
 
-if you encounter any build time errors, like "linking library not found",  
-try the cleaning steps below, and do it again carefully with every steps.
+If you are getting this error:
 
-1. remove npm module: `rm -rf $YourProject/node_modules/react-native-webrtc`
-2. clean npm cache: `npm cache clean`
-3. clear temporary build files ( depends on your env )
-    * ANDROID: clear intermediate files in `gradle buildDir`
-    * iOS: in xocde project, click `Product` -> `clean`
-4. `npm install react-native-webrtc`
+```
+Fatal Exception: java.lang.UnsatisfiedLinkError: No implementation found for void org.webrtc.PeerConnectionFactory.nativeInitializeAndroidGlobals() (tried Java_org_webrtc_PeerConnectionFactory_nativeInitializeAndroidGlobals and Java_org_webrtc_PeerConnectionFactory_nativeInitializeAndroidGlobals__)
+       at org.webrtc.PeerConnectionFactory.nativeInitializeAndroidGlobals(PeerConnectionFactory.java)
+       at org.webrtc.PeerConnectionFactory.initialize(PeerConnectionFactory.java:306)
+       at com.oney.WebRTCModule.WebRTCModule.initAsync(WebRTCModule.java:79)
+       at com.oney.WebRTCModule.WebRTCModule.lambda$new$0(WebRTCModule.java:70)
+       at com.oney.WebRTCModule.-$$Lambda$WebRTCModule$CnyHZvkjDxq52UReGHUZlY0JsVw.run(-.java:4)
+       at java.util.concurrent.ThreadPoolExecutor.runWorker(ThreadPoolExecutor.java:1162)
+       at java.util.concurrent.ThreadPoolExecutor$Worker.run(ThreadPoolExecutor.java:636)
+       at java.lang.Thread.run(Thread.java:764)
+```
+
+Add this line to `android/gradle.properties`:
+
+```
+# This one fixes a weird WebRTC runtime problem on some devices.
+# https://github.com/jitsi/jitsi-meet/issues/7911#issuecomment-714323255
+android.enableDexingArtifactTransform.desugaring=false
+
+```

Documentation/BuildingWebRTC.md

@@ -0,0 +1,95 @@
+# Building WebRTC
+
+This document shows how to prepare a WebRTC build for its inclusion in this
+plugin.
+
+The build will be made with the `build-webrtc.py` Python script located in the
+`tools/` directory.
+
+## Preparing the build
+
+Running the script with `--setup` will download all necessary tools for building
+WebRTC. The script must be run with a target directory where all WebRTC source
+code and resulting build artifacts will be placed. A `build_webrtc` directory
+will be created containing it all.
+
+The setup process only needs to be carried out once.
+
+### iOS
+
+```
+python build-webrtc.py --setup --ios ~/src/
+```
+
+### Android
+
+NOTE: Make sure you have the Java JDK installed beforehand. On Debian and
+Ubuntu systems this can be accomplished by installing the `default-jdk-headless`
+package.
+
+```
+python build-webrtc.py --setup --android ~/src/
+```
+
+## Selecting the branch
+
+Once the setup process has finished, the target branch must be selected, also
+adding any required cherry-picks. The following example shows how the M87 branch
+was made:
+
+```
+cd ~/src/build_webrtc/webrtc/ios/src/
+git checkout -b build-M87 refs/remotes/branch-heads/4280
+#git cherry-pick ...
+cd
+```
+
+Now the code is ready for building!
+
+Notice that since M79 chromium changed the branch naming scheme, for example M87 is WebRTC branch 4280.
+For a full list of branches, see: https://chromiumdash.appspot.com/branches
+
+## Building
+
+### iOS
+
+If you have switched branches, first run:
+
+```
+python build-webrtc.py --sync --ios ~/src/
+```
+
+Now build it:
+
+```
+python build-webrtc.py --build --ios ~/src/
+```
+
+The build artifacts will be located in `~/src/build_webrtc/build/ios/`.
+
+### Android
+
+**NOTE**: WebRTC for Android can only be built on Linux at the moment.
+
+If you have switched branches, first run:
+
+```
+python build-webrtc.py --sync --android ~/src/
+```
+
+Now build it:
+
+```
+python build-webrtc.py --build --android ~/src/
+```
+
+The build artifacts will be located in `~/src/build_webrtc/build/android/`.
+
+### Making debug builds
+
+Debug builds can be made by adding `--debug` together with `--build`. For
+example, to make a debug iOS build:
+
+```
+python build-webrtc.py --build --ios --debug ~/src/
+```