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

package/lib/typescript/classes/HMSSDK.d.ts

@@ -17,6 +17,7 @@ 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';
 interface HmsViewProps {
     trackId: string;
     style?: ViewStyle;
@@ -25,10 +26,6 @@ interface HmsViewProps {
     setZOrderMediaOverlay?: boolean;
 }
 export declare class HMSSDK {
-    room?: HMSRoom;
-    localPeer?: HMSLocalPeer;
-    remotePeers?: HMSRemotePeer[];
-    knownRoles?: HMSRole[];
     id: string;
     private muteStatus;
     private appStateSubscription?;
@@ -53,9 +50,18 @@ export declare class HMSSDK {
     private onAudioDeviceChangedDelegate?;
     private constructor();
     /**
-     * - 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
@@ -64,6 +70,7 @@ export declare class HMSSDK {
         trackSettings?: HMSTrackSettings;
         appGroup?: String;
         preferredExtension?: String;
+        logSettings?: HMSLogSettings;
     }): Promise<HMSSDK>;
     /**
      * - Returns the instance of logger which can be used to manipulate log levels.
@@ -83,13 +90,6 @@ export declare class HMSSDK {
      * @memberof HMSSDK
      */
     destroy: () => Promise<any>;
-    /**
-     * - Attaches preview listener for native callbacks.
-     * Note:this function connects sdk to native side and not app to sdk.
-     *
-     * @memberof HMSSDK
-     */
-    attachPreviewListener: () => void;
     /**
      * - Attaches all the listeners to native callbacks.
      * Note: this function connects sdk to native side and not app to sdk.
@@ -303,7 +303,7 @@ export declare class HMSSDK {
     acceptRoleChange: () => Promise<any>;
     /**
      * - 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
      *
@@ -323,9 +323,33 @@ export declare 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: () => Promise<HMSRoom>;
+    /**
+     * - 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: () => Promise<HMSLocalPeer>;
+    /**
+     * - 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: () => Promise<HMSRemotePeer[]>;
+    /**
+     * - 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: () => Promise<HMSRole[]>;
     /**
      * - This function sets the volume of any peer in the room
      *
@@ -389,6 +413,8 @@ export declare class HMSSDK {
      * @memberof HMSSDK
      */
     disableRTCStats: () => void;
+    enableNetworkQualityUpdates: () => void;
+    disableNetworkQualityUpdates: () => void;
     /**
      * - This wrapper function is used to start streaming device audio, currently available only for android.
      *

package/lib/typescript/classes/HMSServerRecordingState.d.ts

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

package/lib/typescript/classes/HMSSubscribeSettings.d.ts

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

package/lib/typescript/classes/HMSTrackSettings.d.ts

@@ -3,10 +3,8 @@ import type { HMSVideoTrackSettings } from './HMSVideoTrackSettings';
 export declare class HMSTrackSettings {
     video?: HMSVideoTrackSettings;
     audio?: HMSAudioTrackSettings;
-    useHardwareEchoCancellation?: boolean;
     constructor(params?: {
         video?: HMSVideoTrackSettings;
         audio?: HMSAudioTrackSettings;
-        useHardwareEchoCancellation?: boolean;
     });
 }

package/lib/typescript/classes/HMSTrackSettingsInitState.d.ts

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

package/lib/typescript/classes/HMSVideoTrack.d.ts

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

package/lib/typescript/classes/HMSVideoTrackSettings.d.ts

@@ -1,22 +1,17 @@
-import type { HMSVideoCodec } from './HMSVideoCodec';
 import type { HMSSimulcastLayerSettings } from './HMSSimulcastLayerSettings';
 import type { HMSCameraFacing } from './HMSCameraFacing';
-import type { HMSVideoResolution } from './HMSVideoResolution';
+import type { HMSTrackSettingsInitState } from './HMSTrackSettingsInitState';
 export declare class HMSVideoTrackSettings {
-    codec: HMSVideoCodec;
-    resolution: HMSVideoResolution;
-    maxBitrate: number;
-    maxFrameRate: number;
-    cameraFacing: HMSCameraFacing;
-    trackDescription?: string;
-    simulcastSettings?: HMSSimulcastLayerSettings[];
+    readonly simulcastSettings?: HMSSimulcastLayerSettings[];
+    initialState?: HMSTrackSettingsInitState;
+    cameraFacing?: HMSCameraFacing;
+    forceSoftwareDecoder?: boolean;
+    disableAutoResize?: boolean;
     constructor(params: {
-        codec: HMSVideoCodec;
-        resolution: HMSVideoResolution;
-        maxBitrate: number;
-        maxFrameRate: number;
-        cameraFacing: HMSCameraFacing;
-        trackDescription?: string;
         simulcastSettings?: HMSSimulcastLayerSettings[];
+        initialState?: HMSTrackSettingsInitState;
+        cameraFacing?: HMSCameraFacing;
+        forceSoftwareDecoder?: boolean;
+        disableAutoResize?: boolean;
     });
 }

package/lib/typescript/index.d.ts

@@ -70,5 +70,8 @@ export * from './classes/HMSMicNode';
 export * from './classes/HMSScreenBroadcastAudioReceiverNode';
 export * from './classes/HMSAudioFilePlayerNode';
 export * from './classes/HMSAudioMixerSource';
+export * from './classes/HMSTrackSettingsInitState';
+export * from './classes/HMSLogSettings';
+export * from './classes/HMSLogAlarmManager';
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 export default HmsManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@100mslive/react-native-hms",
-  "version": "0.9.93",
+  "version": "0.9.94",
   "description": "The React Native package for 100ms SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/react-native-hms.podspec

@@ -16,6 +16,6 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "HMSSDK", "0.4.2"
-  s.dependency 'HMSBroadcastExtensionSDK', '0.0.3'
+  s.dependency "HMSSDK", "0.4.6"
+  s.dependency 'HMSBroadcastExtensionSDK', '0.0.4'
 end

package/src/classes/HMSAudioTrackSettings.ts

@@ -1,19 +1,17 @@
-import type { HMSAudioCodec } from './HMSAudioCodec';
+import type { HMSTrackSettingsInitState } from './HMSTrackSettingsInitState';
 
 export class HMSAudioTrackSettings {
-  maxBitrate: number;
-  trackDescription?: string; // ios only
+  initialState?: HMSTrackSettingsInitState;
+  useHardwareEchoCancellation?: boolean; // android only
   audioSource?: string[]; // ios only
-  codec?: HMSAudioCodec; // android only
+
   constructor(params: {
-    maxBitrate: number;
-    trackDescription?: string;
+    initialState?: HMSTrackSettingsInitState;
+    useHardwareEchoCancellation?: boolean;
     audioSource?: string[];
-    codec?: HMSAudioCodec;
   }) {
-    this.maxBitrate = params.maxBitrate;
-    this.trackDescription = params.trackDescription;
+    this.useHardwareEchoCancellation = params.useHardwareEchoCancellation;
+    this.initialState = params.initialState;
     this.audioSource = params.audioSource;
-    this.codec = params.codec;
   }
 }

package/src/classes/HMSBrowserRecordingState.ts

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

package/src/classes/HMSEncoder.ts

@@ -181,9 +181,8 @@ export class HMSEncoder {
 
   static encodeHmsAudioTrackSettings(settings: any) {
     const encodedObj = {
-      maxBitrate: settings?.maxBitrate,
-      trackDescription: settings?.trackDescription,
-      codec: settings?.codec,
+      useHardwareEchoCancellation: settings?.useHardwareAcousticEchoCanceler,
+      initialState: settings?.initialState,
     };
 
     return new HMSAudioTrackSettings(encodedObj);
@@ -191,12 +190,11 @@ export class HMSEncoder {
 
   static encodeHmsVideoTrackSettings(settings: any) {
     const encodedObj = {
-      codec: settings?.codec,
-      resolution: HMSEncoder.encodeHmsVideoResolution(settings?.resolution),
-      maxBitrate: settings?.maxBitrate,
-      maxFrameRate: settings?.maxFrameRate,
+      initialState: settings?.initialState,
+      forceSoftwareDecoder: settings?.forceSoftwareDecoder,
+      simulcastSettings: settings?.simulcastSettings,
       cameraFacing: settings?.cameraFacing,
-      trackDescription: settings?.trackDescription,
+      disableAutoResize: settings?.disableAutoResize,
     };
 
     return new HMSVideoTrackSettings(encodedObj);
@@ -240,7 +238,7 @@ export class HMSEncoder {
   }
 
   static encodeHmsRemotePeers(peers: any, id: string) {
-    const hmsPeers: any[] = [];
+    const hmsPeers: HMSRemotePeer[] = [];
 
     peers.map((peer: any) => {
       const encodedPeer = HMSEncoder.encodeHmsRemotePeer(peer, id);
@@ -316,17 +314,10 @@ export class HMSEncoder {
     return new HMSRemoteVideoTrack(encodedObj);
   }
 
-  static encodeHmsPreviewTracks(previewTracks: any) {
-    const encodedObj = {
-      audioTrack: previewTracks.audioTrack
-        ? new HMSLocalAudioTrack(previewTracks.audioTrack)
-        : null,
-      videoTrack: previewTracks.videoTrack
-        ? new HMSLocalVideoTrack(previewTracks.videoTrack)
-        : null,
-    };
-
-    return encodedObj;
+  static encodeHmsPreviewTracks(previewTracks: any[], id: string) {
+    return previewTracks?.map((track) => {
+      return this.encodeHmsTrack(track, id);
+    });
   }
 
   static encodeHmsRoles(roles: any[]) {

package/src/classes/HMSLogAlarmManager.ts

@@ -0,0 +1,5 @@
+export enum HMSLogAlarmManager {
+  DEFAULT_DIR_SIZE = 'DEFAULT_DIR_SIZE',
+  DEFAULT_LOGS_FILE_NAME = 'DEFAULT_LOGS_FILE_NAME',
+  MAX_DIR_SIZE = 'MAX_DIR_SIZE',
+}

package/src/classes/HMSLogSettings.ts

@@ -0,0 +1,18 @@
+import type { HMSLogAlarmManager } from './HMSLogAlarmManager';
+import type { HMSLogLevel } from './HMSLogLevel';
+
+export class HMSLogSettings {
+  level: HMSLogLevel;
+  isLogStorageEnabled: boolean;
+  maxDirSizeInBytes: HMSLogAlarmManager;
+
+  constructor(params: {
+    level: HMSLogLevel;
+    isLogStorageEnabled: boolean;
+    maxDirSizeInBytes: HMSLogAlarmManager;
+  }) {
+    this.level = params.level;
+    this.isLogStorageEnabled = params.isLogStorageEnabled;
+    this.maxDirSizeInBytes = params.maxDirSizeInBytes;
+  }
+}

package/src/classes/HMSRtmpStreamingState.ts

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