@100mslive/react-native-hms 1.7.2 → 2.0.0-alpha.0

package/lib/module/classes/HMSSDK.js

@@ -16,9 +16,9 @@ import { clearHmsPeersCache, getHmsPeersCache, HMSPeersCache, setHmsPeersCache }
 import { clearHmsRoomCache, getHmsRoomCache, HMSRoomCache, setHmsRoomCache } from './HMSRoomCache';
 import { HMSPeerUpdateOrdinals } from './HMSPeerUpdate';
 import { HMSSessionStore } from './HMSSessionStore';
-
+// import type { HMSPeerListIteratorOptions } from './HMSPeerListIteratorOptions';
+// import { HMSPeerListIterator } from './HMSPeerListIterator';
 // TODO: Rename to HMSPIPConfig & to be moved to a separate file
-
 const ReactNativeVersion = require('react-native/Libraries/Core/ReactNativeVersion');
 let HmsSdk;
 export class HMSSDK {
@@ -31,6 +31,7 @@ export 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);
@@ -48,6 +49,7 @@ export 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.
@@ -127,32 +129,6 @@ export 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 => {
-      logger === null || logger === void 0 || logger.verbose('#Function previewForRole', {
-        role,
-        id: this.id
-      });
-      if (Platform.OS === 'ios') {
-        return await HMSManager.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.
@@ -559,6 +535,46 @@ export class HMSSDK {
       };
       return await HMSManager.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 => {
+      logger === null || logger === void 0 || logger.verbose('#Function previewForRole', {
+        role,
+        id: this.id
+      });
+      const data = await HMSManager.previewForRole({
+        role,
+        id: this.id
+      });
+      const previewTracks = 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 () => {
+      logger === null || logger === void 0 || logger.verbose('#Function cancelPreview', {
+        id: this.id
+      });
+      const data = await HMSManager.cancelPreview({
+        id: this.id
+      });
+      return data;
+    });
     /**
      * - Calling this function will accept the most recent roleChange request made by anyone in the room
      *
@@ -1052,6 +1068,60 @@ export 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
+      };
+      logger === null || logger === void 0 || logger.verbose('#Function raiseLocalPeerHand', data);
+      return HMSManager.raiseLocalPeerHand(data);
+    });
+    /**
+     * - This function is used to lower hand for the local peer
+     * @memberof HMSSDK
+     */
+    _defineProperty(this, "lowerLocalPeerHand", async () => {
+      const data = {
+        id: this.id
+      };
+      logger === null || logger === void 0 || logger.verbose('#Function lowerLocalPeerHand', data);
+      return HMSManager.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
+      };
+      logger === null || logger === void 0 || logger.verbose('#Function lowerRemotePeerHand', data);
+      return HMSManager.lowerRemotePeerHand(data);
+    });
+    // getPeerListIterator = (
+    //   options?: HMSPeerListIteratorOptions
+    // ): HMSPeerListIterator => {
+    //   logger?.verbose('#Function getPeerListIterator', {
+    //     id: this.id,
+    //     options,
+    //   });
+    //   const uniqueId = Date.now();
+    //   const data: null | { sucess: boolean; uniqueId: number } =
+    //     HMSManager.getPeerListIterator({
+    //       id: this.id,
+    //       ...options,
+    //       limit: options?.limit ?? 10,
+    //       uniqueId: uniqueId,
+    //     });
+    //   if (!data) {
+    //     throw new Error('Unable to create PeerListIterator');
+    //   }
+    //   return new HMSPeerListIterator(data.uniqueId);
+    // };
     /**
      * - This is a prototype event listener that takes action and listens for updates related to that particular action
      *
@@ -1113,6 +1183,18 @@ export class HMSSDK {
             this.onPeerDelegate = callback;
             break;
           }
+        case HMSUpdateListenerActions.ON_PEER_LIST_UPDATED:
+          {
+            // Checking if we already have ON_PEER_LIST_UPDATED subscription
+            if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_PEER_LIST_UPDATED]) {
+              // Adding ON_PEER_LIST_UPDATED native listener
+              const peerListUpdatedSubscription = HMSNativeEventListener.addListener(this.id, HMSUpdateListenerActions.ON_PEER_LIST_UPDATED, this.onPeerListUpdatedListener);
+              this.emitterSubscriptions[HMSUpdateListenerActions.ON_PEER_LIST_UPDATED] = peerListUpdatedSubscription;
+            }
+            // Adding App Delegate listener
+            this.onPeerListUpdatedDelegate = callback;
+            break;
+          }
         case HMSUpdateListenerActions.ON_TRACK_UPDATE:
           {
             // Checking if we already have ON_TRACK_UPDATE subscription
@@ -1319,6 +1401,19 @@ export class HMSSDK {
             }
             break;
           }
+        case HMSPIPListenerActions.ON_PIP_MODE_CHANGED:
+          {
+            if (Platform.OS === 'android') {
+              // Checking if we already have ON_PIP_MODE_CHANGED subscription
+              if (!this.emitterSubscriptions[HMSPIPListenerActions.ON_PIP_MODE_CHANGED]) {
+                const pipModeChangedSubscription = HMSNativeEventListener.addListener(this.id, HMSPIPListenerActions.ON_PIP_MODE_CHANGED, this.onPIPModeChangedListener);
+                this.emitterSubscriptions[HMSPIPListenerActions.ON_PIP_MODE_CHANGED] = pipModeChangedSubscription;
+              }
+              // Adding PIP mode changed Delegate listener
+              this.onPIPModeChangedDelegate = callback;
+            }
+            break;
+          }
         default:
       }
     });
@@ -1589,6 +1684,20 @@ export class HMSSDK {
             }
             break;
           }
+        case HMSPIPListenerActions.ON_PIP_MODE_CHANGED:
+          {
+            if (Platform.OS === 'android') {
+              const subscription = this.emitterSubscriptions[HMSPIPListenerActions.ON_PIP_MODE_CHANGED];
+              // Removing ON_PIP_MODE_CHANGED native listener
+              if (subscription) {
+                subscription.remove();
+                this.emitterSubscriptions[HMSPIPListenerActions.ON_PIP_MODE_CHANGED] = undefined;
+              }
+              // Removing App Delegate listener
+              this.onPIPModeChangedDelegate = null;
+            }
+            break;
+          }
         default:
       }
     });
@@ -1715,6 +1824,23 @@ export class HMSSDK {
         });
       }
     });
+    _defineProperty(this, "onPeerListUpdatedListener", data => {
+      if (data.id !== this.id) {
+        return;
+      }
+      const addedPeers = HMSEncoder.encodeHmsPeers(data.addedPeers);
+      const removedPeers = HMSEncoder.encodeHmsPeers(data.removedPeers);
+      if (this.onPeerListUpdatedDelegate) {
+        logger === null || logger === void 0 || logger.verbose('#Listener ON_PEER_LIST_UPDATED_LISTENER_CALL', {
+          totalAddedPeers: addedPeers.length,
+          totalRemovedPeers: removedPeers.length
+        });
+        this.onPeerListUpdatedDelegate({
+          addedPeers,
+          removedPeers
+        });
+      }
+    });
     _defineProperty(this, "onTrackListener", data => {
       var _getHmsPeersCache2;
       if (data.id !== this.id) {
@@ -1971,6 +2097,12 @@ export class HMSSDK {
         });
       }
     });
+    _defineProperty(this, "onPIPModeChangedListener", data => {
+      if (this.onPIPModeChangedDelegate) {
+        logger === null || logger === void 0 || logger.verbose('#Listener onPIPModeChanged_CALL', data);
+        this.onPIPModeChangedDelegate(data);
+      }
+    });
     /**
      * - Updates the logger for this instance of HMSSDK
      * @param {HMSLogger} hmsLogger
@@ -2029,8 +2161,8 @@ export class HMSSDK {
       id: this.id
     });
   }
-  async enablePipMode(data) {
-    return HMSManager.handlePipActions('enablePipMode', {
+  async enterPipMode(data) {
+    return HMSManager.handlePipActions('enterPipMode', {
       ...data,
       id: this.id
     });