@100mslive/react-native-hms 1.7.2 → 1.9.0

package/lib/commonjs/classes/HMSSDK.js

@@ -19,6 +19,7 @@ var _HMSPeersCache = require("./HMSPeersCache");
 var _HMSRoomCache = require("./HMSRoomCache");
 var _HMSPeerUpdate = require("./HMSPeerUpdate");
 var _HMSSessionStore = require("./HMSSessionStore");
+var _HMSPeerListIterator = require("./HMSPeerListIterator");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
@@ -37,6 +38,7 @@ class HMSSDK {
     _defineProperty(this, "onJoinDelegate", void 0);
     _defineProperty(this, "onRoomDelegate", void 0);
     _defineProperty(this, "onPeerDelegate", void 0);
+    _defineProperty(this, "onPeerListUpdatedDelegate", void 0);
     _defineProperty(this, "onTrackDelegate", void 0);
     _defineProperty(this, "onErrorDelegate", void 0);
     _defineProperty(this, "onMessageDelegate", void 0);
@@ -54,6 +56,7 @@ class HMSSDK {
     _defineProperty(this, "onAudioDeviceChangedDelegate", void 0);
     _defineProperty(this, "onSessionStoreAvailableDelegate", void 0);
     _defineProperty(this, "onPIPRoomLeaveDelegate", void 0);
+    _defineProperty(this, "onPIPModeChangedDelegate", void 0);
     _defineProperty(this, "emitterSubscriptions", {});
     /**
      * - Calls removeListeners that in turn breaks all connections with native listeners.
@@ -133,32 +136,6 @@ class HMSSDK {
         id: this.id
       });
     });
-    /**
-     * - previewForRole can be used when there is role change request for current localPeer and we want
-     * to show the localPeer how the tracks look before publishing them to room.
-     *
-     * - It requires a role of type [HMSRole]{@link HMSRole} for which we want to preview the tracks.
-     *
-     * checkout {@link https://www.100ms.live/docs/react-native} for more info
-     *
-     * @param {HMSRole}
-     * @memberof HMSSDK
-     */
-    _defineProperty(this, "previewForRole", async role => {
-      _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Function previewForRole', {
-        role,
-        id: this.id
-      });
-      if (_reactNative.Platform.OS === 'ios') {
-        return await _HMSManagerModule.default.previewForRole({
-          role: role === null || role === void 0 ? void 0 : role.name,
-          id: this.id
-        });
-      } else {
-        console.log('API currently not available for android');
-        return 'API currently not available for android';
-      }
-    });
     /**
      * - HmsView is react component that takes trackId and starts showing that track on a tile.
      * - The appearance of tile is completely customizable with style prop.
@@ -565,6 +542,46 @@ class HMSSDK {
       };
       return await _HMSManagerModule.default.changeName(data);
     });
+    /**
+     * -Preview for a specific Role before changing it.
+     *
+     * By previewing before doing a Role Change, users can see their expected Audio & Video tracks which will be visible to other Peers in Room post changing the Role.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role} for more info
+     *
+     * @param {role: string}
+     * @memberof HMSSDK
+     */
+    _defineProperty(this, "previewForRole", async role => {
+      _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Function previewForRole', {
+        role,
+        id: this.id
+      });
+      const data = await _HMSManagerModule.default.previewForRole({
+        role,
+        id: this.id
+      });
+      const previewTracks = _HMSEncoder.HMSEncoder.encodeHmsPreviewForRoleTracks(data.tracks, this.id);
+      return previewTracks;
+    });
+    /**
+     * Cancel the Previewing for Role invocation.
+     *
+     * If a [previewForRole] call was performed previously then calling this method clears the tracks created anticipating a Change of Role
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role} for more info
+     *
+     * @memberof HMSSDK
+     */
+    _defineProperty(this, "cancelPreview", async () => {
+      _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Function cancelPreview', {
+        id: this.id
+      });
+      const data = await _HMSManagerModule.default.cancelPreview({
+        id: this.id
+      });
+      return data;
+    });
     /**
      * - Calling this function will accept the most recent roleChange request made by anyone in the room
      *
@@ -1058,6 +1075,75 @@ class HMSSDK {
         peerID: peerId
       });
     });
+    /**
+     * - This function is used to raise hand for the local peer
+     * @memberof HMSSDK
+     */
+    _defineProperty(this, "raiseLocalPeerHand", async () => {
+      const data = {
+        id: this.id
+      };
+      _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Function raiseLocalPeerHand', data);
+      return _HMSManagerModule.default.raiseLocalPeerHand(data);
+    });
+    /**
+     * - This function is used to lower hand for the local peer
+     * @memberof HMSSDK
+     */
+    _defineProperty(this, "lowerLocalPeerHand", async () => {
+      const data = {
+        id: this.id
+      };
+      _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Function lowerLocalPeerHand', data);
+      return _HMSManagerModule.default.lowerLocalPeerHand(data);
+    });
+    /**
+     * - This function is used to lower hand for the remote peer
+     * @param peer
+     */
+    _defineProperty(this, "lowerRemotePeerHand", async peer => {
+      const data = {
+        peerId: peer.peerID,
+        id: this.id
+      };
+      _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Function lowerRemotePeerHand', data);
+      return _HMSManagerModule.default.lowerRemotePeerHand(data);
+    });
+    /**
+     * `getPeerListIterator` method returns an instance of `HMSPeerListIterator` class
+     *
+     * @param options options for configuring iterator
+     * @returns instance of HMSPeerListIterator class
+     *
+     * Example usage:
+     * ```
+     * const peerListIterator =  hmsInstance.getPeerListIterator();
+     * ```
+     * OR
+     * ```
+     * const peerListIterator =  hmsInstance.getPeerListIterator({
+     *    limit: 10,
+     *    byRoleName: 'viewer-realtime',
+     * });
+     * ```
+     */
+    _defineProperty(this, "getPeerListIterator", options => {
+      _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Function getPeerListIterator', {
+        id: this.id,
+        options
+      });
+      const uniqueId = Math.random().toString(16).slice(2);
+      const data = _HMSManagerModule.default.getPeerListIterator({
+        id: this.id,
+        ...options,
+        limit: (options === null || options === void 0 ? void 0 : options.limit) ?? 10,
+        uniqueId
+      });
+      if (!data) {
+        throw new Error('Unable to create PeerListIterator');
+      }
+      return new _HMSPeerListIterator.HMSPeerListIterator(data.uniqueId, data.totalCount);
+    });
     /**
      * - This is a prototype event listener that takes action and listens for updates related to that particular action
      *
@@ -1119,6 +1205,18 @@ class HMSSDK {
             this.onPeerDelegate = callback;
             break;
           }
+        case _HMSUpdateListenerActions.HMSUpdateListenerActions.ON_PEER_LIST_UPDATED:
+          {
+            // Checking if we already have ON_PEER_LIST_UPDATED subscription
+            if (!this.emitterSubscriptions[_HMSUpdateListenerActions.HMSUpdateListenerActions.ON_PEER_LIST_UPDATED]) {
+              // Adding ON_PEER_LIST_UPDATED native listener
+              const peerListUpdatedSubscription = _HMSNativeEventListener.default.addListener(this.id, _HMSUpdateListenerActions.HMSUpdateListenerActions.ON_PEER_LIST_UPDATED, this.onPeerListUpdatedListener);
+              this.emitterSubscriptions[_HMSUpdateListenerActions.HMSUpdateListenerActions.ON_PEER_LIST_UPDATED] = peerListUpdatedSubscription;
+            }
+            // Adding App Delegate listener
+            this.onPeerListUpdatedDelegate = callback;
+            break;
+          }
         case _HMSUpdateListenerActions.HMSUpdateListenerActions.ON_TRACK_UPDATE:
           {
             // Checking if we already have ON_TRACK_UPDATE subscription
@@ -1325,6 +1423,19 @@ class HMSSDK {
             }
             break;
           }
+        case _HMSPIPListenerActions.HMSPIPListenerActions.ON_PIP_MODE_CHANGED:
+          {
+            if (_reactNative.Platform.OS === 'android') {
+              // Checking if we already have ON_PIP_MODE_CHANGED subscription
+              if (!this.emitterSubscriptions[_HMSPIPListenerActions.HMSPIPListenerActions.ON_PIP_MODE_CHANGED]) {
+                const pipModeChangedSubscription = _HMSNativeEventListener.default.addListener(this.id, _HMSPIPListenerActions.HMSPIPListenerActions.ON_PIP_MODE_CHANGED, this.onPIPModeChangedListener);
+                this.emitterSubscriptions[_HMSPIPListenerActions.HMSPIPListenerActions.ON_PIP_MODE_CHANGED] = pipModeChangedSubscription;
+              }
+              // Adding PIP mode changed Delegate listener
+              this.onPIPModeChangedDelegate = callback;
+            }
+            break;
+          }
         default:
       }
     });
@@ -1595,6 +1706,20 @@ class HMSSDK {
             }
             break;
           }
+        case _HMSPIPListenerActions.HMSPIPListenerActions.ON_PIP_MODE_CHANGED:
+          {
+            if (_reactNative.Platform.OS === 'android') {
+              const subscription = this.emitterSubscriptions[_HMSPIPListenerActions.HMSPIPListenerActions.ON_PIP_MODE_CHANGED];
+              // Removing ON_PIP_MODE_CHANGED native listener
+              if (subscription) {
+                subscription.remove();
+                this.emitterSubscriptions[_HMSPIPListenerActions.HMSPIPListenerActions.ON_PIP_MODE_CHANGED] = undefined;
+              }
+              // Removing App Delegate listener
+              this.onPIPModeChangedDelegate = null;
+            }
+            break;
+          }
         default:
       }
     });
@@ -1695,7 +1820,6 @@ class HMSSDK {
       }
     });
     _defineProperty(this, "onPeerListener", peerData => {
-      var _getHmsPeersCache;
       const data = {
         peer: peerData,
         type: null
@@ -1709,7 +1833,15 @@ class HMSSDK {
       }
       const peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
       const type = _HMSEncoder.HMSEncoder.encodeHmsPeerUpdate(data.type) || data.type;
-      (_getHmsPeersCache = (0, _HMSPeersCache.getHmsPeersCache)()) === null || _getHmsPeersCache === void 0 || _getHmsPeersCache.updatePeerCache(data.peer.peerID, data.peer, type);
+      if (type === _HMSPeerUpdate.HMSPeerUpdate.PEER_LEFT) {
+        this.sendPeerUpdateWhenPeerLeaves(data, peer, type);
+      } else {
+        var _getHmsPeersCache;
+        (_getHmsPeersCache = (0, _HMSPeersCache.getHmsPeersCache)()) === null || _getHmsPeersCache === void 0 || _getHmsPeersCache.updatePeerCache(data.peer.peerID, data.peer, type);
+        this.sendPeerUpdate(peer, type);
+      }
+    });
+    _defineProperty(this, "sendPeerUpdate", (peer, type) => {
       if (this.onPeerDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Listener ON_PEER_LISTENER_CALL', {
           peer,
@@ -1721,15 +1853,37 @@ class HMSSDK {
         });
       }
     });
-    _defineProperty(this, "onTrackListener", data => {
+    _defineProperty(this, "sendPeerUpdateWhenPeerLeaves", (data, peer, type) => {
       var _getHmsPeersCache2;
+      this.sendPeerUpdate(peer, type);
+      (_getHmsPeersCache2 = (0, _HMSPeersCache.getHmsPeersCache)()) === null || _getHmsPeersCache2 === void 0 || _getHmsPeersCache2.updatePeerCache(data.peer.peerID, data.peer, type);
+    });
+    _defineProperty(this, "onPeerListUpdatedListener", data => {
+      if (data.id !== this.id) {
+        return;
+      }
+      const addedPeers = _HMSEncoder.HMSEncoder.encodeHmsPeers(data.addedPeers);
+      const removedPeers = _HMSEncoder.HMSEncoder.encodeHmsPeers(data.removedPeers);
+      if (this.onPeerListUpdatedDelegate) {
+        _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Listener ON_PEER_LIST_UPDATED_LISTENER_CALL', {
+          totalAddedPeers: addedPeers.length,
+          totalRemovedPeers: removedPeers.length
+        });
+        this.onPeerListUpdatedDelegate({
+          addedPeers,
+          removedPeers
+        });
+      }
+    });
+    _defineProperty(this, "onTrackListener", data => {
+      var _getHmsPeersCache3;
       if (data.id !== this.id) {
         return;
       }
       const track = _HMSEncoder.HMSEncoder.encodeHmsTrack(data.track, this.id);
       const peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
       const type = data.type;
-      (_getHmsPeersCache2 = (0, _HMSPeersCache.getHmsPeersCache)()) === null || _getHmsPeersCache2 === void 0 || _getHmsPeersCache2.updatePeerCache(data.peer.peerID, {
+      (_getHmsPeersCache3 = (0, _HMSPeersCache.getHmsPeersCache)()) === null || _getHmsPeersCache3 === void 0 || _getHmsPeersCache3.updatePeerCache(data.peer.peerID, {
         track
       }, data.type);
       if (this.muteStatus && (data === null || data === void 0 ? void 0 : data.type) === 'TRACK_ADDED' && track.type === _HMSTrackType.HMSTrackType.AUDIO) {
@@ -1977,6 +2131,12 @@ class HMSSDK {
         });
       }
     });
+    _defineProperty(this, "onPIPModeChangedListener", data => {
+      if (this.onPIPModeChangedDelegate) {
+        _HMSLogger.logger === null || _HMSLogger.logger === void 0 || _HMSLogger.logger.verbose('#Listener onPIPModeChanged_CALL', data);
+        this.onPIPModeChangedDelegate(data);
+      }
+    });
     /**
      * - Updates the logger for this instance of HMSSDK
      * @param {HMSLogger} hmsLogger
@@ -2035,8 +2195,8 @@ class HMSSDK {
       id: this.id
     });
   }
-  async enablePipMode(data) {
-    return _HMSManagerModule.default.handlePipActions('enablePipMode', {
+  async enterPipMode(data) {
+    return _HMSManagerModule.default.handlePipActions('enterPipMode', {
       ...data,
       id: this.id
     });