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

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

@@ -0,0 +1,5 @@
+import { HMSAudioNode } from './HMSAudioNode';
+export declare class HMSMicNode extends HMSAudioNode {
+    constructor();
+    setVolume(volume: number): any;
+}

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

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

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

@@ -1,5 +1,6 @@
 import React from 'react';
 import { ViewStyle } from 'react-native';
+import { HMSTrackType } from './HMSTrackType';
 import { HMSUpdateListenerActions } from './HMSUpdateListenerActions';
 import type { HMSConfig } from './HMSConfig';
 import type { HMSLocalPeer } from './HMSLocalPeer';
@@ -7,7 +8,6 @@ import type { HMSRemotePeer } from './HMSRemotePeer';
 import type { HMSRoom } from './HMSRoom';
 import type { HMSRole } from './HMSRole';
 import type { HMSTrack } from './HMSTrack';
-import { HMSTrackType } from './HMSTrackType';
 import type { HMSLogger } from './HMSLogger';
 import type { HMSPeer } from './HMSPeer';
 import type { HMSVideoViewMode } from './HMSVideoViewMode';
@@ -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,45 +26,51 @@ interface HmsViewProps {
     setZOrderMediaOverlay?: boolean;
 }
 export declare class HMSSDK {
-    room?: HMSRoom;
-    localPeer?: HMSLocalPeer;
-    remotePeers?: HMSRemotePeer[];
-    knownRoles?: HMSRole[];
     id: string;
     private muteStatus;
-    appStateSubscription?: any;
-    onPreviewDelegate?: any;
-    onJoinDelegate?: any;
-    onRoomDelegate?: any;
-    onPeerDelegate?: any;
-    onTrackDelegate?: any;
-    onErrorDelegate?: any;
-    onMessageDelegate?: any;
-    onSpeakerDelegate?: any;
-    onReconnectingDelegate?: any;
-    onReconnectedDelegate?: any;
-    onRoleChangeRequestDelegate?: any;
-    onChangeTrackStateRequestDelegate?: any;
-    onRemovedFromRoomDelegate?: any;
-    onRtcStatsDelegate?: any;
-    onLocalAudioStatsDelegate?: any;
-    onLocalVideoStatsDelegate?: any;
-    onRemoteAudioStatsDelegate?: any;
-    onRemoteVideoStatsDelegate?: any;
-    onAudioDeviceChangedDelegate?: any;
-    constructor(id: string);
-    /**
-     * - Returns an instance of [HMSSDK]{@link HMSSDK}
+    private appStateSubscription?;
+    private onPreviewDelegate?;
+    private onJoinDelegate?;
+    private onRoomDelegate?;
+    private onPeerDelegate?;
+    private onTrackDelegate?;
+    private onErrorDelegate?;
+    private onMessageDelegate?;
+    private onSpeakerDelegate?;
+    private onReconnectingDelegate?;
+    private onReconnectedDelegate?;
+    private onRoleChangeRequestDelegate?;
+    private onChangeTrackStateRequestDelegate?;
+    private onRemovedFromRoomDelegate?;
+    private onRtcStatsDelegate?;
+    private onLocalAudioStatsDelegate?;
+    private onLocalVideoStatsDelegate?;
+    private onRemoteAudioStatsDelegate?;
+    private onRemoteVideoStatsDelegate?;
+    private onAudioDeviceChangedDelegate?;
+    private constructor();
+    /**
+     * - 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
      */
-    static build({ trackSettings, appGroup, preferredExtension, }: {
+    static build(params?: {
         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.
@@ -188,7 +188,7 @@ export declare class HMSSDK {
      *
      * - it is advised to use a json object in string format to store multiple dataPoints in metadata.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-metadata} for more info
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/advanced-features/change-metadata} for more info
      *
      * @param {string}
      * @memberof HMSSDK
@@ -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
      *
@@ -320,16 +320,40 @@ export declare class HMSSDK {
      * - getRoom is a wrapper function on an existing native function also known as getRoom the returns
      * current room object which is of type {@link HMSRoom}
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/room} for more info
+     * 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
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/set-volume} for more info
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/advanced-features/set-volume} for more info
      *
      * @memberof HMSSDK
      */
@@ -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/HMSScreenBroadcastAudioReceiverNode.d.ts

@@ -0,0 +1,4 @@
+import { HMSAudioNode } from './HMSAudioNode';
+export declare class HMSScreenBroadcastAudioReceiverNode extends HMSAudioNode {
+    constructor();
+}

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

@@ -65,5 +65,13 @@ export * from './classes/HMSRtmpVideoResolution';
 export * from './classes/HMSAudioDevice';
 export * from './classes/HMSAudioMode';
 export * from './classes/HMSAudioMixingMode';
+export * from './classes/HMSAudioNode';
+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.92",
+  "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.3.3"
-  s.dependency 'HMSBroadcastExtensionSDK', '0.0.2'
+  s.dependency "HMSSDK", "0.4.6"
+  s.dependency 'HMSBroadcastExtensionSDK', '0.0.4'
 end

package/src/classes/HMSAudioFilePlayerNode.ts

@@ -0,0 +1,75 @@
+import { NativeModules } from 'react-native';
+import { HMSAudioNode } from './HMSAudioNode';
+
+const {
+  /**
+   * @ignore
+   */
+  HMSManager,
+} = NativeModules;
+
+export class HMSAudioFilePlayerNode extends HMSAudioNode {
+  constructor(name: string) {
+    super(name);
+  }
+
+  setVolume(volume: number) {
+    HMSManager.setAudioShareVolume({
+      id: this.sdkId,
+      audioNode: this.name,
+      volume,
+    });
+  }
+
+  async play(fileUrl: string, loops?: boolean, interrupts?: boolean) {
+    return await HMSManager.playAudioShare({
+      id: this.sdkId,
+      audioNode: this.name,
+      fileUrl,
+      loops,
+      interrupts,
+    });
+  }
+
+  pause() {
+    HMSManager.pauseAudioShare({
+      id: this.sdkId,
+      audioNode: this.name,
+    });
+  }
+
+  resume() {
+    HMSManager.resumeAudioShare({
+      id: this.sdkId,
+      audioNode: this.name,
+    });
+  }
+
+  stop() {
+    HMSManager.stopAudioShare({
+      id: this.sdkId,
+      audioNode: this.name,
+    });
+  }
+
+  async isPlaying() {
+    return await HMSManager.audioShareIsPlaying({
+      id: this.sdkId,
+      audioNode: this.name,
+    });
+  }
+
+  async currentDuration() {
+    return await HMSManager.audioShareCurrentTime({
+      id: this.sdkId,
+      audioNode: this.name,
+    });
+  }
+
+  async duration() {
+    return await HMSManager.audioShareDuration({
+      id: this.sdkId,
+      audioNode: this.name,
+    });
+  }
+}

package/src/classes/HMSAudioMixerSource.ts

@@ -0,0 +1,15 @@
+import type { HMSAudioNode } from './HMSAudioNode';
+
+export class HMSAudioMixerSource {
+  node: HMSAudioNode[];
+
+  constructor(params: { node: HMSAudioNode[] }) {
+    this.node = params.node;
+  }
+
+  toList(): string[] {
+    const nodeName: string[] = [];
+    this.node.forEach((audioNode) => nodeName.push(audioNode.toString()));
+    return nodeName;
+  }
+}

package/src/classes/HMSAudioNode.ts

@@ -0,0 +1,12 @@
+export class HMSAudioNode {
+  name: string;
+  sdkId: string = '12345';
+
+  constructor(name: string) {
+    this.name = name;
+  }
+
+  toString(): string {
+    return this.name;
+  }
+}

package/src/classes/HMSAudioTrackSettings.ts

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

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[]) {
@@ -507,6 +498,7 @@ export class HMSEncoder {
       name: data?.error?.name,
       action: data?.error?.action,
       isTerminal: data?.error?.isTerminal,
+      canRetry: data?.error?.canRetry,
     });
   }
 }

package/src/classes/HMSException.ts

@@ -1,18 +1,20 @@
 export class HMSException {
   code: number;
   description: string;
-  message: string;
-  name: string;
-  action: string;
+  message?: string; // `message` is available only on Android
+  name?: string; // `name` is available only on Android
+  action?: string; // `action` is available only on Android
   isTerminal: boolean;
+  canRetry?: boolean; // `canRetry` is available only on Android
 
   constructor(params: {
     code: number;
     description: string;
-    message: string;
-    name: string;
-    action: string;
+    message?: string;
+    name?: string;
+    action?: string;
     isTerminal: boolean;
+    canRetry?: boolean;
   }) {
     this.code = params.code;
     this.description = params.description;
@@ -20,5 +22,6 @@ export class HMSException {
     this.name = params.name;
     this.action = params.action;
     this.isTerminal = params.isTerminal;
+    this.canRetry = params.canRetry;
   }
 }

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/HMSMicNode.ts

@@ -0,0 +1,23 @@
+import { NativeModules } from 'react-native';
+import { HMSAudioNode } from './HMSAudioNode';
+
+const {
+  /**
+   * @ignore
+   */
+  HMSManager,
+} = NativeModules;
+
+export class HMSMicNode extends HMSAudioNode {
+  constructor() {
+    super('mic_node');
+  }
+
+  setVolume(volume: number) {
+    return HMSManager.setAudioShareVolume({
+      id: this.sdkId,
+      audioNode: this.name,
+      volume,
+    });
+  }
+}

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;