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

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';
@@ -31,27 +31,27 @@ export declare class HMSSDK {
     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);
+    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.
@@ -60,7 +60,7 @@ export declare class HMSSDK {
      * @returns
      * @memberof HMSSDK
      */
-    static build({ trackSettings, appGroup, preferredExtension, }: {
+    static build(params?: {
         trackSettings?: HMSTrackSettings;
         appGroup?: String;
         preferredExtension?: String;
@@ -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
@@ -320,7 +320,7 @@ 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
@@ -329,7 +329,7 @@ export declare class HMSSDK {
     /**
      * - 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
      */

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/index.d.ts

@@ -65,5 +65,10 @@ 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';
 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.93",
   "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.2"
+  s.dependency 'HMSBroadcastExtensionSDK', '0.0.3'
 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,19 @@
 import type { HMSAudioCodec } from './HMSAudioCodec';
 
 export class HMSAudioTrackSettings {
-  maxBitrate?: number;
-  trackDescription?: string;
-  codec?: HMSAudioCodec;
+  maxBitrate: number;
+  trackDescription?: string; // ios only
+  audioSource?: string[]; // ios only
+  codec?: HMSAudioCodec; // android only
   constructor(params: {
     maxBitrate: number;
     trackDescription?: string;
-    codec: HMSAudioCodec;
+    audioSource?: string[];
+    codec?: HMSAudioCodec;
   }) {
     this.maxBitrate = params.maxBitrate;
     this.trackDescription = params.trackDescription;
+    this.audioSource = params.audioSource;
     this.codec = params.codec;
   }
 }

package/src/classes/HMSEncoder.ts

@@ -507,6 +507,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/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/HMSSDK.tsx

@@ -1,27 +1,23 @@
 import React from 'react';
-import {
-  NativeEventEmitter,
-  NativeModules,
-  Platform,
-  ViewStyle,
-  AppState,
-} from 'react-native';
-import { HMSUpdateListenerActions } from './HMSUpdateListenerActions';
+import { AppState, NativeEventEmitter, NativeModules, Platform, ViewStyle } from 'react-native';
+
 import { HMSEncoder } from './HMSEncoder';
 import { HMSHelper } from './HMSHelper';
-import { HmsViewComponent } from './HmsView';
 import { HMSLocalAudioStats } from './HMSLocalAudioStats';
 import { HMSLocalVideoStats } from './HMSLocalVideoStats';
-import { HMSRemoteVideoStats } from './HMSRemoteVideoStats';
+import { getLogger, logger, setLogger } from './HMSLogger';
 import { HMSRemoteAudioStats } from './HMSRemoteAudioStats';
-import { logger, getLogger, setLogger } from './HMSLogger';
+import { HMSRemoteVideoStats } from './HMSRemoteVideoStats';
+import { HMSTrackType } from './HMSTrackType';
+import { HMSUpdateListenerActions } from './HMSUpdateListenerActions';
+import { HmsViewComponent } from './HmsView';
+
 import type { HMSConfig } from './HMSConfig';
 import type { HMSLocalPeer } from './HMSLocalPeer';
 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';
@@ -58,29 +54,29 @@ export class HMSSDK {
   knownRoles?: HMSRole[];
   id: string;
   private muteStatus: boolean | undefined;
-  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) {
+  private appStateSubscription?: any;
+
+  private onPreviewDelegate?: any;
+  private onJoinDelegate?: any;
+  private onRoomDelegate?: any;
+  private onPeerDelegate?: any;
+  private onTrackDelegate?: any;
+  private onErrorDelegate?: any;
+  private onMessageDelegate?: any;
+  private onSpeakerDelegate?: any;
+  private onReconnectingDelegate?: any;
+  private onReconnectedDelegate?: any;
+  private onRoleChangeRequestDelegate?: any;
+  private onChangeTrackStateRequestDelegate?: any;
+  private onRemovedFromRoomDelegate?: any;
+  private onRtcStatsDelegate?: any;
+  private onLocalAudioStatsDelegate?: any;
+  private onLocalVideoStatsDelegate?: any;
+  private onRemoteAudioStatsDelegate?: any;
+  private onRemoteVideoStatsDelegate?: any;
+  private onAudioDeviceChangedDelegate?: any;
+
+  private constructor(id: string) {
     this.id = id;
   }
 
@@ -92,19 +88,15 @@ export class HMSSDK {
    * @returns
    * @memberof HMSSDK
    */
-  static async build({
-    trackSettings,
-    appGroup,
-    preferredExtension,
-  }: {
+  static async build(params?: {
     trackSettings?: HMSTrackSettings;
     appGroup?: String;
     preferredExtension?: String;
   }) {
     let id = await HMSManager.build({
-      trackSettings: trackSettings,
-      appGroup: appGroup,
-      preferredExtension: preferredExtension,
+      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
     });
     HmsSdk = new HMSSDK(id);
     HmsSdk.attachPreviewListener();
@@ -532,7 +524,7 @@ export 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
@@ -790,7 +782,7 @@ export 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
@@ -809,7 +801,7 @@ export class HMSSDK {
   /**
    * - 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
    */

package/src/classes/HMSScreenBroadcastAudioReceiverNode.ts

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

package/src/index.ts

@@ -65,6 +65,11 @@ 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';
 
 import { HMSSDK as HmsManager } from './classes/HMSSDK';
 export default HmsManager;