@100mslive/react-native-hms 0.8.0 → 0.8.1

package/README.md

@@ -61,18 +61,18 @@ We suggest using [react-native-permission](https://www.npmjs.com/package/react-n
 
 ## QuickStart
 
-The package exports four Classes and an HMSManager class that manages everything.
+The package exports all the classes and a HMSSDK class that manages everything.
 
 # Setting up the HMS Instance:
 
-first we'll have to call build method, that method returns an instance of HMSManager class and the same is used to perform all the operations
+first we'll have to call build method, that method returns an instance of HMSSDK class and the same is used to perform all the operations
 
 ```js
-import HmsManager from 'react-native-hms';
+import { HMSSDK } from '@100mslive/react-native-hms';
 ...
 
-const hmsInstance = await HmsManager.build();
-//save this instance, will be used for all the operations that we'll perform
+const hmsInstance = await HMSSDK.build();
+// save this instance, it will be used for all the operations that we'll perform
 
 ...
 ```
@@ -82,9 +82,7 @@ const hmsInstance = await HmsManager.build();
 add event listeners for all the events such as onPreview, onJoin, onPeerUpdate etc. the actions can be found in HMSUpdateListenerActions class
 
 ```js
-import HmsManager, {
-  HMSUpdateListenerActions,
-} from 'react-native-hms';
+import { HMSUpdateListenerActions } from '@100mslive/react-native-hms';
 ...
 
 // instance acquired from build() method
@@ -103,17 +101,15 @@ The event handlers are the way of handling any update happening in hms all event
 Joining the room connects you to the remote peer and broadcasts your stream to other peers, we need instance of HMSConfig in order to pass the details of room and user to join function
 
 ```js
-import HmsManager, {
-  HMSUpdateListenerActions,
-  HMSConfig,
-} from 'react-native-hms';
+import { HMSUpdateListenerActions, HMSConfig } from '@100mslive/react-native-hms';
 ...
 
-// instance acquired from build() method
 const HmsConfig = new HMSConfig({authToken, userID, roomID});
-instance.preview(HmsConfig); // to start preview
+
+// instance acquired from build() method
+hmsInstance.preview(HmsConfig); // to start preview
 // or
-instance.join(HmsConfig); // to join a room
+hmsInstance.join(HmsConfig); // to join a room
 
 ...
 ```
@@ -126,16 +122,17 @@ To display a video on screen the package provide a UI component named HmsView th
 
 ```js
 ...
+import { HMSRemotePeer } from '@100mslive/react-native-hms';
 
-//getting local track ID
-const localTrackId = instance?.localPeer?.videoTrack?.trackId;
+// getting local track ID 
+const localTrackId: string = hmsInstance?.localPeer?.videoTrack?.trackId;
 
 // getting remote track IDs
-const remotePeers = instance?.remotePeers
+const remotePeers: HMSRemotePeer[] = hmsInstance?.remotePeers
 const remoteVideoIds: string[] = [];
 
-remotePeers.map((remotePeer: any) => {
-  const remoteTrackId = remotePeer?.videoTrack?.trackId;
+remotePeers.map((remotePeer: HMSRemotePeer) => {
+  const remoteTrackId: string = remotePeer?.videoTrack?.trackId;
 
   if (remoteTrackId) {
     remoteVideoIds.push(remoteTrackId);
@@ -148,8 +145,10 @@ remotePeers.map((remotePeer: any) => {
 # Display a video in HmsView
 
 ```js
-import { HmsView, HMSVideoViewMode } from 'react-native-hms';
+import { HMSVideoViewMode } from '@100mslive/react-native-hms';
 
+// instance acquired from build() method
+const HmsView = hmsInstance?.HmsView;
 ...
 const styles = StyleSheet.create({
   hmsView: {
@@ -162,7 +161,7 @@ const styles = StyleSheet.create({
 // sink is passed false video would be removed. It is a ios only prop, for android it is handled by the package itself.
 // scaleType can be selected from HMSVideoViewMode as required
 // mirror can be passed as true to flip videos horizontally
-<HmsView sink={true} style={styles.hmsView} trackId={trackId} mirror={true} scaleType={HMSVideoViewMode.ASPECT_FILL} />
+<HmsView sink={true} style={styles.hmsView} trackId={trackId} mirror={true} scaleType={HMSVideoViewMode.ASPECT_FIT} />
 
 ...
 ```
@@ -171,40 +170,39 @@ const styles = StyleSheet.create({
 
 ```js
 // Mute Audio
-instance.localPeer.localAudioTrack().setMute(isMute);
+hmsInstance?.localPeer?.localAudioTrack()?.setMute(true);
 
 // Stop Video
-instance.localPeer.localVideoTrack().setMute(muteVideo);
+hmsInstance?.localPeer?.localVideoTrack()?.setMute(true);
 
 // Switch Camera
-instance.localPeer.localVideoTrack().switchCamera();
+hmsInstance?.localPeer?.localVideoTrack()?.switchCamera();
 
-// Leave the call
-instance.leave();
+// Leave the call (async function)
+await hmsInstance?.leave();
 ```
 
 # Sending messages
 
 ```js
-import { HMSMessage } from '@100mslive/react-native-hms';
+import { HMSRole } from '@100mslive/react-native-hms';
 
-// message object
-const message = new HMSMessage({
-  type: 'chat',
-  time: new Date().toISOString(),
-  message: value,
-});
+const message = 'hello'
+const roles: HMSRole[] = hmsInstance?.knownRoles
+// can any remote peer's peerID
+const peerId: string = hmsInstance?.localPeer?.peerID  
 
-// send a message
-instance.send(message);
+// send a different type of messages
+hmsInstance?.sendBroadcastMessage(message);
+hmsInstance?.sendGroupMessage(message, [role[0]);
+hmsInstance?.sendDirectMessage(message, peerId);
 ```
 
 # Error handling
 
 ```js
-// import actions
 import { HMSUpdateListenerActions } from '@100mslive/react-native-hms';
 
-// add a event listener
-instance.addEventListener(HMSUpdateListenerActions.ON_ERROR, onError);
+// add an error event listener 
+hmsInstance.addEventListener(HMSUpdateListenerActions.ON_ERROR, onError);
 ```

package/android/build.gradle

@@ -64,6 +64,6 @@ dependencies {
     //noinspection GradleDynamicVersion
     implementation "com.facebook.react:react-native:+"
     implementation "org.jetbrains.kotlin:kotlin-stdlib-jdk7:$kotlin_version"  // From node_modules
-    implementation 'com.github.100mslive:android-sdk:2.1.9'
+    implementation 'com.github.100mslive:android-sdk:2.2.3'
     implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-android:1.5.0'
 }

package/android/src/main/java/com/reactnativehmssdk/HmsDecoder.kt

@@ -1,8 +1,9 @@
 package com.reactnativehmssdk
 
 import com.facebook.react.bridge.*
-import live.hms.video.error.HMSException
 import java.util.*
+import live.hms.video.error.HMSException
+import live.hms.video.media.codec.HMSVideoCodec
 import live.hms.video.media.settings.HMSAudioTrackSettings
 import live.hms.video.media.settings.HMSVideoTrackSettings
 import live.hms.video.media.tracks.*
@@ -18,6 +19,19 @@ object HmsDecoder {
       room.putString("id", hmsRoom.roomId)
       room.putString("name", hmsRoom.name)
       room.putString("metaData", null)
+      room.putString("startedAt", hmsRoom.startedAt.toString())
+      room.putMap(
+          "browserRecordingState",
+          this.getHMSBrowserRecordingState(hmsRoom.browserRecordingState)
+      )
+      room.putMap(
+          "rtmpHMSRtmpStreamingState",
+          this.getHMSRtmpStreamingState(hmsRoom.rtmpHMSRtmpStreamingState)
+      )
+      room.putMap(
+          "serverRecordingState",
+          this.getHMSServerRecordingState(hmsRoom.serverRecordingState)
+      )
       var peers: WritableArray = Arguments.createArray()
       for (peer in hmsRoom.peerList) {
         peers.pushMap(getHmsPeer(peer))
@@ -37,10 +51,7 @@ object HmsDecoder {
           "customerUserID",
           if (hmsPeer.customerUserID == null) hmsPeer.customerUserID else ""
       )
-      peer.putString(
-          "customerDescription",
-          if (hmsPeer.customerDescription == null) hmsPeer.customerDescription else ""
-      )
+      peer.putString("metadata", if (hmsPeer.metadata == null) hmsPeer.metadata else "")
       peer.putMap("audioTrack", getHmsAudioTrack(hmsPeer.audioTrack))
       peer.putMap("videoTrack", getHmsVideoTrack(hmsPeer.videoTrack))
       peer.putMap("role", getHmsRole(hmsPeer.hmsRole))
@@ -172,11 +183,25 @@ object HmsDecoder {
       // getHmsSimulcastLayers(hmsPublishSettings.screenSimulcastLayers));
       publishSettings.putMap("videoSimulcastLayers", null)
       publishSettings.putMap("screenSimulcastLayers", null)
-      //        publishSettings.putArray("allowed", if (hmsPublishSettings.allowed != null)
-      // hmsPublishSettings.allowed as WritableArray else emptyArray);
+      publishSettings.putArray(
+          "allowed",
+          if (hmsPublishSettings.allowed != null) getWriteableArray(hmsPublishSettings.allowed)
+          else emptyArray
+      )
     }
     return publishSettings
   }
+
+  fun getWriteableArray(array: List<String>?): WritableArray {
+    val decodedArray: WritableArray = Arguments.createArray()
+    if (array != null) {
+      for (value in array) {
+        decodedArray.pushString(value)
+      }
+    }
+    return decodedArray
+  }
+
   fun getHmsAudioSettings(hmsAudioSettings: AudioParams?): WritableMap {
     val audioSettings: WritableMap = Arguments.createMap()
     if (hmsAudioSettings != null) {
@@ -236,10 +261,7 @@ object HmsDecoder {
           "customerUserID",
           if (hmsLocalPeer.customerUserID != null) hmsLocalPeer.customerUserID else ""
       )
-      peer.putString(
-          "customerDescription",
-          if (hmsLocalPeer.customerDescription != null) hmsLocalPeer.customerDescription else ""
-      )
+      peer.putString("metadata", if (hmsLocalPeer.metadata != null) hmsLocalPeer.metadata else "")
       peer.putMap("audioTrack", getHmsAudioTrack(hmsLocalPeer.audioTrack))
       peer.putMap("videoTrack", getHmsVideoTrack(hmsLocalPeer.videoTrack))
       peer.putMap("role", getHmsRole(hmsLocalPeer.hmsRole))
@@ -288,7 +310,7 @@ object HmsDecoder {
   fun getHmsVideoTrackSettings(hmsVideoTrackSettings: HMSVideoTrackSettings?): WritableMap {
     val settings: WritableMap = Arguments.createMap()
     if (hmsVideoTrackSettings != null) {
-      settings.putInt("codec", hmsVideoTrackSettings.codec.ordinal)
+      settings.putString("codec", getHmsVideoTrackCodec(hmsVideoTrackSettings.codec))
 
       val resolution: WritableMap = Arguments.createMap()
       resolution.putInt("height", hmsVideoTrackSettings.resolution.height)
@@ -297,7 +319,10 @@ object HmsDecoder {
 
       settings.putInt("maxBitrate", hmsVideoTrackSettings.maxBitRate)
       settings.putInt("maxFrameRate", hmsVideoTrackSettings.maxFrameRate)
-      settings.putInt("cameraFacing", hmsVideoTrackSettings.cameraFacing.ordinal)
+      settings.putString(
+          "cameraFacing",
+          getHmsVideoTrackCameraFacing(hmsVideoTrackSettings.cameraFacing)
+      )
       //        settings.putString("trackDescription",
       // if(hmsVideoTrackSettings.trackDescription!==null)hmsVideoTrackSettings.trackDescription
       // else "");
@@ -306,6 +331,31 @@ object HmsDecoder {
     return settings
   }
 
+  fun getHmsVideoTrackCodec(codec: HMSVideoCodec): String {
+    return when (codec) {
+      HMSVideoCodec.H264 -> {
+        "h264"
+      }
+      HMSVideoCodec.VP9 -> {
+        "vp9"
+      }
+      HMSVideoCodec.VP8 -> {
+        "vp8"
+      }
+    }
+  }
+
+  fun getHmsVideoTrackCameraFacing(cameraFacing: HMSVideoTrackSettings.CameraFacing): String {
+    return when (cameraFacing) {
+      HMSVideoTrackSettings.CameraFacing.FRONT -> {
+        "FRONT"
+      }
+      HMSVideoTrackSettings.CameraFacing.BACK -> {
+        "BACK"
+      }
+    }
+  }
+
   fun getHmsRemotePeers(remotePeers: Array<HMSRemotePeer>?): WritableArray {
     val peers: WritableArray = Arguments.createArray()
     if (remotePeers != null) {
@@ -326,10 +376,7 @@ object HmsDecoder {
           "customerUserID",
           if (hmsRemotePeer.customerUserID != null) hmsRemotePeer.customerUserID else ""
       )
-      peer.putString(
-          "customerDescription",
-          if (hmsRemotePeer.customerDescription != null) hmsRemotePeer.customerDescription else ""
-      )
+      peer.putString("metadata", if (hmsRemotePeer.metadata != null) hmsRemotePeer.metadata else "")
       peer.putMap("audioTrack", getHmsAudioTrack(hmsRemotePeer.audioTrack))
       peer.putMap("videoTrack", getHmsVideoTrack(hmsRemotePeer.videoTrack))
       peer.putMap("role", getHmsRole(hmsRemotePeer.hmsRole))
@@ -427,4 +474,31 @@ object HmsDecoder {
 
     return decodedError
   }
+
+  fun getHMSBrowserRecordingState(data: HMSBrowserRecordingState?): ReadableMap {
+    val input = Arguments.createMap()
+    if (data !== null) {
+      input.putBoolean("running", data.running)
+      input.putMap("error", data.error?.let { this.getError(it) })
+    }
+    return input
+  }
+
+  fun getHMSRtmpStreamingState(data: HMSRtmpStreamingState?): ReadableMap {
+    val input = Arguments.createMap()
+    if (data !== null) {
+      input.putBoolean("running", data.running)
+      input.putMap("error", data.error?.let { this.getError(it) })
+    }
+    return input
+  }
+
+  fun getHMSServerRecordingState(data: HMSServerRecordingState?): ReadableMap {
+    val input = Arguments.createMap()
+    if (data !== null) {
+      input.putBoolean("running", data.running)
+      input.putMap("error", data.error?.let { this.getError(it) })
+    }
+    return input
+  }
 }

package/android/src/main/java/com/reactnativehmssdk/HmsHelper.kt

@@ -1,6 +1,12 @@
 package com.reactnativehmssdk
 
+import com.facebook.react.bridge.ReadableArray
 import com.facebook.react.bridge.ReadableMap
+import live.hms.video.media.codec.HMSAudioCodec
+import live.hms.video.media.codec.HMSVideoCodec
+import live.hms.video.media.settings.HMSAudioTrackSettings
+import live.hms.video.media.settings.HMSVideoResolution
+import live.hms.video.media.settings.HMSVideoTrackSettings
 import live.hms.video.media.tracks.*
 import live.hms.video.sdk.models.*
 import live.hms.video.sdk.models.role.*
@@ -22,6 +28,11 @@ object HmsHelper {
               return false
             }
           }
+          "Float" -> {
+            if (map.getDouble(key) == null) {
+              return false
+            }
+          }
           "Boolean" -> {
             if (map.getBoolean(key) == null) {
               return false
@@ -163,6 +174,91 @@ object HmsHelper {
     return null
   }
 
+  fun getAudioTrackSettings(data: ReadableMap?): HMSAudioTrackSettings {
+    val builder = HMSAudioTrackSettings.Builder()
+
+    if (data != null) {
+      val maxBitrate = data.getInt("maxBitrate")
+      val codec = getAudioCodec(data.getString("codec"))
+      val trackDescription = data.getString("trackDescription")
+
+      builder.maxBitrate(maxBitrate)
+      builder.codec(codec)
+    }
+
+    return builder.build()
+  }
+
+  // TODO: find out a way to set settings required to create HMSVideTrackSettings
+
+  fun getVideoTrackSettings(data: ReadableMap?): HMSVideoTrackSettings {
+    val builder = HMSVideoTrackSettings.Builder()
+    if (data != null) {
+      val codec = getVideoCodec(data.getString("codec"))
+      val resolution = getVideoResolution(data.getMap("resolution"))
+      val maxBitrate = data.getInt("maxBitrate")
+      val maxFrameRate = data.getInt("maxFrameRate")
+      val cameraFacing = getCameraFacing(data.getString("cameraFacing"))
+      val trackDescription = data.getString("trackDescription")
+
+      builder.codec(codec)
+      builder.cameraFacing(cameraFacing)
+      if (resolution != null) {
+        builder.resolution(resolution)
+      }
+      builder.maxBitrate(maxBitrate)
+      builder.maxFrameRate(maxFrameRate)
+    }
+    return builder.build()
+  }
+
+  fun getVideoResolution(map: ReadableMap?): HMSVideoResolution? {
+    val width = map?.getDouble("width")
+    val height = map?.getDouble("height")
+
+    return if (width != null && height != null) {
+      HMSVideoResolution(width = width.toInt(), height = height.toInt())
+    } else {
+      null
+    }
+  }
+
+  fun getAudioCodec(codecString: String?): HMSAudioCodec {
+    when (codecString) {
+      "opus" -> {
+        return HMSAudioCodec.OPUS
+      }
+    }
+    return HMSAudioCodec.OPUS
+  }
+
+  fun getVideoCodec(codecString: String?): HMSVideoCodec {
+    when (codecString) {
+      "h264" -> {
+        return HMSVideoCodec.H264
+      }
+      "vp8" -> {
+        return HMSVideoCodec.VP8
+      }
+      "vp9" -> {
+        return HMSVideoCodec.VP9
+      }
+    }
+    return HMSVideoCodec.H264
+  }
+
+  fun getCameraFacing(cameraFacing: String?): HMSVideoTrackSettings.CameraFacing {
+    when (cameraFacing) {
+      "FRONT" -> {
+        return HMSVideoTrackSettings.CameraFacing.FRONT
+      }
+      "BACK" -> {
+        return HMSVideoTrackSettings.CameraFacing.BACK
+      }
+    }
+    return HMSVideoTrackSettings.CameraFacing.FRONT
+  }
+
   fun getHms(credentials: ReadableMap, hmsCollection: MutableMap<String, HmsSDK>): HmsSDK? {
     val id = credentials.getString("id")
 
@@ -172,4 +268,14 @@ object HmsHelper {
       return null
     }
   }
+
+  fun getRtmpUrls(rtmpURLsList: ReadableArray?): List<String> {
+    val rtmpURLs = mutableListOf<String>()
+    if (rtmpURLsList !== null) {
+      for (rtmpURL in rtmpURLsList.toArrayList()) {
+        rtmpURLs.add(rtmpURL as String)
+      }
+    }
+    return rtmpURLs
+  }
 }

package/android/src/main/java/com/reactnativehmssdk/HmsModule.kt

@@ -23,19 +23,19 @@ class HmsModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
   // Example method
   // See https://reactnative.dev/docs/native-modules-android
   @ReactMethod
-  fun build(callback: Promise?) {
+  fun build(data: ReadableMap?, callback: Promise?) {
     val hasItem = hmsCollection.containsKey("12345")
     if (hasItem) {
       val uuid = UUID.randomUUID()
       val randomUUIDString = uuid.toString()
-      val sdkInstance: HmsSDK = HmsSDK(this, randomUUIDString, reactApplicationContext)
+      val sdkInstance: HmsSDK = HmsSDK(data, this, randomUUIDString, reactApplicationContext)
 
       hmsCollection[randomUUIDString] = sdkInstance
 
       callback?.resolve(randomUUIDString)
     } else {
       val randomUUIDString = "12345"
-      val sdkInstance: HmsSDK = HmsSDK(this, randomUUIDString, reactApplicationContext)
+      val sdkInstance: HmsSDK = HmsSDK(data, this, randomUUIDString, reactApplicationContext)
 
       hmsCollection[randomUUIDString] = sdkInstance
 
@@ -176,6 +176,20 @@ class HmsModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
     hms?.acceptRoleChange()
   }
 
+  @ReactMethod
+  fun setVolume(data: ReadableMap) {
+    val hms = HmsHelper.getHms(data, hmsCollection)
+
+    hms?.setVolume(data)
+  }
+
+  @ReactMethod
+  fun getVolume(data: ReadableMap, callback: Promise?) {
+    val hms = HmsHelper.getHms(data, hmsCollection)
+
+    hms?.getVolume(data, callback)
+  }
+
   @ReactMethod
   fun muteAllPeersAudio(data: ReadableMap) {
     val hms = HmsHelper.getHms(data, hmsCollection)
@@ -183,6 +197,27 @@ class HmsModule(reactContext: ReactApplicationContext) : ReactContextBaseJavaMod
     hms?.muteAllPeersAudio(data)
   }
 
+  @ReactMethod
+  fun changeMetadata(data: ReadableMap, callback: Promise?) {
+    val hms = HmsHelper.getHms(data, hmsCollection)
+
+    hms?.changeMetadata(data, callback)
+  }
+
+  @ReactMethod
+  fun startRTMPOrRecording(data: ReadableMap, callback: Promise?) {
+    val hms = HmsHelper.getHms(data, hmsCollection)
+
+    hms?.startRTMPOrRecording(data, callback)
+  }
+
+  @ReactMethod
+  fun stopRtmpAndRecording(data: ReadableMap, callback: Promise?) {
+    val hms = HmsHelper.getHms(data, hmsCollection)
+
+    hms?.stopRtmpAndRecording(callback)
+  }
+
   fun emitEvent(event: String, data: WritableMap) {
     reactApplicationContext
         .getJSModule(DeviceEventManagerModule.RCTDeviceEventEmitter::class.java)