@100mslive/react-native-hms 1.6.2 → 1.7.1

package/src/classes/HMSRemotePeer.ts

@@ -1,6 +1,7 @@
 import { HMSPeer } from './HMSPeer';
 import { HMSRemoteAudioTrack } from './HMSRemoteAudioTrack';
 import { HMSRemoteVideoTrack } from './HMSRemoteVideoTrack';
+import type { HMSTrackSource } from './HMSTrackSource';
 
 export class HMSRemotePeer extends HMSPeer {
   private remoteAudio?: HMSRemoteAudioTrack;
@@ -16,10 +17,9 @@ export class HMSRemotePeer extends HMSPeer {
 
   constructor(params: {
     peerID: string;
-    customerDescription?: string;
     remoteAudioTrackData?: {
       trackId: string;
-      source?: number | string;
+      source?: HMSTrackSource;
       isMute?: boolean;
       trackDescription?: string;
       playbackAllowed?: boolean;
@@ -27,7 +27,7 @@ export class HMSRemotePeer extends HMSPeer {
     };
     remoteVideoTrackData?: {
       trackId: string;
-      source?: number | string;
+      source?: HMSTrackSource;
       trackDescription?: string;
       isMute?: boolean;
       playbackAllowed?: boolean;

package/src/classes/HMSRemoteVideoTrack.ts

@@ -5,6 +5,7 @@ import type { HMSTrackType } from './HMSTrackType';
 import type { HMSLayer } from './HMSLayer';
 import type { HMSSimulcastLayerDefinition } from './HMSSimulcastLayerDefinition';
 import { HMSEncoder } from './HMSEncoder';
+import type { HMSTrackSource } from './HMSTrackSource';
 
 const {
   /**
@@ -105,7 +106,7 @@ export class HMSRemoteVideoTrack extends HMSVideoTrack {
 
   constructor(params: {
     trackId: string;
-    source?: number | string;
+    source?: HMSTrackSource;
     trackDescription?: string;
     isMute?: boolean;
     playbackAllowed?: boolean;

package/src/classes/HMSRoom.ts

@@ -128,7 +128,7 @@ export class HMSRoom {
     );
   }
 
-  get peerCount(): number {
+  get peerCount(): number | null {
     const hmsRoomCache = getHmsRoomCache();
 
     if (hmsRoomCache) {

package/src/classes/HMSRoomCache.ts

@@ -1,10 +1,9 @@
-import { NativeModules } from 'react-native';
+import HMSManager from './HMSManagerModule';
+
 import type { HMSRoom } from './HMSRoom';
 import { HMSEncoder } from './HMSEncoder';
 import { HMSRoomUpdate } from './HMSRoomUpdate';
 
-const { HMSManager } = NativeModules;
-
 export let hmsRoomCache: HMSRoomCache | undefined;
 
 export const getHmsRoomCache = () => hmsRoomCache;
@@ -93,6 +92,13 @@ export class HMSRoomCache {
         );
         break;
       }
+      case HMSRoomUpdate.ROOM_PEER_COUNT_UPDATED: {
+        this._data.set(
+          'peerCount',
+          encodeHMSRoomProperty(this.id, 'peerCount', data)
+        );
+        break;
+      }
       default: {
         for (const key in data) {
           const property = key as keyof HMSRoomCacheProps;
@@ -149,6 +155,8 @@ function encodeHMSRoomProperty<T extends keyof HMSRoomCacheProps>(
     value = HMSEncoder.encodeHLSRecordingState(data.hlsRecordingState);
   } else if (property === 'localPeer') {
     value = HMSEncoder.encodeHmsLocalPeer(data.localPeer, id);
+  } else if (property === 'peerCount') {
+    value = typeof data[property] === 'number' ? data[property] : null;
   } else {
     value = data[property];
   }

package/src/classes/HMSSDK.tsx

@@ -1,11 +1,14 @@
 import React from 'react';
-import { AppState, NativeModules, Platform } from 'react-native';
+import { AppState, Platform } from 'react-native';
 import { HMSEncoder } from './HMSEncoder';
 import { HMSHelper } from './HMSHelper';
 import { getLogger, logger, setLogger } from './HMSLogger';
 import { HMSTrackType } from './HMSTrackType';
 import { HMSUpdateListenerActions } from './HMSUpdateListenerActions';
-import { HmsViewComponent, HmsComponentProps } from './HmsView';
+import { HmsViewComponent } from './HmsView';
+import type { HmsComponentProps } from './HmsView';
+
+import HMSManager from './HMSManagerModule';
 
 import type { HMSConfig } from './HMSConfig';
 import type { HMSLocalPeer } from './HMSLocalPeer';
@@ -25,8 +28,8 @@ import type { HMSAudioMixingMode } from './HMSAudioMixingMode';
 import type { HMSLogSettings } from './HMSLogSettings';
 import { HMSMessageType } from './HMSMessageType';
 import { HMSPIPListenerActions } from './HMSPIPListenerActions';
-import type { HMSEventSubscription } from './HMSNativeEventEmitter';
-import { HMSNativeEventEmitter } from './HMSNativeEventEmitter';
+import HMSNativeEventListener from './HMSNativeEventListener';
+import type { HMSNativeEventSubscription } from './HMSNativeEventListener';
 import {
   clearHmsPeersCache,
   getHmsPeersCache,
@@ -52,17 +55,8 @@ interface PIPConfig {
   videoButton?: boolean;
 }
 
-const {
-  /**
-   * @ignore
-   */
-  HMSManager,
-} = NativeModules;
-
 const ReactNativeVersion = require('react-native/Libraries/Core/ReactNativeVersion');
 
-const HmsEventEmitter = new HMSNativeEventEmitter(HMSManager);
-
 let HmsSdk: HMSSDK | undefined;
 
 export class HMSSDK {
@@ -94,7 +88,7 @@ export class HMSSDK {
   private emitterSubscriptions: Partial<
     Record<
       HMSUpdateListenerActions | HMSPIPListenerActions,
-      HMSEventSubscription
+      HMSNativeEventSubscription
     >
   > = {};
 
@@ -124,6 +118,7 @@ export class HMSSDK {
     appGroup?: String;
     preferredExtension?: String;
     logSettings?: HMSLogSettings;
+    isPrebuilt?: boolean;
   }) {
     const { version } = require('../../package.json');
     const { major, minor, patch } = ReactNativeVersion.version;
@@ -134,6 +129,7 @@ export class HMSSDK {
       frameworkInfo: {
         version: major + '.' + minor + '.' + patch,
         sdkVersion: version,
+        isPrebuilt: params?.isPrebuilt || false,
       },
       logSettings: params?.logSettings,
     });
@@ -1002,6 +998,7 @@ export class HMSSDK {
   };
 
   /**
+   * Android Only
    * - This wrapper function used to switch output to device other than the default, currently available only for android.
    *
    * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#switch-audio-focus-to-another-device} for more info
@@ -1022,6 +1019,19 @@ export class HMSSDK {
     }
   };
 
+  switchAudioOutputUsingIOSUI = () => {
+    logger?.verbose('#Function switchAudioOutputUsingIOSUI', {
+      id: this.id,
+    });
+    if (Platform.OS !== 'ios') {
+      throw new Error(
+        '#Function `switchAudioOutputUsingIOSUI` is only available on iOS, use `switchAudioOutput` method instead!'
+      );
+    }
+
+    return HMSManager.switchAudioOutputUsingIOSUI({ id: this.id });
+  };
+
   /**
    * - This wrapper function used to change Audio Mode manually, currently available only for android.
    *
@@ -1067,36 +1077,6 @@ export class HMSSDK {
     }
   };
 
-  /**
-   * @deprecated Older SessionMetaData APIs has been deprecated in favour of newer Session Store APIs.
-   * You can subscribe to `ON_SESSION_STORE_AVAILABLE` event to get notified when the `HMSSessionStore`
-   * is available and use `set` method on `HMSSessionStore` instance
-   * checkout {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/}
-   */
-  setSessionMetaData = async (sessionMetaData: string | null) => {
-    logger?.verbose('#Function setSessionMetaData', {
-      id: this.id,
-      sessionMetaData,
-    });
-    return await HMSManager.setSessionMetaData({
-      id: this.id,
-      sessionMetaData,
-    });
-  };
-
-  /**
-   * @deprecated Older SessionMetaData APIs has been deprecated in favour of newer Session Store APIs.
-   * You can subscribe to `ON_SESSION_STORE_AVAILABLE` event to get notified when the `HMSSessionStore`
-   * is available and use `get` or `addKeyChangeListener` method on `HMSSessionStore` instance
-   * checkout {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/}
-   */
-  getSessionMetaData = async () => {
-    logger?.verbose('#Function getSessionMetaData', {
-      id: this.id,
-    });
-    return await HMSManager.getSessionMetaData({ id: this.id });
-  };
-
   getRemoteVideoTrackFromTrackId = async (trackId: string) => {
     logger?.verbose('#Function getRemoteVideoTrackFromTrackId', {
       id: this.id,
@@ -1125,6 +1105,25 @@ export class HMSSDK {
     return HMSEncoder.encodeHmsRemoteAudioTrack(remoteAudioTrackData, this.id);
   };
 
+  getPeerFromPeerId = (peerId: string) => {
+    logger?.verbose('#Function getPeerFromPeerId', {
+      id: this.id,
+      peerId,
+    });
+    // Getting Peer Cache
+    const peersCache = getHmsPeersCache();
+
+    // If Peer Cache doesn't exist, return `undefined` as we don't have Peer
+    if (!peersCache) return;
+
+    const peerRole = peersCache.getProperty(peerId, 'role');
+
+    // If Peer doesn't have valid Role, return `undefined` as we don't have Peer
+    if (!peerRole) return;
+
+    return HMSEncoder.encodeHmsPeer({ peerID: peerId });
+  };
+
   /**
    * - This is a prototype event listener that takes action and listens for updates related to that particular action
    *
@@ -1145,7 +1144,7 @@ export class HMSSDK {
         // Checking if we already have ON_PREVIEW subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_PREVIEW]) {
           // Adding ON_PREVIEW native listener
-          const previewSubscription = HmsEventEmitter.addListener(
+          const previewSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_PREVIEW,
             this.onPreviewListener
@@ -1161,7 +1160,7 @@ export class HMSSDK {
         // Checking if we already have ON_JOIN subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_JOIN]) {
           // Adding ON_JOIN native listener
-          const joinSubscription = HmsEventEmitter.addListener(
+          const joinSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_JOIN,
             this.onJoinListener
@@ -1179,7 +1178,7 @@ export class HMSSDK {
           !this.emitterSubscriptions[HMSUpdateListenerActions.ON_ROOM_UPDATE]
         ) {
           // Adding ON_ROOM_UPDATE native listener
-          const roomSubscription = HmsEventEmitter.addListener(
+          const roomSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_ROOM_UPDATE,
             this.onRoomListener
@@ -1197,7 +1196,7 @@ export class HMSSDK {
           !this.emitterSubscriptions[HMSUpdateListenerActions.ON_PEER_UPDATE]
         ) {
           // Adding ON_PEER_UPDATE native listener
-          const peerSubscription = HmsEventEmitter.addListener(
+          const peerSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_PEER_UPDATE,
             this.onPeerListener
@@ -1215,7 +1214,7 @@ export class HMSSDK {
           !this.emitterSubscriptions[HMSUpdateListenerActions.ON_TRACK_UPDATE]
         ) {
           // Adding ON_TRACK_UPDATE native listener
-          const trackSubscription = HmsEventEmitter.addListener(
+          const trackSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_TRACK_UPDATE,
             this.onTrackListener
@@ -1231,7 +1230,7 @@ export class HMSSDK {
         // Checking if we already have ON_ERROR subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_ERROR]) {
           // Adding ON_ERROR native listener
-          const errorSubscription = HmsEventEmitter.addListener(
+          const errorSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_ERROR,
             this.onErrorListener
@@ -1247,7 +1246,7 @@ export class HMSSDK {
         // Checking if we already have ON_MESSAGE subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_MESSAGE]) {
           // Adding ON_MESSAGE native listener
-          const messageSubscription = HmsEventEmitter.addListener(
+          const messageSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_MESSAGE,
             this.onMessageListener
@@ -1263,7 +1262,7 @@ export class HMSSDK {
         // Checking if we already have ON_SPEAKER subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_SPEAKER]) {
           // Adding ON_SPEAKER native listener
-          const speakerSubscription = HmsEventEmitter.addListener(
+          const speakerSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_SPEAKER,
             this.onSpeakerListener
@@ -1279,7 +1278,7 @@ export class HMSSDK {
         // Checking if we already have RECONNECTING subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.RECONNECTING]) {
           // Adding RECONNECTING native listener
-          const reconnectingSubscription = HmsEventEmitter.addListener(
+          const reconnectingSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.RECONNECTING,
             this.reconnectingListener
@@ -1295,7 +1294,7 @@ export class HMSSDK {
         // Checking if we already have RECONNECTED subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.RECONNECTED]) {
           // Adding RECONNECTED native listener
-          const reconnectedSubscription = HmsEventEmitter.addListener(
+          const reconnectedSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.RECONNECTED,
             this.reconnectedListener
@@ -1315,7 +1314,7 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_ROLE_CHANGE_REQUEST native listener
-          const roleChangeReqSubscription = HmsEventEmitter.addListener(
+          const roleChangeReqSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_ROLE_CHANGE_REQUEST,
             this.onRoleChangeRequestListener
@@ -1336,7 +1335,7 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_CHANGE_TRACK_STATE_REQUEST native listener
-          const changeTrackReqSubscription = HmsEventEmitter.addListener(
+          const changeTrackReqSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_CHANGE_TRACK_STATE_REQUEST,
             this.onChangeTrackStateRequestListener
@@ -1357,11 +1356,12 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_REMOVED_FROM_ROOM native listener
-          const removedFromRoomSubscription = HmsEventEmitter.addListener(
-            this.id,
-            HMSUpdateListenerActions.ON_REMOVED_FROM_ROOM,
-            this.onRemovedFromRoomListener
-          );
+          const removedFromRoomSubscription =
+            HMSNativeEventListener.addListener(
+              this.id,
+              HMSUpdateListenerActions.ON_REMOVED_FROM_ROOM,
+              this.onRemovedFromRoomListener
+            );
           this.emitterSubscriptions[
             HMSUpdateListenerActions.ON_REMOVED_FROM_ROOM
           ] = removedFromRoomSubscription;
@@ -1374,7 +1374,7 @@ export class HMSSDK {
         // Checking if we already have ON_RTC_STATS subscription
         if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_RTC_STATS]) {
           // Adding ON_RTC_STATS native listener
-          const rtcStatsSubscription = HmsEventEmitter.addListener(
+          const rtcStatsSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_RTC_STATS,
             this.RTCStatsListener
@@ -1394,7 +1394,7 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_LOCAL_AUDIO_STATS native listener
-          const lclAudioStatsSubscription = HmsEventEmitter.addListener(
+          const lclAudioStatsSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_LOCAL_AUDIO_STATS,
             this.onLocalAudioStatsListener
@@ -1415,7 +1415,7 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_LOCAL_VIDEO_STATS native listener
-          const lclVideoStatsSubscription = HmsEventEmitter.addListener(
+          const lclVideoStatsSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_LOCAL_VIDEO_STATS,
             this.onLocalVideoStatsListener
@@ -1436,7 +1436,7 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_REMOTE_AUDIO_STATS native listener
-          const rmAudioStatsSubscription = HmsEventEmitter.addListener(
+          const rmAudioStatsSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_REMOTE_AUDIO_STATS,
             this.onRemoteAudioStatsListener
@@ -1457,7 +1457,7 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_REMOTE_VIDEO_STATS native listener
-          const rmVideoStatsSubscription = HmsEventEmitter.addListener(
+          const rmVideoStatsSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_REMOTE_VIDEO_STATS,
             this.onRemoteVideoStatsListener
@@ -1478,7 +1478,7 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_AUDIO_DEVICE_CHANGED native listener
-          const audDeviceChgSubscription = HmsEventEmitter.addListener(
+          const audDeviceChgSubscription = HMSNativeEventListener.addListener(
             this.id,
             HMSUpdateListenerActions.ON_AUDIO_DEVICE_CHANGED,
             this.onAudioDeviceChangedListener
@@ -1499,11 +1499,12 @@ export class HMSSDK {
           ]
         ) {
           // Adding ON_SESSION_STORE_AVAILABLE native listener
-          const sessionStoreAvailableSubscription = HmsEventEmitter.addListener(
-            this.id,
-            HMSUpdateListenerActions.ON_SESSION_STORE_AVAILABLE,
-            this.onSessionStoreAvailableListener
-          );
+          const sessionStoreAvailableSubscription =
+            HMSNativeEventListener.addListener(
+              this.id,
+              HMSUpdateListenerActions.ON_SESSION_STORE_AVAILABLE,
+              this.onSessionStoreAvailableListener
+            );
           this.emitterSubscriptions[
             HMSUpdateListenerActions.ON_SESSION_STORE_AVAILABLE
           ] = sessionStoreAvailableSubscription;
@@ -1519,7 +1520,7 @@ export class HMSSDK {
             !this.emitterSubscriptions[HMSPIPListenerActions.ON_PIP_ROOM_LEAVE]
           ) {
             // Adding ON_PIP_ROOM_LEAVE native listener
-            const pipRoomLeaveSubscription = HmsEventEmitter.addListener(
+            const pipRoomLeaveSubscription = HMSNativeEventListener.addListener(
               this.id,
               HMSPIPListenerActions.ON_PIP_ROOM_LEAVE,
               this.onPIPRoomLeaveListener

package/src/classes/HMSSessionStore.ts

@@ -1,16 +1,14 @@
-import {
-  NativeModules,
-  DeviceEventEmitter,
-  EmitterSubscription as RNEmitterSubscription,
-} from 'react-native';
+import { DeviceEventEmitter } from 'react-native';
+import type { EmitterSubscription as RNEmitterSubscription } from 'react-native';
+
+import HMSManager from './HMSManagerModule';
+
 import { HMSConstants } from './HMSConstants';
 import { getLogger } from './HMSLogger';
 import { HMSUpdateListenerActions } from './HMSUpdateListenerActions';
 import { EventEmitter } from '../utils';
 import type { EmitterSubscription } from '../utils';
 
-const { HMSManager } = NativeModules;
-
 type Nullable<T> = T | null | undefined;
 
 export type HMSSessionStoreValue = Nullable<string>;
@@ -148,7 +146,7 @@ export class HMSSessionStore {
     // this `uniqueId` will be used to remove 'KeyChangeListener' from native side
     const uniqueId =
       subscriptionsToRemove.length > 0
-        ? (subscriptionsToRemove[0].context as { uniqueId: string }).uniqueId
+        ? (subscriptionsToRemove[0]!.context as { uniqueId: string }).uniqueId
         : null;
 
     // Removing required subscriptions from 'eventEmitter'

package/src/classes/HMSTrack.ts

@@ -1,8 +1,9 @@
+import type { HMSTrackSource } from './HMSTrackSource';
 import type { HMSTrackType } from './HMSTrackType';
 
 export class HMSTrack {
   trackId: string;
-  source?: number | string;
+  source?: HMSTrackSource;
   trackDescription?: string;
   mute?: boolean;
   id: string;
@@ -14,7 +15,7 @@ export class HMSTrack {
 
   constructor(params: {
     trackId: string;
-    source?: number | string;
+    source?: HMSTrackSource;
     trackDescription?: string;
     isMute?: boolean;
     id: string;

package/src/classes/HMSVideoTrack.ts

@@ -1,4 +1,5 @@
 import { HMSTrack } from './HMSTrack';
+import type { HMSTrackSource } from './HMSTrackSource';
 import type { HMSTrackType } from './HMSTrackType';
 
 export class HMSVideoTrack extends HMSTrack {
@@ -6,7 +7,7 @@ export class HMSVideoTrack extends HMSTrack {
 
   constructor(params: {
     trackId: string;
-    source?: number | string;
+    source?: HMSTrackSource;
     trackDescription?: string;
     isMute?: boolean;
     id: string;

package/src/classes/HmsView.tsx

@@ -4,9 +4,9 @@ import {
   requireNativeComponent,
   StyleSheet,
   UIManager,
-  ViewStyle,
   Platform,
 } from 'react-native';
+import type { ViewStyle } from 'react-native';
 import { HMSConstants } from './HMSConstants';
 import { HMSVideoViewMode } from './HMSVideoViewMode';
 
@@ -89,6 +89,12 @@ export const HmsViewComponent = React.forwardRef<any, HmsComponentProps>(
     };
 
     const capture = async () => {
+      const viewManagerConfig = UIManager.getViewManagerConfig('HMSView');
+
+      if (!viewManagerConfig.Commands.capture) {
+        return Promise.reject('Capture command not available on HMSView');
+      }
+
       let requestId = _nextRequestId++;
       let requestMap = _requestMap;
 
@@ -97,7 +103,7 @@ export const HmsViewComponent = React.forwardRef<any, HmsComponentProps>(
       let promise = new Promise(function (resolve, reject) {
         requestMap.set(requestId, { resolve, reject });
       });
-      const viewManagerConfig = UIManager.getViewManagerConfig('HMSView');
+
       UIManager.dispatchViewManagerCommand(
         findNodeHandle(hmsViewRef.current),
         viewManagerConfig.Commands.capture,