@fishjam-cloud/react-native-client 0.2.0 → 0.2.2

package/README.md

@@ -48,7 +48,7 @@ Add plugin to your `app.json` if it's not already added:
 }
 ```
 
-If you want to use screensharing feature, enable the following flag:
+If you want to use screensharing feature, enable the following flags:
 
 ```json
 {
@@ -59,7 +59,12 @@ If you want to use screensharing feature, enable the following flag:
       [
         "@fishjam-cloud/react-native-client",
         {
-          "setUpScreensharing": true,
+          "android": {
+            "enableForegroundService": true
+          },
+          "ios": {
+            "enableScreensharing": true
+          }
         }
       ]
     ]
@@ -72,11 +77,14 @@ On bare workflow run `expo prebuild` to configure the app, then run
 
 ### Android
 
-1. Add camera and microphone permissions to your `AndroidManifest.xml`.
+1. Add camera and microphone permissions to your `AndroidManifest.xml` or you app.json permissions.
 2. Rebuild the app. That's it!
 
 ### iOS
 
+> [!NOTE]
+> If you're using our plugin with `enableScreensharing` set to `true`. Not further steps are required.
+
 On iOS installation is a bit more complicated, because you need to setup a
 screen broadcast app extension for screensharing.
 
@@ -102,7 +110,7 @@ screen broadcast app extension for screensharing.
    Broadcast Upload Extension → Next. Choose the name for the new target, select
    Swift language and deselect "Include UI Extension".
 
-   ![New target config](../../.github/images/xcode1.png)
+   ![New target config](https://github.com/fishjam-cloud/mobile-client-sdk/blob/main/.github/images/xcode1.png)
 
    Press Finish. In the next alert xcode will ask you if you want to activate
    the new scheme - press Cancel.
@@ -110,7 +118,7 @@ screen broadcast app extension for screensharing.
 4. Configure app group. Go to "Signing & Capabilities" tab, click "+ Capability"
    button in upper left corner and select "App Groups".
 
-   ![App groups config](../../.github/images/xcode2.png)
+   ![App groups config](https://github.com/fishjam-cloud/mobile-client-sdk/blob/main/.github/images/xcode2.png)
 
    Then in the "App Groups" add a new group or select existing. Usually group
    name has format `group.<your-bundle-identifier>`. Verify that both app and
@@ -119,7 +127,7 @@ screen broadcast app extension for screensharing.
 5. A new folder with app extension should appear on the left with contents like
    this:
 
-   ![App extension files](../../.github/images/xcode3.png)
+   ![App extension files](https://github.com/fishjam-cloud/mobile-client-sdk/blob/main/.github/images/xcode3.png)
 
    Replace `SampleHandler.swift` with `MembraneBroadcastSampleHandler.swift` and
    this code:
@@ -221,10 +229,12 @@ room client. To run the app:
    instructions there to setup and run demo server.
 2. Clone the repo
 3. ```
-   cd `examples/fishjam-chat`
    yarn
+   yarn build
+   cd `examples/fishjam-chat`
+   npx expo prebuild --clean
    ```
-4. In App.ts replace server url with your server's url.
+4. Copy `.env.template` and create `.env` with proper secrets.
 5. `yarn run android` or `yarn run ios` or run project from Android Studio /
    Xcode just like every RN project. Note that simulators won't work, you have
    to test on real device for camera and screensharing to run.
@@ -323,6 +333,9 @@ Use track metadata to differentiate between video and screencast tracks.
 
 ### Android foreground service
 
+> [!NOTE]
+> If you're using our plugin with `enableForegroundService` set to `true`. Not further steps are required.
+
 In order for the call to continue running when app is in background, you need to
 set up and start a foreground service. You can use a 3rd party library for this,
 for example [notifee](https://notifee.app/).

package/android/build.gradle

@@ -2,8 +2,10 @@ apply plugin: 'com.android.library'
 apply plugin: 'kotlin-android'
 apply plugin: 'maven-publish'
 
+def packageVersion = '0.2.2'
+
 group = 'io.fishjam.reactnative'
-version = '0.2.0'
+version = "${packageVersion}"
 
 buildscript {
   def expoModulesCorePlugin = new File(project(":expo-modules-core").projectDir.absolutePath, "ExpoModulesCorePlugin.gradle")
@@ -59,7 +61,7 @@ android {
     minSdkVersion safeExtGet("minSdkVersion", 21)
     targetSdkVersion safeExtGet("targetSdkVersion", 31)
     versionCode 1
-    versionName "0.2.0"
+    versionName "${packageVersion}"
   }
   lintOptions {
     abortOnError false
@@ -82,7 +84,7 @@ dependencies {
     implementation project(':fishjam-cloud-android-client')
   } else {
     // update version number when releasing
-    implementation 'com.github.fishjam-cloud:mobile-client-sdk:0.2.0'
+    implementation "com.github.fishjam-cloud:mobile-client-sdk:${packageVersion}"
   }
   api 'com.github.davidliu:audioswitch:8edf84ee46cdbc84c2b7725aa8f8d66363e19876'
   implementation 'androidx.appcompat:appcompat:1.6.1'

package/android/src/main/AndroidManifest.xml

@@ -0,0 +1,2 @@
+<manifest>
+</manifest>

package/android/src/main/java/io/fishjam/reactnative/AudioDeviceKind.kt

@@ -0,0 +1,34 @@
+package io.fishjam.reactnative
+
+import com.twilio.audioswitch.AudioDevice
+
+enum class AudioDeviceKind(
+  val typeName: String,
+  val audioDeviceClass: Class<out AudioDevice>
+) {
+  BLUETOOTH("bluetooth", AudioDevice.BluetoothHeadset::class.java),
+  WIRED_HEADSET("headset", AudioDevice.WiredHeadset::class.java),
+  SPEAKER("speaker", AudioDevice.Speakerphone::class.java),
+  EARPIECE("earpiece", AudioDevice.Earpiece::class.java)
+  ;
+
+  companion object {
+    fun fromAudioDevice(audioDevice: AudioDevice): AudioDeviceKind? {
+      for (kind in values()) {
+        if (kind.audioDeviceClass == audioDevice.javaClass) {
+          return kind
+        }
+      }
+      return null
+    }
+
+    fun fromTypeName(typeName: String): AudioDeviceKind? {
+      for (kind in values()) {
+        if (kind.typeName == typeName) {
+          return kind
+        }
+      }
+      return null
+    }
+  }
+}

package/android/src/main/java/io/fishjam/reactnative/AudioSwitchManager.kt

@@ -0,0 +1,61 @@
+package io.fishjam.reactnative
+
+import android.content.Context
+import android.os.Handler
+import android.os.Looper
+import com.twilio.audioswitch.AudioDevice
+import com.twilio.audioswitch.AudioDeviceChangeListener
+import com.twilio.audioswitch.AudioSwitch
+
+class AudioSwitchManager(
+  private val context: Context
+) {
+  private var preferredDeviceList =
+    listOf(
+      AudioDevice.BluetoothHeadset::class.java,
+      AudioDevice.WiredHeadset::class.java,
+      AudioDevice.Speakerphone::class.java,
+      AudioDevice.Earpiece::class.java
+    )
+
+  // AudioSwitch is not threadsafe, so all calls should be done on the main thread.
+  private val handler: Handler = Handler(Looper.getMainLooper())
+
+  private var audioSwitch: AudioSwitch =
+    AudioSwitch(context, loggingEnabled = true, preferredDeviceList = preferredDeviceList)
+
+  fun start(listener: AudioDeviceChangeListener) {
+    handler.removeCallbacksAndMessages(null)
+    handler.postAtFrontOfQueue {
+      audioSwitch.start(listener)
+      audioSwitch.activate()
+    }
+  }
+
+  fun stop() {
+    handler.removeCallbacksAndMessages(null)
+    handler.postAtFrontOfQueue {
+      audioSwitch.stop()
+    }
+  }
+
+  fun selectedAudioDevice(): AudioDevice? = audioSwitch.selectedAudioDevice
+
+  fun availableAudioDevices(): List<AudioDevice> = audioSwitch.availableAudioDevices
+
+  fun selectAudioOutput(audioDeviceClass: Class<out AudioDevice?>) {
+    handler.post {
+      availableAudioDevices()
+        .find { it.javaClass == audioDeviceClass }
+        ?.let {
+          audioSwitch.selectDevice(it)
+        }
+    }
+  }
+
+  fun selectAudioOutput(kind: AudioDeviceKind?) {
+    if (kind != null) {
+      selectAudioOutput(kind.audioDeviceClass)
+    }
+  }
+}

package/android/src/main/java/io/fishjam/reactnative/EmitableEvents.kt

@@ -0,0 +1,14 @@
+package io.fishjam.reactnative
+
+object EmitableEvents {
+  const val IsCameraOn = "IsCameraOn"
+  const val IsMicrophoneOn = "IsMicrophoneOn"
+  const val IsScreencastOn = "IsScreencastOn"
+  const val SimulcastConfigUpdate = "SimulcastConfigUpdate"
+  const val PeersUpdate = "PeersUpdate"
+  const val AudioDeviceUpdate = "AudioDeviceUpdate"
+  const val BandwidthEstimation = "BandwidthEstimation"
+  const val ReconnectionRetriesLimitReached = "ReconnectionRetriesLimitReached"
+  const val ReconnectionStarted = "ReconnectionStarted"
+  const val Reconnected = "Reconnected"
+}

package/android/src/main/java/io/fishjam/reactnative/Errors.kt

@@ -0,0 +1,31 @@
+package io.fishjam.reactnative
+
+import com.fishjamcloud.client.models.AuthError
+import expo.modules.kotlin.exception.CodedException
+
+class JoinError(
+  metadata: Any
+) : CodedException(message = "Join error: $metadata")
+
+class ConnectionError(
+  reason: AuthError
+) : CodedException(message = "Connection error: ${reason.error}")
+
+class MissingScreencastPermission : CodedException(message = "No permission to start screencast, call handleScreencastPermission first.")
+
+class ClientNotConnectedError : CodedException(message = "Client not connected to server yet. Make sure to call connect() first!")
+
+class NoLocalVideoTrackError : CodedException(message = "No local video track. Make sure to call connect() first!")
+
+class NoLocalAudioTrackError : CodedException(message = "No local audio track. Make sure to call connect() first!")
+
+class NoScreencastTrackError : CodedException(message = "No local screencast track. Make sure to toggle screencast on first!")
+
+class SocketClosedError(
+  code: Int,
+  reason: String
+) : CodedException(message = "Socket was closed with code = $code and reason = $reason")
+
+class SocketError(
+  message: String
+) : CodedException(message = "Socket error: $message")

package/android/src/main/java/io/fishjam/reactnative/FishjamForegroundService.kt

@@ -0,0 +1,90 @@
+package io.fishjam.reactnative
+
+import android.app.Notification
+import android.app.NotificationChannel
+import android.app.NotificationManager
+import android.app.PendingIntent
+import android.app.Service
+import android.content.Intent
+import android.os.Build
+import android.os.IBinder
+import androidx.core.app.NotificationCompat
+
+class FishjamForegroundService : Service() {
+  companion object {
+    private const val FOREGROUND_SERVICE_ID = 1668
+  }
+
+  override fun onBind(p0: Intent?): IBinder? = null
+
+  override fun onStartCommand(
+    intent: Intent?,
+    flags: Int,
+    startId: Int
+  ): Int {
+    val channelId = intent!!.getStringExtra("channelId")!!
+    val channelName = intent.getStringExtra("channelName")!!
+    val notificationTitle = intent.getStringExtra("notificationTitle")!!
+    val notificationContent = intent.getStringExtra("notificationContent")!!
+    val foregroundServiceTypesArray = intent.getIntArrayExtra("foregroundServiceTypes")!!
+    // Create "bitwise or" of foregroundServiceTypesArray
+    val foregroundServiceType = foregroundServiceTypesArray.reduce { acc, value -> acc or value }
+
+    val pendingIntent =
+      PendingIntent.getActivity(
+        this,
+        0,
+        intent,
+        PendingIntent.FLAG_UPDATE_CURRENT or PendingIntent.FLAG_MUTABLE
+      )
+
+    val notification: Notification =
+      NotificationCompat
+        .Builder(this, channelId)
+        .setContentTitle(notificationTitle)
+        .setContentText(notificationContent)
+        .setContentIntent(pendingIntent)
+        .build()
+
+    createNotificationChannel(channelId, channelName)
+    startForegroundWithNotification(notification, foregroundServiceType)
+
+    return START_NOT_STICKY
+  }
+
+  private fun startForegroundWithNotification(
+    notification: Notification,
+    foregroundServiceType: Int
+  ) {
+    if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.Q) {
+      startForeground(
+        FOREGROUND_SERVICE_ID,
+        notification,
+        foregroundServiceType
+      )
+    } else {
+      startForeground(
+        FOREGROUND_SERVICE_ID,
+        notification
+      )
+    }
+  }
+
+  private fun createNotificationChannel(
+    channelId: String,
+    channelName: String
+  ) {
+    if (Build.VERSION.SDK_INT < Build.VERSION_CODES.O) {
+      return
+    }
+
+    val serviceChannel =
+      NotificationChannel(
+        channelId,
+        channelName,
+        NotificationManager.IMPORTANCE_DEFAULT
+      )
+    val notificationManager = getSystemService(NOTIFICATION_SERVICE) as? NotificationManager
+    notificationManager?.createNotificationChannel(serviceChannel)
+  }
+}