@100mslive/react-native-hms 1.2.0 → 1.4.0

package/README.md

@@ -1,6 +1,5 @@
 <a href="https://100ms.live/">
-<img src="https://github.com/100mslive/100ms-react-native/blob/main/100ms.gif" height=256/> 
-<img src="https://github.com/100mslive/100ms-react-native/blob/main/100ms.svg" title="100ms logo" float=center height=256>
+<img src="https://raw.githubusercontent.com/100mslive/react-native-hms/main/100ms.svg" title="100ms logo" float=center height=256>
 </a>
 
 [![npm](https://img.shields.io/npm/v/@100mslive/react-native-hms)](https://www.npmjs.com/package/@100mslive/react-native-hms)
@@ -17,6 +16,11 @@
 
 # 100ms React Native SDK
 
+Integrate Real Time Audio and Video conferencing, Interactive Live Streaming, and Chat in your apps with 100ms React Native SDK.
+
+With support for HLS and RTMP Live Streaming and Recording, Picture-in-Picture (PiP), one-to-one Video Call Modes, Audio Rooms, Video Player and much more, add immersive real-time communications to your apps.
+
+
 📖 Read the Complete Documentation here: https://www.100ms.live/docs/react-native/v2/foundation/basics
 
 ## 🏃 Example App
@@ -41,9 +45,9 @@ Troubleshooting Guide for resolving issues in running the Example app is [availa
 
 ## ☝️ Minimum Configuration
 
-- Support for React Native 0.63.4 or above
+- Support for React Native 0.64.4 or above
 - Support for Java 8 or above
-- Support for Android API level 21 or above
+- Support for Android API level 24 or above
 - Xcode 13 or above
 - Support for iOS 12 or above
 
@@ -120,17 +124,65 @@ More information about Audio Video Permission on iOS & Android is [available her
 
 The package exports all the classes and a HMSSDK class that manages everything.
 
-## Setting up the HMS Instance
+## [Setting up the HMS Instance](https://www.100ms.live/docs/react-native/v2/how--to-guides/install-the-sdk/hmssdk)
 
 First invoke the `build` method which returns an instance of `HMSSDK`. Save this instance to perform all actions related to 100ms.
 
 ```ts
 import { HMSSDK } from '@100mslive/react-native-hms';
 
-// create HMSSDK instance using the build method & save it for further usage
+/**
+ * create HMSSDK instance using the build method & save it for further usage
+ *
+ * Important Note: Don't build new `HMSSDK` instance before destroying the previous one.
+ * for more info checkout {@link https://www.100ms.live/docs/react-native/v2/how--to-guides/install-the-sdk/hmssdk#what-does-destroy-method-do}
+ */
 const hmsInstance = await HMSSDK.build();
 ```
 
+## [Get Authentication Token](https://www.100ms.live/docs/react-native/v2/get-started/quickstart#fetch-token-to-join-the-room)
+
+### Fetch token using room-code method (Recommended)
+
+We can get the authentication token using room-code from meeting URL.
+
+Let's understand the subdomain and code from the sample URL
+
+In this sample url: `http://100ms-rocks.app.100ms.live/meeting/abc-defg-hij`
+ -  Subdomain is `100ms-rocks`
+ -  Room code is `abc-defg-hij`
+
+Now to get the room-code from meeting URL, we can write our own logic or use the `getCode` method from [here](https://github.com/100mslive/react-native-hms/blob/main/example/src/utils/getRoomLinkDetails.ts)
+
+To generate token we will be using `getAuthTokenByRoomCode` method available on `HMSSDK` instance. This method has `roomCode` as a required
+parameter and `userId` & `endpoint` as optional parameter.
+
+Let's checkout the implementation:
+
+```js
+/**
+ * `getAuthTokenByRoomCode` returns a promise which is resolved with "auth token"
+ * checkout {@link https://www.100ms.live/docs/react-native/v2/how--to-guides/install-the-sdk/hmssdk#what-does-destroy-method-do}
+ */
+const token = await hmsInstance.getAuthTokenByRoomCode('YOUR_ROOM_CODE');
+
+/**
+ * Create `HMSConfig` with the above auth token and username
+ */
+const hmsConfig = new HMSConfig({ authToken: token, username: 'John Appleseed' });
+```
+
+### Get temporary token from dashboard
+
+To test audio/video functionality, you need to connect to a 100ms Room. Please check the following steps for the same -
+
+1. Navigate to your [100ms dashboard](https://dashboard.100ms.live/dashboard) or [create an account](https://dashboard.100ms.live/register) if you don't have one.
+2. Use the `Video Conferencing Starter Kit` to create a room with a default template assigned to it to test this app quickly.
+3. Go to the [Rooms page](https://dashboard.100ms.live/rooms) in your dashboard, click on the `Room Id` of the room you created above, and click on the `Join Room` button on the top right.
+4. You will see 100ms demo URLs for the roles created when you deployed the starter kit; you can click on the 'key' icon to copy the token and update the `AUTH_TOKEN` variable in "App.js" file.
+    > Token from 100ms dashboard is for testing purposes only, For production applications you must generate tokens on your own server. Refer to the [Management Token section](/concepts/v2/concepts/security-and-tokens#management-token) in Authentication and Tokens guide for more information.
+
+
 ## [Add Event Listeners](https://www.100ms.live/docs/react-native/v2/features/event-listeners)
 
 Add Event Listeners to get notified about actions happening in the 100ms Room.
@@ -175,6 +227,8 @@ NOTE: `ON_JOIN` Event Listener must be **attached** before calling `join` functi
 // create HMSSDK instance using the build function
 const hmsInstance = await HMSSDK.build();
 
+// Generate 100ms Auth Token by Room Code
+const token = await hmsInstance.getAuthTokenByRoomCode('abc-defg-hij'); // Sample Room Code
 
 // You'll need to add Event Listeners for HMSUpdateListenerActions, which are invoked to notify about updates happening in the room like a peer joins/leaves, a track got muted/unmuted, any errors that occur, etc.
 hmsInstance.addEventListener(HMSUpdateListenerActions.ON_JOIN, onJoinSuccess);
@@ -185,7 +239,7 @@ hmsInstance.addEventListener(HMSUpdateListenerActions.ON_ERROR, onError);
 
 // Next, create an object of HMSConfig class using the available joining configurations.
 let config = new HMSConfig({
-                    authToken: 'eyJH5c...', // client-side token generated from your token service
+                    authToken: token, // client-side token generated by `getAuthTokenByRoomCode` method
                     username: 'John Appleseed',
                 });
 

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

@@ -9,6 +9,8 @@ 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.enums.HMSPeerUpdate
+import live.hms.video.sdk.models.enums.HMSRoomUpdate
 import live.hms.video.sdk.models.role.*
 import live.hms.video.sdk.models.trackchangerequest.HMSChangeTrackStateRequest
 
@@ -23,6 +25,54 @@ object HMSDecoder {
     this.restrictRoleData.clear()
   }
 
+  fun getHmsRoomSubset(hmsRoom: HMSRoom?, hmsRoomUpdateType: HMSRoomUpdate? = null): WritableMap {
+    val room: WritableMap = Arguments.createMap()
+    if (hmsRoom != null) {
+      room.putString("id", hmsRoom.roomId)
+
+      when (hmsRoomUpdateType) {
+        HMSRoomUpdate.ROOM_PEER_COUNT_UPDATED -> {
+          room.putInt("peerCount", hmsRoom.peerCount)
+        }
+        HMSRoomUpdate.HLS_RECORDING_STATE_UPDATED -> {
+          hmsRoom.hlsRecordingState?.let {
+            room.putMap("hlsRecordingState", this.getHMSHlsRecordingState(it))
+          }
+        }
+        HMSRoomUpdate.BROWSER_RECORDING_STATE_UPDATED -> {
+          hmsRoom.browserRecordingState?.let {
+            room.putMap(
+              "browserRecordingState",
+              this.getHMSBrowserRecordingState(it)
+            )
+          }
+        }
+        HMSRoomUpdate.HLS_STREAMING_STATE_UPDATED -> {
+          hmsRoom.hlsStreamingState?.let {
+            room.putMap("hlsStreamingState", this.getHMSHlsStreamingState(it))
+          }
+        }
+        HMSRoomUpdate.RTMP_STREAMING_STATE_UPDATED -> {
+          hmsRoom.rtmpHMSRtmpStreamingState?.let {
+            room.putMap(
+              "rtmpHMSRtmpStreamingState",
+              this.getHMSRtmpStreamingState(it)
+            )
+          }
+        }
+        HMSRoomUpdate.SERVER_RECORDING_STATE_UPDATED -> {
+          hmsRoom.serverRecordingState?.let {
+            room.putMap(
+              "serverRecordingState",
+              this.getHMSServerRecordingState(it)
+            )
+          }
+        }
+      }
+    }
+    return room
+  }
+
   fun getHmsRoom(hmsRoom: HMSRoom?): WritableMap {
     val room: WritableMap = Arguments.createMap()
     if (hmsRoom != null) {
@@ -64,12 +114,68 @@ object HMSDecoder {
       }
 
       room.putMap("localPeer", this.getHmsLocalPeer(hmsRoom.localPeer))
+
       room.putArray("peers", this.getAllPeers(hmsRoom.peerList))
+
       room.putInt("peerCount", hmsRoom.peerCount)
     }
     return room
   }
 
+  fun getHmsPeerSubsetForPeerUpdateEvent(hmsPeer: HMSPeer?, peerUpdateType: HMSPeerUpdate): WritableMap {
+    val peer: WritableMap = Arguments.createMap()
+    if (hmsPeer != null) {
+      peer.putString(peerUpdateType.ordinal.toString(), hmsPeer.peerID)
+
+      if (peerUpdateType !== null) {
+        when (peerUpdateType) {
+          HMSPeerUpdate.NAME_CHANGED -> {
+            peer.putString("name", hmsPeer.name)
+          }
+          HMSPeerUpdate.METADATA_CHANGED -> {
+            peer.putString("metadata", hmsPeer.metadata)
+          }
+          HMSPeerUpdate.ROLE_CHANGED -> {
+            peer.putMap("role", this.getHmsRole(hmsPeer.hmsRole))
+          }
+          HMSPeerUpdate.NETWORK_QUALITY_UPDATED -> {
+            hmsPeer.networkQuality?.let {
+              peer.putMap("networkQuality", this.getHmsNetworkQuality(it))
+            }
+          }
+        }
+      }
+    }
+    return peer
+  }
+
+  fun getHmsPeerSubset(hmsPeer: HMSPeer?, peerUpdateType: HMSPeerUpdate? = null): WritableMap {
+    val peer: WritableMap = Arguments.createMap()
+    if (hmsPeer != null) {
+      peer.putString("peerID", hmsPeer.peerID)
+
+      if (peerUpdateType !== null) {
+        when (peerUpdateType) {
+          HMSPeerUpdate.NAME_CHANGED -> {
+            peer.putString("name", hmsPeer.name)
+          }
+          HMSPeerUpdate.METADATA_CHANGED -> {
+            peer.putString("metadata", hmsPeer.metadata)
+          }
+          HMSPeerUpdate.ROLE_CHANGED -> {
+            peer.putMap("role", this.getHmsRole(hmsPeer.hmsRole))
+          }
+          HMSPeerUpdate.NETWORK_QUALITY_UPDATED -> {
+            hmsPeer.networkQuality?.let {
+              peer.putMap("networkQuality", this.getHmsNetworkQuality(it))
+            }
+          }
+        }
+      }
+    }
+    return peer
+  }
+
   fun getHmsPeer(hmsPeer: HMSPeer?): WritableMap {
     val peer: WritableMap = Arguments.createMap()
     if (hmsPeer != null) {
@@ -106,7 +212,7 @@ object HMSDecoder {
     return peer
   }
 
-  private fun getHmsAudioTrack(hmsAudioTrack: HMSAudioTrack?): WritableMap {
+  fun getHmsAudioTrack(hmsAudioTrack: HMSAudioTrack?): WritableMap {
     val hmsTrack: WritableMap = Arguments.createMap()
     if (hmsAudioTrack != null) {
       hmsTrack.putString("type", hmsAudioTrack.type.name)
@@ -118,7 +224,7 @@ object HMSDecoder {
     return hmsTrack
   }
 
-  private fun getHmsVideoTrack(hmsVideoTrack: HMSVideoTrack?): WritableMap {
+  fun getHmsVideoTrack(hmsVideoTrack: HMSVideoTrack?): WritableMap {
     val hmsTrack: WritableMap = Arguments.createMap()
     if (hmsVideoTrack != null) {
       hmsTrack.putString("type", hmsVideoTrack.type.name)
@@ -154,7 +260,7 @@ object HMSDecoder {
     return decodedRoles
   }
 
-  private fun getHmsRole(hmsRole: HMSRole?): WritableMap {
+  fun getHmsRole(hmsRole: HMSRole?): WritableMap {
     val role: WritableMap = Arguments.createMap()
     if (hmsRole != null) {
       role.putString("name", hmsRole.name)
@@ -243,34 +349,14 @@ object HMSDecoder {
     val peer: WritableMap = Arguments.createMap()
     if (hmsLocalPeer != null) {
       peer.putString("peerID", hmsLocalPeer.peerID)
-      peer.putString("name", hmsLocalPeer.name)
-      peer.putBoolean("isLocal", hmsLocalPeer.isLocal)
-
-      peer.putMap("role", this.getHmsRole(hmsLocalPeer.hmsRole))
-
-      peer.putString("metadata", hmsLocalPeer.metadata)
-
-      hmsLocalPeer.customerUserID?.let {
-        peer.putString("customerUserID", it)
-      }
-
-      hmsLocalPeer.networkQuality?.let {
-        peer.putMap("networkQuality", this.getHmsNetworkQuality(it))
-      }
 
       hmsLocalPeer.audioTrack?.let {
-        peer.putMap("audioTrack", this.getHmsAudioTrack(it))
         peer.putMap("localAudioTrackData", this.getHmsLocalAudioTrack(it))
       }
 
       hmsLocalPeer.videoTrack?.let {
-        peer.putMap("videoTrack", this.getHmsVideoTrack(it))
         peer.putMap("localVideoTrackData", this.getHmsLocalVideoTrack(it))
       }
-
-      hmsLocalPeer.auxiliaryTracks.let {
-        peer.putArray("auxiliaryTracks", this.getAllTracks(it))
-      }
     }
     return peer
   }
@@ -347,32 +433,14 @@ object HMSDecoder {
     val peer: WritableMap = Arguments.createMap()
     if (hmsRemotePeer != null) {
       peer.putString("peerID", hmsRemotePeer.peerID)
-      peer.putString("name", hmsRemotePeer.name)
-      peer.putBoolean("isLocal", hmsRemotePeer.isLocal)
-      peer.putString("metadata", hmsRemotePeer.metadata)
-      peer.putMap("role", this.getHmsRole(hmsRemotePeer.hmsRole))
-
-      hmsRemotePeer.customerUserID?.let {
-        peer.putString("customerUserID", it)
-      }
-
-      hmsRemotePeer.networkQuality?.let {
-        peer.putMap("networkQuality", this.getHmsNetworkQuality(it))
-      }
 
       hmsRemotePeer.audioTrack?.let {
-        peer.putMap("audioTrack", this.getHmsAudioTrack(it))
         peer.putMap("remoteAudioTrackData", this.getHmsRemoteAudioTrack(it))
       }
 
       hmsRemotePeer.videoTrack?.let {
-        peer.putMap("videoTrack", this.getHmsVideoTrack(hmsRemotePeer.videoTrack))
         peer.putMap("remoteVideoTrackData", this.getHmsRemoteVideoTrack(hmsRemotePeer.videoTrack))
       }
-
-      hmsRemotePeer.auxiliaryTracks.let {
-        peer.putArray("auxiliaryTracks", this.getAllTracks(it))
-      }
     }
     return peer
   }
@@ -423,7 +491,7 @@ object HMSDecoder {
     val roleChangeRequest: WritableMap = Arguments.createMap()
     if (id != null) {
       request.requestedBy?.let {
-        roleChangeRequest.putMap("requestedBy", this.getHmsPeer(it))
+        roleChangeRequest.putMap("requestedBy", this.getHmsPeerSubset(it))
       }
       roleChangeRequest.putMap("suggestedRole", this.getHmsRole(request.suggestedRole))
       roleChangeRequest.putString("id", id)
@@ -436,7 +504,7 @@ object HMSDecoder {
     val changeTrackStateRequest: WritableMap = Arguments.createMap()
 
     request.requestedBy?.let {
-      changeTrackStateRequest.putMap("requestedBy", this.getHmsPeer(it))
+      changeTrackStateRequest.putMap("requestedBy", this.getHmsPeerSubset(it))
     }
     changeTrackStateRequest.putString("trackType", request.track.type.name)
     changeTrackStateRequest.putBoolean("mute", request.mute)
@@ -459,7 +527,7 @@ object HMSDecoder {
     return null
   }
 
-  private fun getHMSBrowserRecordingState(data: HMSBrowserRecordingState?): ReadableMap {
+  fun getHMSBrowserRecordingState(data: HMSBrowserRecordingState?): ReadableMap {
     val input = Arguments.createMap()
     if (data !== null) {
       input.putBoolean("running", data.running)
@@ -479,7 +547,7 @@ object HMSDecoder {
     return input
   }
 
-  private fun getHMSRtmpStreamingState(data: HMSRtmpStreamingState?): ReadableMap {
+  fun getHMSRtmpStreamingState(data: HMSRtmpStreamingState?): ReadableMap {
     val input = Arguments.createMap()
     if (data !== null) {
       input.putBoolean("running", data.running)
@@ -499,7 +567,7 @@ object HMSDecoder {
     return input
   }
 
-  private fun getHMSServerRecordingState(data: HMSServerRecordingState?): ReadableMap {
+  fun getHMSServerRecordingState(data: HMSServerRecordingState?): ReadableMap {
     val input = Arguments.createMap()
     if (data !== null) {
       input.putBoolean("running", data.running)
@@ -515,7 +583,7 @@ object HMSDecoder {
     return input
   }
 
-  private fun getHMSHlsStreamingState(data: HMSHLSStreamingState?): ReadableMap {
+  fun getHMSHlsStreamingState(data: HMSHLSStreamingState?): ReadableMap {
     val input = Arguments.createMap()
     if (data !== null) {
       input.putBoolean("running", data.running)
@@ -526,7 +594,7 @@ object HMSDecoder {
     return input
   }
 
-  private fun getHMSHlsRecordingState(data: HmsHlsRecordingState?): ReadableMap {
+  fun getHMSHlsRecordingState(data: HmsHlsRecordingState?): ReadableMap {
     val input = Arguments.createMap()
     if (data !== null) {
       data.running?.let { input.putBoolean("running", it) }
@@ -591,18 +659,18 @@ object HMSDecoder {
     return subscribeDegradationParams
   }
 
-  private fun getAllPeers(peers: List<HMSPeer>?): WritableArray {
+  fun getAllPeers(peers: List<HMSPeer>?): WritableArray {
     val decodedPeers: WritableArray = Arguments.createArray()
     if (peers != null) {
       for (peer in peers) {
-        val decodedPeer = this.getHmsPeer(peer)
+        val decodedPeer = this.getHmsPeerSubset(peer)
         decodedPeers.pushMap(decodedPeer)
       }
     }
     return decodedPeers
   }
 
-  private fun getAllTracks(tracks: MutableList<HMSTrack>?): WritableArray {
+  fun getAllTracks(tracks: MutableList<HMSTrack>?): WritableArray {
     val decodedTracks: WritableArray = Arguments.createArray()
     if (tracks != null) {
       for (track in tracks) {
@@ -617,7 +685,7 @@ object HMSDecoder {
     val hmsRecipient: WritableMap = Arguments.createMap()
     if (recipient != null) {
       recipient.recipientPeer?.let {
-        hmsRecipient.putMap("recipientPeer", this.getHmsPeer(it))
+        hmsRecipient.putMap("recipientPeer", this.getHmsPeerSubset(it))
       }
 
       hmsRecipient.putArray("recipientRoles", this.getAllRoles(recipient.recipientRoles))
@@ -626,7 +694,7 @@ object HMSDecoder {
     return hmsRecipient
   }
 
-  private fun getHmsNetworkQuality(networkQuality: HMSNetworkQuality?): WritableMap {
+  fun getHmsNetworkQuality(networkQuality: HMSNetworkQuality?): WritableMap {
     val hmsNetworkQuality: WritableMap = Arguments.createMap()
     if (networkQuality != null) {
       hmsNetworkQuality.putInt("downlinkQuality", networkQuality.downlinkQuality)

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

@@ -447,6 +447,20 @@ class HMSManager(reactContext: ReactApplicationContext) :
     hms?.getSessionMetaData(callback)
   }
 
+  @ReactMethod(isBlockingSynchronousMethod = true)
+  fun getPeerProperty(data: ReadableMap): WritableMap? {
+    val hms = HMSHelper.getHms(data, hmsCollection) ?: return null
+
+    return hms.getPeerProperty(data)
+  }
+
+  @ReactMethod(isBlockingSynchronousMethod = true)
+  fun getRoomProperty(data: ReadableMap): WritableMap? {
+    val hms = HMSHelper.getHms(data, hmsCollection) ?: return null
+
+    return hms.getRoomProperty(data)
+  }
+
   @ReactMethod
   fun enableEvent(data: ReadableMap, promise: Promise?) {
     val hms = HMSHelper.getHms(data, hmsCollection)
@@ -468,6 +482,13 @@ class HMSManager(reactContext: ReactApplicationContext) :
     hms?.restrictData(data, promise)
   }
 
+  @ReactMethod()
+  fun getAuthTokenByRoomCode(data: ReadableMap, promise: Promise) {
+    val hms = HMSHelper.getHms(data, hmsCollection)
+
+    hms?.getAuthTokenByRoomCode(data, promise)
+  }
+
   // region Person-In-Person Mode Action handing
   private val pipReceiver by lazy {
     if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.O) {