@100mslive/react-native-hms 1.3.0 → 1.5.0

package/src/classes/HMSSDK.tsx

@@ -1,15 +1,11 @@
 import React from 'react';
-import { AppState, NativeModules, Platform, ViewStyle } from 'react-native';
+import { AppState, NativeModules, Platform } from 'react-native';
 import { HMSEncoder } from './HMSEncoder';
 import { HMSHelper } from './HMSHelper';
-import { HMSLocalAudioStats } from './HMSLocalAudioStats';
-import { HMSLocalVideoStats } from './HMSLocalVideoStats';
 import { getLogger, logger, setLogger } from './HMSLogger';
-import { HMSRemoteAudioStats } from './HMSRemoteAudioStats';
-import { HMSRemoteVideoStats } from './HMSRemoteVideoStats';
 import { HMSTrackType } from './HMSTrackType';
 import { HMSUpdateListenerActions } from './HMSUpdateListenerActions';
-import { HmsViewComponent } from './HmsView';
+import { HmsViewComponent, HmsComponentProps } from './HmsView';
 
 import type { HMSConfig } from './HMSConfig';
 import type { HMSLocalPeer } from './HMSLocalPeer';
@@ -47,14 +43,9 @@ import {
 } from './HMSRoomCache';
 import { HMSPeerUpdateOrdinals } from './HMSPeerUpdate';
 
-interface HmsViewProps {
-  trackId: string;
-  style?: ViewStyle;
-  mirror?: boolean;
-  scaleType?: HMSVideoViewMode;
-  setZOrderMediaOverlay?: boolean;
-}
+type HmsViewProps = Omit<HmsComponentProps, 'id'>;
 
+// TODO: Rename to HMSPIPConfig & to be moved to a separate file
 interface PIPConfig {
   aspectRatio?: [number, number];
   endButton?: boolean;
@@ -79,7 +70,6 @@ export class HMSSDK {
   id: string;
   private muteStatus: boolean | undefined;
   private appStateSubscription?: any;
-
   private onPreviewDelegate?: any;
   private onJoinDelegate?: any;
   private onRoomDelegate?: any;
@@ -151,24 +141,6 @@ export class HMSSDK {
     return HmsSdk;
   }
 
-  /**
-   * - Returns the instance of logger which can be used to manipulate log levels.
-   * @returns @instance HMSLogger
-   * @memberof HMSSDK
-   */
-  static getLogger() {
-    return getLogger();
-  }
-
-  /**
-   * - Updates the logger for this instance of HMSSDK
-   * @param {HMSLogger} hmsLogger
-   * @memberof HMSSDK
-   */
-  setLogger = (hmsLogger?: HMSLogger) => {
-    setLogger(this.id, hmsLogger);
-  };
-
   /**
    * - Calls removeListeners that in turn breaks all connections with native listeners.
    *
@@ -182,6 +154,33 @@ export class HMSSDK {
     return await HMSManager.destroy({ id: this.id });
   };
 
+  /**
+   * - getAuthTokenByRoomCode function is used to get the Auth Token by Room Code
+   *
+   * checkout {@link https://www.100ms.live/docs/concepts/v2/concepts/rooms/room-codes/room-codes} for more info
+   *
+   * @memberof HMSSDK
+   */
+  getAuthTokenByRoomCode = async (
+    roomCode: string,
+    userId?: string,
+    endpoint?: string
+  ): Promise<string> => {
+    logger?.verbose('#Function getAuthTokenByRoomCode', {
+      id: this.id,
+      roomCode,
+      userId,
+      endpoint,
+    });
+
+    return HMSManager.getAuthTokenByRoomCode({
+      id: this.id,
+      roomCode,
+      userId,
+      endpoint,
+    });
+  };
+
   /**
    * takes an instance of [HMSConfig]{@link HMSConfig} and joins the room.
    * after joining the room user will start receiving the events and updates of the room.
@@ -242,6 +241,7 @@ export class HMSSDK {
    * - The appearance of tile is completely customizable with style prop.
    * - Scale type can determine how the incoming video will fit in the canvas check {@link HMSVideoViewMode} for more information.
    * - Mirror to flip the video vertically.
+   * - Auto Simulcast to automatically select the best Streaming Quality of track if feature is enabled in Room.
    *
    * checkout {@link https://www.100ms.live/docs/react-native/v2/features/render-video} for more info
    *
@@ -249,12 +249,20 @@ export class HMSSDK {
    * @memberof HMSSDK
    */
   HmsView = React.forwardRef<any, HmsViewProps>((props, ref) => {
-    const { trackId, style, mirror, scaleType, setZOrderMediaOverlay } = props;
+    const {
+      trackId,
+      style,
+      mirror,
+      scaleType,
+      setZOrderMediaOverlay,
+      autoSimulcast,
+    } = props;
     return (
       <HmsViewComponent
         ref={ref}
         trackId={trackId}
         style={style}
+        autoSimulcast={autoSimulcast}
         setZOrderMediaOverlay={setZOrderMediaOverlay}
         mirror={mirror}
         scaleType={scaleType}
@@ -837,36 +845,6 @@ export class HMSSDK {
     return await HMSManager.stopScreenshare({ id: this.id });
   };
 
-  /**
-   * - enableRTCStats sets a boolean in native side which in turn allows several events to be passed
-   * through the bridge these events are {@link RTCStatsListener}, {@link onRemoteVideoStatsListener},
-   * {@link onRemoteAudioStatsListener}, {@link onLocalAudioStatsListener} and {@link onLocalVideoStatsListener}
-   *
-   * - These listeners get various dataPoints for current peers and their connectivity to the room
-   * such as jitter, latency etc.
-   *
-   * - currently available for iOS only
-   *
-   * @memberof HMSSDK
-   */
-  enableRTCStats = () => {
-    logger?.verbose('#Function enableRTCStats', { id: this.id });
-    HMSManager.enableRTCStats({ id: this.id });
-  };
-
-  /**
-   * - disable RTCStats sets the same boolean to false that was set true by enableRTCStats.
-   * that activates a check which filters out the events acquired in native listeners and don't
-   * let them pass through bridge
-   *
-   * - currently available for iOS only.
-   * @memberof HMSSDK
-   */
-  disableRTCStats = () => {
-    logger?.verbose('#Function disableRTCStats', { id: this.id });
-    HMSManager.disableRTCStats({ id: this.id });
-  };
-
   enableNetworkQualityUpdates = () => {
     logger?.verbose('#Function enableNetworkQualityUpdates', { id: this.id });
     HMSManager.enableNetworkQualityUpdates({ id: this.id });
@@ -1098,6 +1076,34 @@ export class HMSSDK {
     return await HMSManager.getSessionMetaData({ id: this.id });
   };
 
+  getRemoteVideoTrackFromTrackId = async (trackId: string) => {
+    logger?.verbose('#Function getRemoteVideoTrackFromTrackId', {
+      id: this.id,
+      trackId,
+    });
+
+    const remoteVideoTrackData =
+      await HMSManager.getRemoteVideoTrackFromTrackId({
+        id: this.id,
+        trackId,
+      });
+    return HMSEncoder.encodeHmsRemoteVideoTrack(remoteVideoTrackData, this.id);
+  };
+
+  getRemoteAudioTrackFromTrackId = async (trackId: string) => {
+    logger?.verbose('#Function getRemoteAudioTrackFromTrackId', {
+      id: this.id,
+      trackId,
+    });
+
+    const remoteAudioTrackData =
+      await HMSManager.getRemoteAudioTrackFromTrackId({
+        id: this.id,
+        trackId,
+      });
+    return HMSEncoder.encodeHmsRemoteAudioTrack(remoteAudioTrackData, this.id);
+  };
+
   /**
    * - This is a prototype event listener that takes action and listens for updates related to that particular action
    *
@@ -2097,7 +2103,9 @@ export class HMSSDK {
       return;
     }
 
-    let localAudioStats = new HMSLocalAudioStats(data.localAudioStats);
+    let localAudioStats = HMSEncoder.encodeHMSLocalAudioStats(
+      data.localAudioStats
+    );
     let peer = HMSEncoder.encodeHmsPeer(data.peer);
     let track = HMSEncoder.encodeHmsLocalAudioTrack(data.track, this.id);
 
@@ -2117,7 +2125,9 @@ export class HMSSDK {
       return;
     }
 
-    let localVideoStats = new HMSLocalVideoStats(data.localVideoStats);
+    let localVideoStats = HMSEncoder.encodeHMSLocalVideoStats(
+      data.localVideoStats
+    );
     let peer = HMSEncoder.encodeHmsPeer(data.peer);
     let track = HMSEncoder.encodeHmsLocalVideoTrack(data.track, this.id);
 
@@ -2137,7 +2147,9 @@ export class HMSSDK {
       return;
     }
 
-    let remoteAudioStats = new HMSRemoteAudioStats(data.remoteAudioStats);
+    let remoteAudioStats = HMSEncoder.encodeHMSRemoteAudioStats(
+      data.remoteAudioStats
+    );
     let peer = HMSEncoder.encodeHmsPeer(data.peer);
     let track = HMSEncoder.encodeHmsRemoteAudioTrack(data.track, this.id);
 
@@ -2162,7 +2174,9 @@ export class HMSSDK {
       return;
     }
 
-    let remoteVideoStats = new HMSRemoteVideoStats(data.remoteVideoStats);
+    let remoteVideoStats = HMSEncoder.encodeHMSRemoteVideoStats(
+      data.remoteVideoStats
+    );
     let peer = HMSEncoder.encodeHmsPeer(data.peer);
     let track = HMSEncoder.encodeHmsRemoteVideoTrack(data.track, this.id);
 
@@ -2230,4 +2244,22 @@ export class HMSSDK {
       id: this.id,
     });
   }
+
+  /**
+   * - Returns the instance of logger which can be used to manipulate log levels.
+   * @returns @instance HMSLogger
+   * @memberof HMSSDK
+   */
+  static getLogger() {
+    return getLogger();
+  }
+
+  /**
+   * - Updates the logger for this instance of HMSSDK
+   * @param {HMSLogger} hmsLogger
+   * @memberof HMSSDK
+   */
+  setLogger = (hmsLogger?: HMSLogger) => {
+    setLogger(this.id, hmsLogger);
+  };
 }

package/src/classes/HMSSimulcastLayerDefinition.ts

@@ -0,0 +1,12 @@
+import type { HMSLayer } from './HMSLayer';
+import type { HMSVideoResolution } from './HMSVideoResolution';
+
+export class HMSSimulcastLayerDefinition {
+  layer: HMSLayer;
+  resolution: HMSVideoResolution;
+
+  constructor(params: { layer: HMSLayer; resolution: HMSVideoResolution }) {
+    this.layer = params.layer;
+    this.resolution = params.resolution;
+  }
+}

package/src/classes/HMSSimulcastLayerSettingsPolicy.ts

@@ -0,0 +1,18 @@
+export class HMSSimulcastLayerSettingsPolicy {
+  rid?: string;
+  scaleResolutionDownBy?: number;
+  maxBitrate?: number;
+  maxFramerate?: number;
+
+  constructor(params: {
+    rid?: string;
+    scaleResolutionDownBy?: number;
+    maxBitrate?: number;
+    maxFramerate?: number;
+  }) {
+    this.rid = params.rid;
+    this.scaleResolutionDownBy = params.scaleResolutionDownBy;
+    this.maxBitrate = params.maxBitrate;
+    this.maxFramerate = params.maxFramerate;
+  }
+}

package/src/classes/HMSSimulcastSettings.ts

@@ -1,5 +1,14 @@
+import type { HMSSimulcastSettingsPolicy } from './HMSSimulcastSettingsPolicy';
+
 export class HMSSimulcastSettings {
-  low: any;
-  med: any;
-  high: any;
+  video?: HMSSimulcastSettingsPolicy;
+  screen?: HMSSimulcastSettingsPolicy;
+
+  constructor(params: {
+    video?: HMSSimulcastSettingsPolicy;
+    screen?: HMSSimulcastSettingsPolicy;
+  }) {
+    this.video = params.video;
+    this.screen = params.screen;
+  }
 }

package/src/classes/HMSSimulcastSettingsPolicy.ts

@@ -0,0 +1,9 @@
+import type { HMSSimulcastLayerSettingsPolicy } from './HMSSimulcastLayerSettingsPolicy';
+
+export class HMSSimulcastSettingsPolicy {
+  layers?: HMSSimulcastLayerSettingsPolicy[];
+
+  constructor(params: { layers?: HMSSimulcastLayerSettingsPolicy[] }) {
+    this.layers = params.layers;
+  }
+}

package/src/classes/HMSSubscribeDegradationPolicy.ts

@@ -0,0 +1,15 @@
+export class HMSSubscribeDegradationPolicy {
+  packetLossThreshold?: number;
+  degradeGracePeriodSeconds?: number;
+  recoverGracePeriodSeconds?: number;
+
+  constructor(params: {
+    packetLossThreshold?: number;
+    degradeGracePeriodSeconds?: number;
+    recoverGracePeriodSeconds?: number;
+  }) {
+    this.packetLossThreshold = params.packetLossThreshold;
+    this.degradeGracePeriodSeconds = params.degradeGracePeriodSeconds;
+    this.recoverGracePeriodSeconds = params.recoverGracePeriodSeconds;
+  }
+}

package/src/classes/HMSSubscribeSettings.ts

@@ -1,9 +1,17 @@
+import type { HMSSubscribeDegradationPolicy } from './HMSSubscribeDegradationPolicy';
+
 export class HMSSubscribeSettings {
-  subscribeTo?: [string];
+  subscribeTo?: string[];
   maxSubsBitRate: number;
+  subscribeDegradation?: HMSSubscribeDegradationPolicy;
 
-  constructor(params: { subscribeTo?: [string]; maxSubsBitRate: number }) {
+  constructor(params: {
+    subscribeTo?: string[];
+    maxSubsBitRate: number;
+    subscribeDegradation?: HMSSubscribeDegradationPolicy;
+  }) {
     this.subscribeTo = params.subscribeTo;
     this.maxSubsBitRate = params.maxSubsBitRate;
+    this.subscribeDegradation = params.subscribeDegradation;
   }
 }

package/src/classes/HMSVideoResolution.ts

@@ -2,7 +2,7 @@ export class HMSVideoResolution {
   height?: number;
   width?: number;
 
-  constructor(params: { height: number; width: number }) {
+  constructor(params: { height?: number; width?: number }) {
     this.height = params.height;
     this.width = params.width;
   }

package/src/classes/HmsView.tsx

@@ -15,6 +15,7 @@ interface HmsViewProps {
     id: string;
     mirror: boolean;
   };
+  autoSimulcast: boolean;
   setZOrderMediaOverlay: boolean;
   scaleType: HMSVideoViewMode;
   style: ViewStyle;
@@ -26,10 +27,11 @@ const HmsView = requireNativeComponent<HmsViewProps>('HMSView');
 let _nextRequestId = 1;
 let _requestMap = new Map();
 
-interface HmsComponentProps {
+export interface HmsComponentProps {
   trackId: string;
   style?: ViewStyle;
   mirror?: boolean;
+  autoSimulcast?: boolean;
   scaleType?: HMSVideoViewMode;
   setZOrderMediaOverlay?: boolean;
   id: string;
@@ -43,6 +45,7 @@ export const HmsViewComponent = React.forwardRef<any, HmsComponentProps>(
       id = HMSConstants.DEFAULT_SDK_ID,
       mirror = false,
       setZOrderMediaOverlay = false,
+      autoSimulcast = true,
       scaleType = HMSVideoViewMode.ASPECT_FILL,
     } = props;
 
@@ -127,6 +130,7 @@ export const HmsViewComponent = React.forwardRef<any, HmsComponentProps>(
         onChange={onChange}
         data={data}
         style={tempVal === 0 ? style : temporaryStyles.customStyle}
+        autoSimulcast={autoSimulcast}
         scaleType={scaleType}
         setZOrderMediaOverlay={setZOrderMediaOverlay}
         onDataReturned={_onDataReturned}

package/src/index.ts

@@ -75,6 +75,11 @@ export * from './classes/HMSLogSettings';
 export * from './classes/HMSLogAlarmManager';
 export * from './classes/HMSMessageType';
 export * from './classes/HMSPIPListenerActions';
+export * from './classes/HMSLayer';
+export * from './classes/HMSSimulcastLayerDefinition';
+export * from './classes/HMSQualityLimitationReasons';
+export * from './classes/HMSQualityLimitationReason';
+export * from './classes/HMSCameraControl';
 export type { HmsViewComponent as HMSView } from './classes/HmsView';
 
 import { HMSSDK as HmsManager } from './classes/HMSSDK';