Updating react-native-webrtc to 124.0.6

.github/workflows/android_ci.yml

@@ -13,11 +13,14 @@ jobs:
   android-compile:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-java@v4
+      with:
+        distribution: 'temurin'
+        java-version: '17'
+    - uses: actions/setup-node@v4
       with:
-        node-version: '16.x'
+        node-version-file: '.nvmrc'
         cache: 'npm'
         cache-dependency-path: '**/package-lock.json'
 

.github/workflows/ci.yml

@@ -7,10 +7,11 @@ jobs:
     name: Lint
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v3
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
       with:
-        node-version: 16
+        node-version-file: '.nvmrc'
+        cache: 'npm'
     - run: npm install
     - name: Check if the git repository is clean
       run: $(exit $(git status --porcelain --untracked-files=no | head -255 | wc -l)) || (echo "Dirty git tree"; git diff; exit 1)

.github/workflows/ios_ci.yml

@@ -13,11 +13,10 @@ jobs:
   ios-compile:
     runs-on: macos-latest
     steps:
-    - uses: actions/checkout@v3
-
-    - uses: actions/setup-node@v3
+    - uses: actions/checkout@v4
+    - uses: actions/setup-node@v4
       with:
-        node-version: '16.x'
+        node-version-file: '.nvmrc'
         cache: 'npm'
         cache-dependency-path: '**/package-lock.json'
 

.npmignore

@@ -14,6 +14,8 @@ Documentation/
 examples/
 apple/WebRTC.xcframework
 apple/WebRTC.dSYMs
+android/build/
 *.jar
 *.tgz
 *.zip
+.github

.nvmrc

@@ -0,0 +1 @@
+22

Documentation/AndroidInstallation.md

@@ -32,6 +32,27 @@ If you plan to also support Bluetooth devices then also add the following.
 <uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />
 ```
 
+### Screen-sharing
+
+Starting with version 118.0.2 a foreground service is included in this library in order to make
+screen-sharing possible under Android 14 rules.
+
+If you want to enable it, first declare the following permissions:
+
+```xml
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
+    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
+```
+
+Then enable the builtin service as follows, by adding the following code very early in your
+application, in your main activity's `onCreate` for instance:
+
+```java
+    // Initialize the WebRTC module options.
+    WebRTCModuleOptions options = WebRTCModuleOptions.getInstance();
+    options.enableMediaProjectionService = true;
+```
+
 ## Enable Java 8 Support
 
 In `android/app/build.gradle` add the following inside the `android` section.
@@ -43,84 +64,53 @@ compileOptions {
 }
 ```
 
-## R8/ProGuard Support
-
-In `android/app/proguard-rules.pro` add the following on a new line.
-
-```proguard
--keep class org.webrtc.** { *; }
-```
-
-## Screen Capture Support - Android 10+
-
-You'll need [Notifee](https://notifee.app/react-native/docs/overview) or another library that can handle foreground services for you.  
-The basic requirement to get screen capturing working since Android 10 and above is to have a foreground service with `mediaProjection` included as a service type and to have that service running before starting a screen capture session.  
-
-In `android/app/main/AndroidManifest.xml` add the following inside the `<application>` section.  
-
-```xml
-<service
-	android:name="app.notifee.core.ForegroundService"
-	android:foregroundServiceType="mediaProjection|camera|microphone" />
+## Set audio category (output) to media
+
+The audio is considered calls by default. If you don't want your audio to be treated as a call stream you need to change the category. To set the category:
+
+if your Android files are written in Java, modify `MainApplication.java`:
+```java
+// add imports
+import com.oney.WebRTCModule.WebRTCModuleOptions;
+import android.media.AudioAttributes;
+import org.webrtc.audio.JavaAudioDeviceModule;
+
+public class MainApplication extends Application implements ReactApplication {
+	@Override
+	public void onCreate() {
+		// append this before WebRTCModule initializes
+		WebRTCModuleOptions options = WebRTCModuleOptions.getInstance();
+		AudioAttributes audioAttributes = AudioAttributes.Builder()
+		    .setUsage(AudioAttributes.USAGE_MEDIA)
+		    .setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
+		    .build();
+		options.audioDeviceModule = JavaAudioDeviceModule.builder(this)
+		.setAudioAttributes(audioAttributes)
+		.createAudioDeviceModule();
+	}
+}
 ```
 
-Additionally, add the respective foreground service type permissions before the `<application>` section.
-
-```xml
-<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
-<uses-permission android:name="android.permission.FOREGROUND_SERVICE_CAMERA" />
-<uses-permission android:name="android.permission.FOREGROUND_SERVICE_MICROPHONE" />
-```
-
-The following will create an ongoing persistent notification which also comes with a foreground service.  
-You will be prompted for permissions automatically each time you want to initialise screen capturing.  
-A notification channel is also required and created.  
-
-```javascript
-import notifee, { AndroidImportance } from '@notifee/react-native';
-
-try {
-	const channelId = await notifee.createChannel( {
-		id: 'screen_capture',
-		name: 'Screen Capture',
-		lights: false,
-		vibration: false,
-		importance: AndroidImportance.DEFAULT
-	} );
-
-	await notifee.displayNotification( {
-		title: 'Screen Capture',
-		body: 'This notification will be here until you stop capturing.',
-		android: {
-			channelId,
-			asForegroundService: true
-		}
-	} );
-} catch( err ) {
-	// Handle Error
-};
-```
-
-Once screen capturing has finished you should then stop the foreground service.  
-Usually you'd run a notification cancellation function but as the service is involved, instead run the following.  
-
-```javascript
-try {
-	await notifee.stopForegroundService();
-} catch( err ) {
-	// Handle Error
-};
-```
-
-Lastly, you'll need to add this to your project's main `index.js` file.  
-Otherwise, you'll receive errors relating to the foreground service not being registered correctly.  
-
-```javascript
-notifee.registerForegroundService( notification => {
-	return new Promise( () => {
-
-	} );
-} );
+if your Android files are written in Kotlin, modify `MainApplication.kt`:
+```kt
+// add imports
+import com.oney.WebRTCModule.WebRTCModuleOptions;
+import android.media.AudioAttributes
+import org.webrtc.audio.JavaAudioDeviceModule;
+
+class MainApplication : Application(), ReactApplication {
+	override fun onCreate() {
+		// append this before WebRTCModule initializes
+		val options = WebRTCModuleOptions.getInstance()
+		val audioAttributes = AudioAttributes.Builder()
+			.setUsage(AudioAttributes.USAGE_MEDIA)
+			.setContentType(AudioAttributes.CONTENT_TYPE_SPEECH)
+			.build()
+		options.audioDeviceModule = JavaAudioDeviceModule.builder(this)
+			.setAudioAttributes(audioAttributes)
+			.createAudioDeviceModule()
+	}
+}
 ```
 
 ## Fatal Exception: java.lang.UnsatisfiedLinkError

Documentation/BasicUsage.md

@@ -232,11 +232,9 @@ That will allow you to enable and disable video streams on demand while a call i
 
 ```javascript
 let sessionConstraints = {
-	mandatory: {
-		OfferToReceiveAudio: true,
-		OfferToReceiveVideo: true,
-		VoiceActivityDetection: true
-	}
+	offerToReceiveAudio: true,
+	offerToReceiveVideo: true,
+	voiceActivityDetection: true
 };
 ```
 
@@ -307,8 +305,13 @@ try {
 	// Taken from above, we don't want to flip if we don't have another camera.
 	if ( cameraCount < 2 ) { return; };
 
-	const videoTrack = await localMediaStream.getVideoTracks()[ 0 ];
-	videoTrack._switchCamera();
+	const videoTrack = localMediaStream.getVideoTracks()[0];
+	const constraints = { facingMode: isFrontCam ? 'user' : 'environment' };
+
+	videoTrack.applyConstraints(constraints);
+
+	// _switchCamera is deprecated as of 124.0.5
+	// videoTrack._switchCamera();
 
 	isFrontCam = !isFrontCam;
 } catch( err ) {
@@ -336,6 +339,30 @@ Don't forget, the user facing camera is usually mirrored.
 | objectFit | string | 'contain' | Can be `'contain'` or `'cover'` nothing more or less. | 
 | streamURL | string | 'streamURL' | Required to have an actual video stream rendering. |
 | zOrder | number | 0 | Similar to zIndex. |
+| onDimensionsChange | function | undefined | Callback fired when video dimensions change. Receives event with nativeEvent containing width and height. |
+
+## Handling Video Dimension Changes
+
+You can listen for changes in video dimensions using the onDimensionsChange callback.  
+This is useful for adapting your UI based on the video's aspect ratio or for analytics.
+
+```javascript
+import React, { useState } from 'react';
+
+const [videoDimensions, setVideoDimensions] = useState({ width: 0, height: 0 });
+
+<RTCView
+	mirror={true}
+	objectFit={'cover'}
+	streamURL={localMediaStream.toURL()}
+	zOrder={0}
+	onDimensionsChange={(event) => {
+		const { width, height } = event.nativeEvent;
+		setVideoDimensions({ width, height });
+		console.log(`Video dimensions changed: ${width}x${height}`);
+	}}
+/>
+```
 
 ## Controlling remote audio tracks
 

Documentation/CallGuide.md

@@ -143,11 +143,9 @@ So you can now start creating an offer which then needs sending send off to the
 
 ```javascript
 let sessionConstraints = {
-	mandatory: {
-		OfferToReceiveAudio: true,
-		OfferToReceiveVideo: true,
-		VoiceActivityDetection: true
-	}
+	offerToReceiveAudio: true,
+	offerToReceiveVideo: true,
+	voiceActivityDetection: true
 };
 
 try {

Documentation/iOSInstallation.md

@@ -26,6 +26,48 @@ Navigate to `<ProjectFolder>/ios/<ProjectName>/` and edit `Info.plist`, add the
 <string>Microphone permission description</string>
 ```
 
+## CallKit
+
+If your app uses a CallKit integration to handle incoming calls, then your
+CXProviderDelegate should call through to `RTCAudioSession.sharedInstance.audioSessionDidActivate/Deactivate` accordingly.
+
+```
+#import <WebRTC/RTCAudioSession.h>
+
+- (void) provider:(CXProvider *) provider didActivateAudioSession:(AVAudioSession *) audioSession {
+    [[RTCAudioSession sharedInstance] audioSessionDidActivate:[AVAudioSession sharedInstance]];
+}
+
+- (void) provider:(CXProvider *) provider didDeactivateAudioSession:(AVAudioSession *) audioSession {
+    [[RTCAudioSession sharedInstance] audioSessionDidDeactivate:[AVAudioSession sharedInstance]];
+}
+```
+
+Javascript methods are also provided to call these methods:
+
+```
+import { RTCAudioSession } from 'react-native-webrtc'
+
+// Call as needed.
+RTCAudioSession.audioSessionDidActivate();
+RTCAudioSession.audioSessionDidDeactivate();
+```
+
+## Background Camera Access
+
+Background camera access on supported devices can be enabled through setting the `enableMultitaskingCameraAccess` flag on WebRTCModuleOptions. This will require
+the `voip` background mode capability on iOS 18 or later devices.
+
+In your AppDelegate.m file:
+```
+- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions
+{
+  [WebRTCModuleOptions sharedInstance].enableMultitaskingCameraAccess = YES;
+
+  // ...
+}
+```
+
 ## Library not loaded/Code signature invalid
 
 This is an issue with iOS 13.3.1.  

android/build.gradle

@@ -14,10 +14,11 @@ android {
     buildToolsVersion safeExtGet('buildToolsVersion', "23.0.1")
 
     defaultConfig {
-        minSdkVersion safeExtGet('minSdkVersion', 24)
+        minSdkVersion 24
         targetSdkVersion safeExtGet('targetSdkVersion', 24)
         versionCode 1
         versionName "1.0"
+        consumerProguardFiles 'consumer-rules.pro'
     }
 
     // WebRTC requires Java 8 features
@@ -29,6 +30,7 @@ android {
 }
 
 dependencies {
-    implementation 'com.facebook.react:react-native:+'
-    api 'org.jitsi:webrtc:118.+'
+    implementation "com.facebook.react:react-android:+"
+    api 'org.jitsi:webrtc:124.+'
+    implementation "androidx.core:core:1.7.0"
 }

android/consumer-rules.pro

@@ -0,0 +1,2 @@
+# WebRTC
+-keep class org.webrtc.** { *; }

android/src/main/AndroidManifest.xml

@@ -2,17 +2,10 @@
           package="com.oney.WebRTCModule"
           xmlns:tools="http://schemas.android.com/tools"
     >
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE" />
-    <uses-permission android:name="android.permission.FOREGROUND_SERVICE_MEDIA_PROJECTION" />
     <application>
         <service
                 android:name=".MediaProjectionService"
                 android:foregroundServiceType="mediaProjection">
         </service>
     </application>
-    <uses-feature
-        android:name="android.hardware.usb.host"
-        android:required="false"
-        tools:node="replace"
-    />
 </manifest>