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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "1.6.2",
+  "version": "1.7.1",
   "description": "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.",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",
@@ -184,5 +184,8 @@
         }
       ]
     ]
+  },
+  "dependencies": {
+    "zustand": "^4.3.8"
   }
 }

package/react-native-hms.podspec

@@ -19,4 +19,5 @@ Pod::Spec.new do |s|
   s.dependency "React-Core"
   s.dependency "HMSSDK", sdkVersions["ios"]
   s.dependency 'HMSBroadcastExtensionSDK', sdkVersions["iOSBroadcastExtension"]
+  s.dependency 'HMSHLSPlayerSDK', sdkVersions["iOSHMSHLSPlayer"]
 end

package/sdk-versions.json

@@ -1,5 +1,6 @@
 {
-  "ios": "0.9.4",
+  "ios": "0.9.9",
   "iOSBroadcastExtension": "0.0.9",
-  "android": "2.6.4"
+  "iOSHMSHLSPlayer": "0.0.2",
+  "android": "2.7.3"
 }

package/src/classes/HMSAudioTrack.ts

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

package/src/classes/HMSBrowserRecordingState.ts

@@ -1,17 +1,20 @@
 import type { HMSException } from './HMSException';
 
 export class HMSBrowserRecordingState {
+  initialising: boolean;
   running: boolean;
   error?: HMSException;
   startedAt?: Date;
   stoppedAt?: Date;
 
   constructor(params: {
+    initialising: boolean;
     running: boolean;
     error?: HMSException;
     startedAt?: Date;
     stoppedAt?: Date;
   }) {
+    this.initialising = params.initialising;
     this.running = params.running;
     this.error = params.error;
     this.startedAt = params.startedAt;

package/src/classes/HMSCameraControl.ts

@@ -1,7 +1,6 @@
-import { NativeModules } from 'react-native';
 import { HMSConstants } from './HMSConstants';
 
-const { HMSManager } = NativeModules;
+import HMSManager from './HMSManagerModule';
 
 export class HMSCameraControl {
   /**

package/src/classes/HMSEncoder.ts

@@ -1,4 +1,4 @@
-import { NativeModules } from 'react-native';
+import HMSManager from './HMSManagerModule';
 
 import { HMSTrack } from './HMSTrack';
 import { HMSAudioTrack } from './HMSAudioTrack';
@@ -40,8 +40,6 @@ import { HMSLayer } from './HMSLayer';
 import { HMSSimulcastLayerDefinition } from './HMSSimulcastLayerDefinition';
 import { HMSQualityLimitationReasons } from './HMSQualityLimitationReasons';
 
-const { HMSManager } = NativeModules;
-
 interface InitialData {
   roles: Record<string, HMSRole>;
 }
@@ -95,7 +93,6 @@ export class HMSEncoder {
   static encodeHmsPeer(peer: any) {
     const encodedObj = {
       peerID: peer?.peerID,
-      customerDescription: peer?.customerDescription || undefined,
     };
 
     return new HMSPeer(encodedObj);
@@ -156,7 +153,6 @@ export class HMSEncoder {
   static encodeHmsLocalPeer(peer: any, id: string) {
     const encodedObj = {
       peerID: peer?.peerID,
-      customerDescription: peer?.customerDescription || undefined,
       localAudioTrackData: peer?.localAudioTrackData?.trackId
         ? {
             id: id,
@@ -270,7 +266,6 @@ export class HMSEncoder {
   static encodeHmsRemotePeer(peer: any, id: string) {
     const encodedObj = {
       peerID: peer?.peerID,
-      customerDescription: peer.customerDescription,
       remoteAudioTrackData: peer?.remoteAudioTrackData?.trackId
         ? {
             id: id,
@@ -338,7 +333,7 @@ export class HMSEncoder {
     return encodedRoles;
   }
 
-  static encodeHmsRole(role: any) {
+  static encodeHmsRole(role: any): HMSRole {
     if (!role) {
       return new HMSRole(role);
     }
@@ -365,7 +360,7 @@ export class HMSEncoder {
       }
     }
 
-    return rolesCache[role.name];
+    return rolesCache[role.name]!;
   }
 
   static encodeHmsRoleChangeRequest(data: any) {
@@ -441,6 +436,7 @@ export class HMSEncoder {
 
   static encodeBrowserRecordingState(data: any) {
     return new HMSBrowserRecordingState({
+      initialising: data?.initialising || false,
       running: data?.running || false,
       startedAt: HMSEncoder.encodeDate(data?.startedAt),
       stoppedAt: HMSEncoder.encodeDate(data?.stoppedAt),
@@ -660,4 +656,18 @@ export class HMSEncoder {
         data.qualityLimitationResolutionChanges,
     });
   }
+
+  static transformHMSHLSCueEventData<C extends object, T>(data: C): T {
+    if ('startDate' in data) {
+      data.startDate = this.encodeDate(data.startDate);
+    }
+
+    if ('endDate' in data && data.endDate) {
+      data.endDate = this.encodeDate(data.endDate);
+    }
+
+    const transformed = data as unknown as T;
+
+    return transformed;
+  }
 }

package/src/classes/HMSEventEmitter.ts

@@ -0,0 +1,3 @@
+import { EventEmitter } from '../utils';
+
+export const HMSEventEmitter = new EventEmitter();

package/src/classes/HMSLocalAudioTrack.ts

@@ -3,6 +3,7 @@ import { HMSAudioTrack } from './HMSAudioTrack';
 import { getLogger } from './HMSLogger';
 import type { HMSAudioTrackSettings } from './HMSAudioTrackSettings';
 import type { HMSTrackType } from './HMSTrackType';
+import type { HMSTrackSource } from './HMSTrackSource';
 
 const {
   /**
@@ -55,7 +56,7 @@ export class HMSLocalAudioTrack extends HMSAudioTrack {
   constructor(params: {
     id: string;
     trackId: string;
-    source?: number | string;
+    source?: HMSTrackSource;
     trackDescription?: string;
     isMute?: boolean;
     settings?: HMSAudioTrackSettings;

package/src/classes/HMSLocalPeer.ts

@@ -4,6 +4,7 @@ import type { HMSAudioTrackSettings } from './HMSAudioTrackSettings';
 import { HMSLocalAudioTrack } from './HMSLocalAudioTrack';
 import { HMSLocalVideoTrack } from './HMSLocalVideoTrack';
 import type { HMSTrackType } from './HMSTrackType';
+import type { HMSTrackSource } from './HMSTrackSource';
 
 export class HMSLocalPeer extends HMSPeer {
   private localAudio?: HMSLocalAudioTrack;
@@ -18,11 +19,10 @@ export class HMSLocalPeer extends HMSPeer {
 
   constructor(params: {
     peerID: string;
-    customerDescription?: string;
     localAudioTrackData?: {
       id: string;
       trackId: string;
-      source?: number | string;
+      source?: HMSTrackSource;
       trackDescription?: string;
       isMute?: boolean;
       settings?: HMSAudioTrackSettings;
@@ -31,7 +31,7 @@ export class HMSLocalPeer extends HMSPeer {
     localVideoTrackData?: {
       id: string;
       trackId: string;
-      source?: number | string;
+      source?: HMSTrackSource;
       trackDescription?: string;
       isMute?: boolean;
       settings?: HMSVideoTrackSettings;

package/src/classes/HMSLocalVideoTrack.ts

@@ -3,6 +3,7 @@ import { HMSVideoTrack } from './HMSVideoTrack';
 import { getLogger } from './HMSLogger';
 import type { HMSVideoTrackSettings } from './HMSVideoTrackSettings';
 import type { HMSTrackType } from './HMSTrackType';
+import type { HMSTrackSource } from './HMSTrackSource';
 
 const {
   /**
@@ -51,7 +52,7 @@ export class HMSLocalVideoTrack extends HMSVideoTrack {
   constructor(params: {
     id: string;
     trackId: string;
-    source?: number | string;
+    source?: HMSTrackSource;
     trackDescription?: string;
     isMute?: boolean;
     settings?: HMSVideoTrackSettings;

package/src/classes/HMSManagerModule.ts

@@ -0,0 +1,18 @@
+import { NativeModules } from 'react-native';
+
+const { HMSManager } = NativeModules;
+
+if (HMSManager == null) {
+  console.error(
+    `[@100mslive/react-native-hms] react-native-hms module was not found. Make sure you're running your app on the native platform and your code is linked properly (cd ios && pod install && cd ..).
+
+    For installation instructions, please refer to https://www.100ms.live/docs/react-native/v2/how-to-guides/install-the-sdk/integration`
+      .split('\n')
+      .map((line) => line.trim())
+      .join('\n')
+  );
+}
+
+export type HMSManagerProps = any;
+
+export default HMSManager as HMSManagerProps;

package/src/classes/HMSNativeEventEmitter.ts

@@ -1,4 +1,5 @@
-import { EventSubscription, NativeEventEmitter } from 'react-native';
+import { NativeEventEmitter } from 'react-native';
+import type { EventSubscription } from 'react-native';
 import { logger } from './HMSLogger';
 
 export type HMSEventSubscription = {

package/src/classes/HMSNativeEventListener.ts

@@ -0,0 +1,8 @@
+import HMSManager from './HMSManagerModule';
+import { HMSNativeEventEmitter } from './HMSNativeEventEmitter';
+
+export type { HMSEventSubscription as HMSNativeEventSubscription } from './HMSNativeEventEmitter';
+
+const HMSNativeEventListener = new HMSNativeEventEmitter(HMSManager);
+
+export default HMSNativeEventListener;

package/src/classes/HMSPeer.ts

@@ -8,44 +8,83 @@ import { HMSConstants } from './HMSConstants';
 
 export class HMSPeer {
   peerID: string;
-  /**
-   * @deprecated customerDescription property has been deprecated in favor of metadata property
-   */
-  customerDescription?: string;
+  private _name: string = '';
+  private _isLocal: boolean | undefined;
+  private _customerUserID: string | undefined;
+  private _metadata: string | undefined;
+  private _role: HMSRole | undefined;
+
+  private _updateName(value: string) {
+    // If `_name` is outdated, update it
+    if (this._name !== value) {
+      this._name = value;
+    }
+  }
+
+  private _updateIsLocal(value: boolean) {
+    // If `_isLocal` is outdated, update it
+    if (this._isLocal !== value) {
+      this._isLocal = value;
+    }
+  }
+
+  private _updateCustomerUserID(value: string) {
+    // If `_customerUserID` is outdated, update it
+    if (this._customerUserID !== value) {
+      this._customerUserID = value;
+    }
+  }
+
+  private _updateMetadata(value: string) {
+    // If `_metadata` is outdated, update it
+    if (this._metadata !== value) {
+      this._metadata = value;
+    }
+  }
 
-  constructor(params: { peerID: string; customerDescription?: string }) {
+  private _updateRole(value: HMSRole) {
+    // If `_role` is outdated, update it
+    if (this._role !== value) {
+      this._role = value;
+    }
+  }
+
+  constructor(params: { peerID: string }) {
     this.peerID = params.peerID;
-    this.customerDescription = params.customerDescription;
   }
 
   get name(): string {
     const hmsPeersCache = getHmsPeersCache();
 
-    if (hmsPeersCache) {
-      return hmsPeersCache.getProperty(this.peerID, 'name') || '';
-    }
+    const nameValue = hmsPeersCache
+      ? hmsPeersCache.getProperty(this.peerID, 'name')
+      : getPeerPropertyFromNative(
+          HMSConstants.DEFAULT_SDK_ID,
+          this.peerID,
+          'name'
+        );
 
-    return (
-      getPeerPropertyFromNative(
-        HMSConstants.DEFAULT_SDK_ID,
-        this.peerID,
-        'name'
-      ) || ''
-    );
+    if (nameValue) {
+      this._updateName(nameValue);
+    }
+    return nameValue ?? this._name;
   }
 
   get isLocal(): boolean | undefined {
     const hmsPeersCache = getHmsPeersCache();
 
-    if (hmsPeersCache) {
-      return hmsPeersCache.getProperty(this.peerID, 'isLocal');
-    }
+    const value = hmsPeersCache
+      ? hmsPeersCache.getProperty(this.peerID, 'isLocal')
+      : getPeerPropertyFromNative(
+          HMSConstants.DEFAULT_SDK_ID,
+          this.peerID,
+          'isLocal'
+        );
 
-    return getPeerPropertyFromNative(
-      HMSConstants.DEFAULT_SDK_ID,
-      this.peerID,
-      'isLocal'
-    );
+    if (typeof value === 'boolean') {
+      this._updateIsLocal(value);
+    }
+    return value ?? this._isLocal;
   }
 
   get networkQuality(): HMSNetworkQuality | undefined {
@@ -65,43 +104,52 @@ export class HMSPeer {
   get customerUserID(): string | undefined {
     const hmsPeersCache = getHmsPeersCache();
 
-    if (hmsPeersCache) {
-      return hmsPeersCache.getProperty(this.peerID, 'customerUserID');
-    }
+    const value = hmsPeersCache
+      ? hmsPeersCache.getProperty(this.peerID, 'customerUserID')
+      : getPeerPropertyFromNative(
+          HMSConstants.DEFAULT_SDK_ID,
+          this.peerID,
+          'customerUserID'
+        );
 
-    return getPeerPropertyFromNative(
-      HMSConstants.DEFAULT_SDK_ID,
-      this.peerID,
-      'customerUserID'
-    );
+    if (value) {
+      this._updateCustomerUserID(value);
+    }
+    return value ?? this._customerUserID;
   }
 
   get metadata(): string | undefined {
     const hmsPeersCache = getHmsPeersCache();
 
-    if (hmsPeersCache) {
-      return hmsPeersCache.getProperty(this.peerID, 'metadata');
-    }
+    const value = hmsPeersCache
+      ? hmsPeersCache.getProperty(this.peerID, 'metadata')
+      : getPeerPropertyFromNative(
+          HMSConstants.DEFAULT_SDK_ID,
+          this.peerID,
+          'metadata'
+        );
 
-    return getPeerPropertyFromNative(
-      HMSConstants.DEFAULT_SDK_ID,
-      this.peerID,
-      'metadata'
-    );
+    if (value) {
+      this._updateMetadata(value);
+    }
+    return value ?? this._metadata;
   }
 
   get role(): HMSRole | undefined {
     const hmsPeersCache = getHmsPeersCache();
 
-    if (hmsPeersCache) {
-      return hmsPeersCache.getProperty(this.peerID, 'role');
-    }
+    const value = hmsPeersCache
+      ? hmsPeersCache.getProperty(this.peerID, 'role')
+      : getPeerPropertyFromNative(
+          HMSConstants.DEFAULT_SDK_ID,
+          this.peerID,
+          'role'
+        );
 
-    return getPeerPropertyFromNative(
-      HMSConstants.DEFAULT_SDK_ID,
-      this.peerID,
-      'role'
-    );
+    if (value) {
+      this._updateRole(value);
+    }
+    return value ?? this._role;
   }
 
   get audioTrack(): HMSAudioTrack | undefined {

package/src/classes/HMSPeerUpdate.ts

@@ -10,8 +10,8 @@ export enum HMSPeerUpdate {
 export const HMSPeerUpdateOrdinals = new Map([
   ['0', HMSPeerUpdate.PEER_JOINED],
   ['1', HMSPeerUpdate.PEER_LEFT],
-  ['9', HMSPeerUpdate.ROLE_CHANGED],
-  ['10', HMSPeerUpdate.NAME_CHANGED],
-  ['11', HMSPeerUpdate.METADATA_CHANGED],
-  ['12', HMSPeerUpdate.NETWORK_QUALITY_UPDATED],
+  ['4', HMSPeerUpdate.ROLE_CHANGED],
+  ['5', HMSPeerUpdate.NAME_CHANGED],
+  ['6', HMSPeerUpdate.METADATA_CHANGED],
+  ['7', HMSPeerUpdate.NETWORK_QUALITY_UPDATED],
 ]);

package/src/classes/HMSPeersCache.ts

@@ -1,13 +1,15 @@
-import { NativeModules } from 'react-native';
-import type { HMSPeer } from './HMSPeer';
+import HMSManager from './HMSManagerModule';
+
 import { HMSEncoder } from './HMSEncoder';
 import { HMSPeerUpdate } from './HMSPeerUpdate';
 import { HMSTrackUpdate } from './HMSTrackUpdate';
 import type { HMSTrack } from './HMSTrack';
 import { HMSTrackType } from './HMSTrackType';
 import { HMSTrackSource } from './HMSTrackSource';
-
-const { HMSManager } = NativeModules;
+import type { HMSNetworkQuality } from './HMSNetworkQuality';
+import type { HMSRole } from './HMSRole';
+import type { HMSAudioTrack } from './HMSAudioTrack';
+import type { HMSVideoTrack } from './HMSVideoTrack';
 
 export let hmsPeersCache: HMSPeersCache | undefined;
 
@@ -26,9 +28,18 @@ export const clearHmsPeersCache = () => {
   hmsPeersCache = undefined;
 };
 
-export type HMSPeerCacheProps = Partial<
-  Omit<HMSPeer, 'peerID' | 'customerDescription'>
->;
+export type HMSPeerCacheProps = {
+  peerID?: string | undefined;
+  name?: string | undefined;
+  isLocal?: boolean | undefined;
+  networkQuality?: HMSNetworkQuality | undefined;
+  customerUserID?: string | undefined;
+  metadata?: string | undefined;
+  role?: HMSRole | undefined;
+  audioTrack?: HMSAudioTrack | undefined;
+  videoTrack?: HMSVideoTrack | undefined;
+  auxiliaryTracks?: HMSTrack[] | undefined;
+};
 
 export class HMSPeersCache {
   private _data = new Map<string, HMSPeerCacheProps>();
@@ -66,12 +77,19 @@ export class HMSPeersCache {
   ) {
     const peerObj = this._data.get(peerId);
 
+    if (updateType === HMSPeerUpdate.PEER_JOINED) {
+      if (!peerObj) {
+        this._data.set(peerId, data);
+      }
+      return;
+    }
+
     if (updateType === HMSPeerUpdate.PEER_LEFT) {
       this._data.delete(peerId);
       return;
     }
 
-    let updatedObj = { ...peerObj };
+    let updatedObj = peerObj || {};
 
     switch (updateType) {
       case HMSTrackUpdate.TRACK_ADDED: {
@@ -79,7 +97,8 @@ export class HMSPeersCache {
 
         if (track.source === HMSTrackSource.REGULAR) {
           if (track.type === HMSTrackType.VIDEO) {
-            updatedObj.videoTrack = { ...track, isDegraded: false };
+            updatedObj.videoTrack = track;
+            updatedObj.videoTrack.isDegraded = false;
           } else if (track.type === HMSTrackType.AUDIO) {
             updatedObj.audioTrack = track;
           }
@@ -102,12 +121,9 @@ export class HMSPeersCache {
             updatedObj.audioTrack = undefined;
           }
         } else if (Array.isArray(updatedObj.auxiliaryTracks)) {
-          updatedObj = {
-            ...updatedObj,
-            auxiliaryTracks: updatedObj.auxiliaryTracks.filter(
-              (auxiliaryTrack) => auxiliaryTrack.trackId !== track.trackId
-            ),
-          };
+          updatedObj.auxiliaryTracks = updatedObj.auxiliaryTracks.filter(
+            (auxiliaryTrack) => auxiliaryTrack.trackId !== track.trackId
+          );
         }
         break;
       }
@@ -117,10 +133,9 @@ export class HMSPeersCache {
 
         if (track.source === HMSTrackSource.REGULAR) {
           if (track.type === HMSTrackType.VIDEO) {
-            updatedObj.videoTrack = {
-              ...track,
-              isDegraded: updatedObj.videoTrack?.isDegraded || false,
-            };
+            const oldIsDegraded = updatedObj.videoTrack?.isDegraded || false;
+            updatedObj.videoTrack = track;
+            updatedObj.videoTrack.isDegraded = oldIsDegraded;
           } else if (track.type === HMSTrackType.AUDIO) {
             updatedObj.audioTrack = track;
           }
@@ -147,30 +162,26 @@ export class HMSPeersCache {
 
         if (track.source === HMSTrackSource.REGULAR) {
           if (track.type === HMSTrackType.VIDEO) {
-            updatedObj.videoTrack = {
-              ...track,
-              isDegraded: updateType === HMSTrackUpdate.TRACK_DEGRADED,
-            };
+            updatedObj.videoTrack = track;
+            updatedObj.videoTrack.isDegraded =
+              updateType === HMSTrackUpdate.TRACK_DEGRADED;
           } else if (track.type === HMSTrackType.AUDIO) {
             updatedObj.audioTrack = track;
           }
         } else {
           if (Array.isArray(updatedObj.auxiliaryTracks)) {
-            updatedObj = {
-              ...updatedObj,
-              auxiliaryTracks: updatedObj.auxiliaryTracks.map(
-                (auxiliaryTrack) => {
-                  if (auxiliaryTrack.trackId === track.trackId) {
-                    return {
-                      ...auxiliaryTrack,
-                      isDegraded: updateType === HMSTrackUpdate.TRACK_DEGRADED,
-                    };
-                  }
-
-                  return auxiliaryTrack;
+            updatedObj.auxiliaryTracks = updatedObj.auxiliaryTracks.map(
+              (auxiliaryTrack) => {
+                if (auxiliaryTrack.trackId === track.trackId) {
+                  return {
+                    ...auxiliaryTrack,
+                    isDegraded: updateType === HMSTrackUpdate.TRACK_DEGRADED,
+                  };
                 }
-              ),
-            };
+
+                return auxiliaryTrack;
+              }
+            );
           } else {
             updatedObj.auxiliaryTracks = [track];
           }
@@ -187,11 +198,12 @@ export class HMSPeersCache {
         );
         break;
       }
-      case HMSPeerUpdate.METADATA_CHANGED:
-      case HMSPeerUpdate.NAME_CHANGED:
-      case HMSPeerUpdate.PEER_JOINED:
-      case HMSPeerUpdate.ROLE_CHANGED: {
-        updatedObj = { ...updatedObj, ...data };
+      case HMSPeerUpdate.METADATA_CHANGED: {
+        updatedObj.metadata = data.metadata;
+        break;
+      }
+      case HMSPeerUpdate.NAME_CHANGED: {
+        updatedObj.name = data.name;
         break;
       }
       default: {
@@ -243,7 +255,7 @@ export function getPeerPropertyFromNative<T extends keyof HMSPeerCacheProps>(
         ? HMSEncoder.encodeHmsAuxiliaryTracks(data.auxiliaryTracks, id)
         : undefined;
   } else if (property === 'name') {
-    value = data?.[property] || '';
+    value = data?.[property];
   } else {
     value = data ? data[property] : undefined;
   }

package/src/classes/HMSRTMPConfig.ts

@@ -1,13 +1,13 @@
 import type { HMSRtmpVideoResolution } from './HMSRtmpVideoResolution';
 
 export class HMSRTMPConfig {
-  meetingURL: string;
+  meetingURL?: string;
   rtmpURLs?: Array<string>;
   record: boolean;
   resolution?: HMSRtmpVideoResolution;
 
   constructor(params: {
-    meetingURL: string;
+    meetingURL?: string;
     rtmpURLs?: Array<string>;
     record: boolean;
     resolution?: HMSRtmpVideoResolution;

package/src/classes/HMSRemoteAudioTrack.ts

@@ -2,6 +2,7 @@ import { NativeModules } from 'react-native';
 import { getLogger } from './HMSLogger';
 import type { HMSTrackType } from './HMSTrackType';
 import { HMSAudioTrack } from './HMSAudioTrack';
+import type { HMSTrackSource } from './HMSTrackSource';
 
 const {
   /**
@@ -54,7 +55,7 @@ export class HMSRemoteAudioTrack extends HMSAudioTrack {
 
   constructor(params: {
     trackId: string;
-    source?: number | string;
+    source?: HMSTrackSource;
     isMute?: boolean;
     trackDescription?: string;
     playbackAllowed?: boolean;