Skip to content
Switch branches/tags
Go to file
9 contributors

Users who have contributed to this file

@oney @zxcpoiu @saghul @8BallBomBom @olanipekunife @KensakuKOMATSU @Dx724 @cristiantx @CSantosM

Android Installation

Starting with React Native 0.60 due to a new auto linking feature you no longer need to follow manual linking steps but you will need to follow the other steps below if you plan on releasing your app to production.

See a sample app in the examples/GumTestApp directory.

Declaring Permissions

In android/app/main/AndroidManifest.xml add the following permissions before the <application> section.

<uses-feature android:name="" />
<uses-feature android:name="" />
<uses-feature android:name="" />
<uses-feature android:name="android.hardware.microphone" />

<uses-permission android:name="android.permission.CAMERA" />
<uses-permission android:name="android.permission.RECORD_AUDIO" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
<uses-permission android:name="android.permission.CHANGE_NETWORK_STATE" />
<uses-permission android:name="android.permission.MODIFY_AUDIO_SETTINGS" />
<uses-permission android:name="android.permission.INTERNET" />

If you plan to also support Bluetooth devices then also add the following.

<uses-permission android:name="android.permission.BLUETOOTH" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_ADMIN" android:maxSdkVersion="30" />
<uses-permission android:name="android.permission.BLUETOOTH_CONNECT" />

Enable Java 8 Support

In android/app/build.gradle add the following inside the android section.

compileOptions {
	sourceCompatibility JavaVersion.VERSION_1_8
	targetCompatibility JavaVersion.VERSION_1_8

R8/ProGuard Support

In android/app/ add the following on a new line.

-keep class org.webrtc.** { *; }

Screen Capture Support - Android 10+

You'll need Notifee 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.

	android:foregroundServiceType="mediaProjection|camera|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.

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: {
			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.

try {
	await notifee.stopForegroundService();
} catch( err ) {
	// Handle Error

Lastly you'll need to add this to your projects main index.js file.
Otherwise you'll receive errors relating to the foreground service not being registered correctly.

notifee.registerForegroundService( notification => {
	return new Promise( () => {

	} );
} );

Fatal Exception: java.lang.UnsatisfiedLinkError

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(
	at org.webrtc.PeerConnectionFactory.initialize(
	at com.oney.WebRTCModule.WebRTCModule.initAsync(
	at com.oney.WebRTCModule.WebRTCModule.lambda$new$0(
	at com.oney.WebRTCModule.-$$Lambda$WebRTCModule$
	at java.util.concurrent.ThreadPoolExecutor.runWorker(
	at java.util.concurrent.ThreadPoolExecutor$

If you're experiencing the error above then in android/ add the following.

# This one fixes a weird WebRTC runtime problem on some devices.