@100mslive/react-native-hms 0.9.93 → 1.0.0

package/src/classes/HMSSDK.tsx

@@ -1,5 +1,11 @@
 import React from 'react';
-import { AppState, NativeEventEmitter, NativeModules, Platform, ViewStyle } from 'react-native';
+import {
+  AppState,
+  NativeEventEmitter,
+  NativeModules,
+  Platform,
+  ViewStyle,
+} from 'react-native';
 
 import { HMSEncoder } from './HMSEncoder';
 import { HMSHelper } from './HMSHelper';
@@ -27,6 +33,8 @@ import type { HMSHLSConfig } from './HMSHLSConfig';
 import type { HMSAudioDevice } from './HMSAudioDevice';
 import type { HMSAudioMode } from './HMSAudioMode';
 import type { HMSAudioMixingMode } from './HMSAudioMixingMode';
+import type { HMSLogSettings } from './HMSLogSettings';
+import { HMSMessageType } from './HMSMessageType';
 
 interface HmsViewProps {
   trackId: string;
@@ -36,6 +44,10 @@ interface HmsViewProps {
   setZOrderMediaOverlay?: boolean;
 }
 
+interface PIPConfig {
+  aspectRatio?: [number, number];
+}
+
 const {
   /**
    * @ignore
@@ -43,15 +55,13 @@ const {
   HMSManager,
 } = NativeModules;
 
+const ReactNativeVersion = require('react-native/Libraries/Core/ReactNativeVersion');
+
 const HmsEventEmitter = new NativeEventEmitter(HMSManager);
 
 let HmsSdk: HMSSDK | undefined;
 
 export class HMSSDK {
-  room?: HMSRoom;
-  localPeer?: HMSLocalPeer;
-  remotePeers?: HMSRemotePeer[];
-  knownRoles?: HMSRole[];
   id: string;
   private muteStatus: boolean | undefined;
   private appStateSubscription?: any;
@@ -81,9 +91,18 @@ export class HMSSDK {
   }
 
   /**
-   * - Returns an instance of [HMSSDK]{@link HMSSDK}
+   * - Returns an instance of [HMSSDK] {@link HMSSDK}
    * - This function must be called to get an instance of HMSSDK class and only then user can interact with its methods.
    *
+   * Regular Usage:
+   *
+   * const hmsInstance = await HMSSDK.build();
+   *
+   * For Advanced Use-Cases:
+   * @param {trackSettings} trackSettings is an optional value only required to enable features like iOS Screen/Audio Share, Android Software Echo Cancellation, etc
+   * @param {appGroup} appGroup is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
+   * @param {preferredExtension} preferredExtension is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
+   *
    * @static
    * @returns
    * @memberof HMSSDK
@@ -92,14 +111,21 @@ export class HMSSDK {
     trackSettings?: HMSTrackSettings;
     appGroup?: String;
     preferredExtension?: String;
+    logSettings?: HMSLogSettings;
   }) {
+    const { version } = require('../../package.json');
+    const { major, minor, patch } = ReactNativeVersion.version;
     let id = await HMSManager.build({
       trackSettings: params?.trackSettings,
       appGroup: params?.appGroup, // required for iOS Screenshare, not required for Android
       preferredExtension: params?.preferredExtension, // required for iOS Screenshare, not required for Android
+      frameworkInfo: {
+        version: major + '.' + minor + '.' + patch,
+        sdkVersion: version,
+      },
+      logSettings: params?.logSettings,
     });
     HmsSdk = new HMSSDK(id);
-    HmsSdk.attachPreviewListener();
     HmsSdk.attachListeners();
     return HmsSdk;
   }
@@ -134,24 +160,16 @@ export class HMSSDK {
   };
 
   /**
-   * - Attaches preview listener for native callbacks.
-   * Note:this function connects sdk to native side and not app to sdk.
-   *
+   * - Attaches all the listeners to native callbacks.
+   * Note: this function connects sdk to native side and not app to sdk.
    * @memberof HMSSDK
    */
-  attachPreviewListener = () => {
+  attachListeners = () => {
     HmsEventEmitter.addListener(
       HMSUpdateListenerActions.ON_PREVIEW,
       this.onPreviewListener
     );
-  };
 
-  /**
-   * - Attaches all the listeners to native callbacks.
-   * Note: this function connects sdk to native side and not app to sdk.
-   * @memberof HMSSDK
-   */
-  attachListeners = () => {
     HmsEventEmitter.addListener(
       HMSUpdateListenerActions.ON_JOIN,
       this.onJoinListener
@@ -254,6 +272,11 @@ export class HMSSDK {
       this.onJoinListener
     );
 
+    HmsEventEmitter.removeListener(
+      HMSUpdateListenerActions.ON_PREVIEW,
+      this.onPreviewListener
+    );
+
     HmsEventEmitter.removeListener(
       HMSUpdateListenerActions.ON_ROOM_UPDATE,
       this.onRoomListener
@@ -434,10 +457,6 @@ export class HMSSDK {
 
     const op = await HMSManager.leave(data);
     this.muteStatus = undefined;
-    this.localPeer = undefined;
-    this.remotePeers = undefined;
-    this.room = undefined;
-    this.knownRoles = undefined;
     this?.appStateSubscription?.remove();
     return op;
   };
@@ -450,7 +469,10 @@ export class HMSSDK {
    * @param {message: string} and @param {type: string}
    * @memberof HMSSDK
    */
-  sendBroadcastMessage = async (message: string, type: string = 'chat') => {
+  sendBroadcastMessage = async (
+    message: string,
+    type: HMSMessageType = HMSMessageType.CHAT
+  ) => {
     logger?.verbose('#Function sendBroadcastMessage', {
       message,
       type: type || null,
@@ -474,7 +496,7 @@ export class HMSSDK {
   sendGroupMessage = async (
     message: string,
     roles: HMSRole[],
-    type: string = 'chat'
+    type: HMSMessageType = HMSMessageType.CHAT
   ) => {
     logger?.verbose('#Function sendGroupMessage', {
       message,
@@ -501,7 +523,7 @@ export class HMSSDK {
   sendDirectMessage = async (
     message: string,
     peer: HMSPeer,
-    type: string = 'chat'
+    type: HMSMessageType = HMSMessageType.CHAT
   ) => {
     logger?.verbose('#Function sendDirectMessage', {
       message,
@@ -756,7 +778,7 @@ export class HMSSDK {
 
   /**
    * - setPlaybackForAllAudio is an extension of the abilities of setPlaybackAllowed in
-   * {@link HMSRemoteAudioTrack}, it sets mute status for all peers in the room
+   * HMSRemoteAudioTrack. It sets mute status for all peers in the room only for the local peer.
    *
    * checkout {@link https://www.100ms.live/docs/react-native/v2/features/playback-allowed} for more info
    *
@@ -785,11 +807,10 @@ export class HMSSDK {
    * checkout {@link https://www.100ms.live/docs/react-native/v2/features/join#get-room} for more info
    *
    * @memberof HMSSDK
-   * @return HMSRoom
+   * @return Promise<HMSRoom>
    */
-  getRoom = async () => {
+  getRoom = async (): Promise<HMSRoom> => {
     logger?.verbose('#Function getRoom', {
-      roomID: this.room?.id,
       id: this.id,
     });
     const hmsRoom = await HMSManager.getRoom({ id: this.id });
@@ -798,6 +819,60 @@ export class HMSSDK {
     return encodedHmsRoom;
   };
 
+  /**
+   * - getLocalPeer is a wrapper function on an existing native function also known as getLocalPeer the returns
+   * current local peer object which is of type {@link HMSLocalPeer}
+   *
+   * @memberof HMSSDK
+   * @return Promise<HMSLocalPeer>
+   */
+  getLocalPeer = async (): Promise<HMSLocalPeer> => {
+    logger?.verbose('#Function getLocalPeer', {
+      id: this.id,
+    });
+    const localPeer = await HMSManager.getLocalPeer({ id: this.id });
+
+    const encodedLocalPeer = HMSEncoder.encodeHmsLocalPeer(localPeer, this.id);
+    return encodedLocalPeer;
+  };
+
+  /**
+   * - getRemotePeers is a wrapper function on an existing native function also known as getRemotePeers the returns
+   * remote peers array which is of type {@link HMSRemotePeer}
+   *
+   * @memberof HMSSDK
+   * @return Promise<HMSRemotePeer[]>
+   */
+  getRemotePeers = async (): Promise<HMSRemotePeer[]> => {
+    logger?.verbose('#Function getRemotePeers', {
+      id: this.id,
+    });
+    const remotePeers = await HMSManager.getRemotePeers({ id: this.id });
+
+    const encodedRemotePeers = HMSEncoder.encodeHmsRemotePeers(
+      remotePeers,
+      this.id
+    );
+    return encodedRemotePeers;
+  };
+
+  /**
+   * - getRoles is a wrapper function on an existing native function also known as getRoles the returns
+   * array of all present roles which is of type {@link HMSRole}
+   *
+   * @memberof HMSSDK
+   * @return Promise<HMSRole[]>
+   */
+  getRoles = async (): Promise<HMSRole[]> => {
+    logger?.verbose('#Function getRoles', {
+      id: this.id,
+    });
+    const roles = await HMSManager.getRoles({ id: this.id });
+
+    const encodedRoles = HMSEncoder.encodeHmsRoles(roles);
+    return encodedRoles;
+  };
+
   /**
    * - This function sets the volume of any peer in the room
    *
@@ -908,6 +983,16 @@ export class HMSSDK {
     HMSManager.disableRTCStats({ id: this.id });
   };
 
+  enableNetworkQualityUpdates = () => {
+    logger?.verbose('#Function enableNetworkQualityUpdates', { id: this.id });
+    HMSManager.enableNetworkQualityUpdates({ id: this.id });
+  };
+
+  disableNetworkQualityUpdates = () => {
+    logger?.verbose('#Function disableNetworkQualityUpdates', { id: this.id });
+    HMSManager.disableNetworkQualityUpdates({ id: this.id });
+  };
+
   /**
    * - This wrapper function is used to start streaming device audio, currently available only for android.
    *
@@ -1111,6 +1196,24 @@ export class HMSSDK {
     }
   };
 
+  setSessionMetaData = async (sessionMetaData: string | null) => {
+    logger?.verbose('#Function setSessionMetaData', {
+      id: this.id,
+      sessionMetaData,
+    });
+    return await HMSManager.setSessionMetaData({
+      id: this.id,
+      sessionMetaData,
+    });
+  };
+
+  getSessionMetaData = async () => {
+    logger?.verbose('#Function getSessionMetaData', {
+      id: this.id,
+    });
+    return await HMSManager.getSessionMetaData({ id: this.id });
+  };
+
   /**
    * - This is a prototype event listener that takes action and listens for updates related to that particular action
    *
@@ -1299,25 +1402,17 @@ export class HMSSDK {
       return;
     }
     const room: HMSRoom = HMSEncoder.encodeHmsRoom(data.room, this.id);
-    const localPeer: HMSLocalPeer = HMSEncoder.encodeHmsLocalPeer(
-      data.localPeer,
+    const previewTracks = HMSEncoder.encodeHmsPreviewTracks(
+      data.previewTracks,
       this.id
     );
 
-    const previewTracks = HMSEncoder.encodeHmsPreviewTracks(data.previewTracks);
-
-    this.localPeer = localPeer;
-    this.room = room;
     if (this.onPreviewDelegate) {
       logger?.verbose('#Listener ON_PREVIEW_LISTENER_CALL', {
-        ...data,
         room,
-        localPeer,
         previewTracks,
       });
-      this.onPreviewDelegate({ ...data, room, localPeer, previewTracks });
-    } else {
-      logger?.verbose('#Listener ON_PREVIEW', data);
+      this.onPreviewDelegate({ room, previewTracks });
     }
   };
 
@@ -1325,31 +1420,14 @@ export class HMSSDK {
     if (data.id !== this.id) {
       return;
     }
-    // Preprocessing
+
     const room: HMSRoom = HMSEncoder.encodeHmsRoom(data.room, this.id);
-    const localPeer: HMSLocalPeer = HMSEncoder.encodeHmsLocalPeer(
-      data.localPeer,
-      this.id
-    );
-    const remotePeers: HMSRemotePeer[] = HMSEncoder.encodeHmsRemotePeers(
-      data.remotePeers,
-      this.id
-    );
-    const roles: HMSRole[] = HMSEncoder.encodeHmsRoles(data.roles);
-    this.room = room;
-    this.localPeer = localPeer;
-    this.remotePeers = remotePeers;
-    this.knownRoles = roles;
+
     if (this.onJoinDelegate) {
       logger?.verbose('#Listener ON_JOIN_LISTENER_CALL', {
-        ...data,
         room,
-        localPeer,
-        remotePeers,
       });
-      this.onJoinDelegate({ ...data, room, localPeer, remotePeers });
-    } else {
-      logger?.verbose('#LISTENER ON_JOIN', data);
+      this.onJoinDelegate({ room });
     }
   };
 
@@ -1358,27 +1436,14 @@ export class HMSSDK {
       return;
     }
     const room: HMSRoom = HMSEncoder.encodeHmsRoom(data.room, this.id);
-    const localPeer: HMSLocalPeer = HMSEncoder.encodeHmsLocalPeer(
-      data.localPeer,
-      this.id
-    );
-    const remotePeers: HMSRemotePeer[] = HMSEncoder.encodeHmsRemotePeers(
-      data.remotePeers,
-      this.id
-    );
-    this.room = room;
-    this.localPeer = localPeer;
-    this.remotePeers = remotePeers;
+    const type = data.type;
+
     if (this.onRoomDelegate) {
       logger?.verbose('#Listener ON_ROOM_LISTENER_CALL', {
-        ...data,
         room,
-        localPeer,
-        remotePeers,
+        type,
       });
-      this.onRoomDelegate({ ...data, room, localPeer, remotePeers });
-    } else {
-      logger?.verbose('#Listener ON_ROOM', data);
+      this.onRoomDelegate({ room, type });
     }
   };
 
@@ -1387,30 +1452,14 @@ export class HMSSDK {
       return;
     }
     const peer: HMSPeer = HMSEncoder.encodeHmsPeer(data.peer, this.id);
-    const room: HMSRoom = HMSEncoder.encodeHmsRoom(data.room, this.id);
-    const localPeer: HMSLocalPeer = HMSEncoder.encodeHmsLocalPeer(
-      data.localPeer,
-      this.id
-    );
-    const remotePeers: HMSRemotePeer[] = HMSEncoder.encodeHmsRemotePeers(
-      data.remotePeers,
-      this.id
-    );
-    // this.room = room;
-    this.localPeer = localPeer;
-    this.remotePeers = remotePeers;
-    this.room = room;
+    const type = data.type;
+
     if (this.onPeerDelegate) {
       logger?.verbose('#Listener ON_PEER_LISTENER_CALL', {
-        ...data,
-        localPeer,
-        remotePeers,
-        room,
         peer,
+        type,
       });
-      this.onPeerDelegate({ ...data, localPeer, remotePeers, room, peer });
-    } else {
-      logger?.verbose('#Listener ON_PEER', data);
+      this.onPeerDelegate({ peer, type });
     }
   };
 
@@ -1420,15 +1469,8 @@ export class HMSSDK {
     }
     const track: HMSTrack = HMSEncoder.encodeHmsTrack(data.track, this.id);
     const peer: HMSPeer = HMSEncoder.encodeHmsPeer(data.peer, this.id);
-    const room: HMSRoom = HMSEncoder.encodeHmsRoom(data.room, this.id);
-    const localPeer: HMSLocalPeer = HMSEncoder.encodeHmsLocalPeer(
-      data.localPeer,
-      this.id
-    );
-    const remotePeers: HMSRemotePeer[] = HMSEncoder.encodeHmsRemotePeers(
-      data.remotePeers,
-      this.id
-    );
+    const type = data.type;
+
     if (
       this.muteStatus &&
       data?.type === 'TRACK_ADDED' &&
@@ -1436,28 +1478,18 @@ export class HMSSDK {
     ) {
       this.setPlaybackForAllAudio(this.muteStatus);
     }
-    this.room = room;
-    this.localPeer = localPeer;
-    this.remotePeers = remotePeers;
+
     if (this.onTrackDelegate) {
       logger?.verbose('#Listener ON_TRACK_LISTENER_CALL', {
-        ...data,
-        localPeer,
-        remotePeers,
-        room,
         peer,
         track,
+        type,
       });
       this.onTrackDelegate({
-        ...data,
-        localPeer,
-        remotePeers,
-        room,
         peer,
         track,
+        type,
       });
-    } else {
-      logger?.verbose('#Listener ON_TRACK', data);
     }
   };
 
@@ -1469,8 +1501,6 @@ export class HMSSDK {
     if (this.onMessageDelegate) {
       logger?.verbose('#Listener ON_MESSAGE_LISTENER_CALL', message);
       this.onMessageDelegate(message);
-    } else {
-      logger?.verbose('#Listener ON_MESSAGE', data);
     }
   };
 
@@ -1483,8 +1513,6 @@ export class HMSSDK {
       this.onSpeakerDelegate(
         HMSEncoder.encodeHmsSpeakers(data?.speakers, this.id)
       );
-    } else {
-      logger?.verbose('#Listener ON_SPEAKER', data?.speakers);
     }
   };
 
@@ -1496,9 +1524,6 @@ export class HMSSDK {
       logger?.verbose('#Listener ON_ERROR_LISTENER_CALL', data);
       logger?.warn('#Listener ON_ERROR_LISTENER_CALL', data);
       this.onErrorDelegate(HMSEncoder.encodeHMSException(data));
-    } else {
-      logger?.warn('#Listener ON_ERROR', data);
-      logger?.verbose('#Listener ON_ERROR', data);
     }
   };
 
@@ -1516,8 +1541,6 @@ export class HMSSDK {
         encodedRoleChangeRequest
       );
       this.onRoleChangeRequestDelegate(encodedRoleChangeRequest);
-    } else {
-      logger?.verbose('#Listener ON_ROLE_CHANGE_REQUEST', data);
     }
   };
 
@@ -1533,8 +1556,6 @@ export class HMSSDK {
         encodedRoleChangeRequest
       );
       this.onChangeTrackStateRequestDelegate(encodedRoleChangeRequest);
-    } else {
-      logger?.verbose('#Listener ON_CHANGE_TRACK_STATE_REQUEST', data);
     }
   };
 
@@ -1557,8 +1578,6 @@ export class HMSSDK {
         id: this.id,
       });
       this.onRemovedFromRoomDelegate({ requestedBy, reason, roomEnded });
-    } else {
-      logger?.verbose('#Listener ON_REMOVED_FROM_ROOM', data);
     }
   };
 
@@ -1569,8 +1588,6 @@ export class HMSSDK {
     if (this.onReconnectingDelegate) {
       logger?.verbose('#Listener ON_RECONNECTING_CALL', data);
       this.onReconnectingDelegate(data);
-    } else {
-      logger?.verbose('#Listener ON_RECONNECTING', data);
     }
   };
 
@@ -1578,12 +1595,9 @@ export class HMSSDK {
     if (data.id !== this.id) {
       return;
     }
-    logger?.verbose('#Listener ON_RECONNECTED', data);
     if (this.onReconnectedDelegate) {
       logger?.verbose('#Listener ON_RECONNECTED_CALL', data);
       this.onReconnectedDelegate(data);
-    } else {
-      logger?.verbose('#Listener ON_RECONNECTED', data);
     }
   };
 
@@ -1597,8 +1611,6 @@ export class HMSSDK {
     if (this.onRtcStatsDelegate) {
       logger?.verbose('#Listener RTCStatsListener_CALL', { rtcStats });
       this.onRtcStatsDelegate({ rtcStats });
-    } else {
-      logger?.verbose('#Listener RTCStatsListener', data);
     }
   };
 
@@ -1619,8 +1631,6 @@ export class HMSSDK {
         track,
       });
       this.onLocalAudioStatsDelegate({ ...data, localAudioStats, peer, track });
-    } else {
-      logger?.verbose('#Listener onLocalAudioStatsListener', data);
     }
   };
 
@@ -1641,8 +1651,6 @@ export class HMSSDK {
         track,
       });
       this.onLocalVideoStatsDelegate({ ...data, localVideoStats, peer, track });
-    } else {
-      logger?.verbose('#Listener onLocalVideoStatsListener', data);
     }
   };
 
@@ -1668,8 +1676,6 @@ export class HMSSDK {
         peer,
         track,
       });
-    } else {
-      logger?.verbose('#Listener onRemoteAudioStatsListener', data);
     }
   };
 
@@ -1695,8 +1701,6 @@ export class HMSSDK {
         peer,
         track,
       });
-    } else {
-      logger?.verbose('#Listener onRemoteVideoStatsListener', data);
     }
   };
 
@@ -1713,8 +1717,20 @@ export class HMSSDK {
       this.onAudioDeviceChangedDelegate({
         ...data,
       });
-    } else {
-      logger?.verbose('#Listener onAudioDeviceChangedListener', data);
     }
   };
+
+  async isPipModeSupported(): Promise<undefined | boolean> {
+    return HMSManager.handlePipActions('isPipModeSupported', null);
+  }
+
+  async enablePipMode(data?: PIPConfig): Promise<undefined | boolean> {
+    const config = { aspectRatio: [16, 9], ...(data || {}) };
+
+    return HMSManager.handlePipActions('enablePipMode', config);
+  }
+
+  async setPipParams(data?: PIPConfig): Promise<undefined | boolean> {
+    return HMSManager.handlePipActions('setPictureInPictureParams', data || null);
+  }
 }

package/src/classes/HMSServerRecordingState.ts

@@ -1,12 +1,12 @@
 import type { HMSException } from './HMSException';
 
 export class HMSServerRecordingState {
-  running: string;
+  running: boolean;
   error?: HMSException;
   startedAt: Date;
 
   constructor(params: {
-    running: string;
+    running: boolean;
     error?: HMSException;
     startedAt: Date;
   }) {

package/src/classes/HMSSubscribeSettings.ts

@@ -1,14 +1,14 @@
 export class HMSSubscribeSettings {
-  subscribeToRoles?: [string];
+  subscribeTo?: [string];
   maxSubsBitRate: number;
   maxDisplayTiles?: number;
 
   constructor(params: {
-    subscribeToRoles?: [string];
+    subscribeTo?: [string];
     maxSubsBitRate: number;
     maxDisplayTiles?: number;
   }) {
-    this.subscribeToRoles = params.subscribeToRoles;
+    this.subscribeTo = params.subscribeTo;
     this.maxSubsBitRate = params.maxSubsBitRate;
     this.maxDisplayTiles = params.maxDisplayTiles;
   }

package/src/classes/HMSTrackSettings.ts

@@ -4,17 +4,14 @@ import type { HMSVideoTrackSettings } from './HMSVideoTrackSettings';
 export class HMSTrackSettings {
   video?: HMSVideoTrackSettings;
   audio?: HMSAudioTrackSettings;
-  useHardwareEchoCancellation?: boolean;
 
   constructor(params?: {
     video?: HMSVideoTrackSettings;
     audio?: HMSAudioTrackSettings;
-    useHardwareEchoCancellation?: boolean;
   }) {
     if (params) {
       this.video = params.video;
       this.audio = params.audio;
-      this.useHardwareEchoCancellation = params.useHardwareEchoCancellation;
     }
   }
 }

package/src/classes/HMSTrackSettingsInitState.ts

@@ -0,0 +1,4 @@
+export enum HMSTrackSettingsInitState {
+  MUTED = 'MUTED',
+  UNMUTED = 'UNMUTED',
+}

package/src/classes/HMSVideoTrack.ts

@@ -3,8 +3,6 @@ import type { HMSTrackType } from './HMSTrackType';
 
 export class HMSVideoTrack extends HMSTrack {
   isDegraded?: boolean;
-  addSink?: Function;
-  removeSink?: Function;
 
   constructor(params: {
     trackId: string;