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

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

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

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

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

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

@@ -1,14 +1,15 @@
 import type { HMSMessageRecipient } from './HMSMessageRecipient';
+import type { HMSMessageType } from './HMSMessageType';
 import type { HMSPeer } from './HMSPeer';
 export declare class HMSMessage {
     message: string;
-    type: string;
+    type: HMSMessageType;
     time: Date;
     sender?: HMSPeer;
     recipient: HMSMessageRecipient;
     constructor(params: {
         message: string;
-        type: string;
+        type: HMSMessageType;
         time: Date;
         sender?: HMSPeer;
         recipient: HMSMessageRecipient;

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

@@ -0,0 +1,4 @@
+export declare enum HMSMessageType {
+    CHAT = "chat",
+    METADATA = "metadata"
+}

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

@@ -4,6 +4,7 @@ import type { HMSServerRecordingState } from './HMSServerRecordingState';
 import type { HMSBrowserRecordingState } from './HMSBrowserRecordingState';
 import type { HMSHLSStreamingState } from './HMSHLSStreamingState';
 import type { HMSHLSRecordingState } from './HMSHLSRecordingState';
+import type { HMSLocalPeer } from './HMSLocalPeer';
 export declare class HMSRoom {
     id: string;
     sessionId: string;
@@ -16,6 +17,7 @@ export declare class HMSRoom {
     hlsStreamingState: HMSHLSStreamingState;
     hlsRecordingState?: HMSHLSRecordingState;
     peerCount: number;
+    localPeer: HMSLocalPeer;
     constructor(params: {
         id: string;
         sessionId: string;
@@ -28,5 +30,6 @@ export declare class HMSRoom {
         hlsStreamingState: HMSHLSStreamingState;
         hlsRecordingState?: HMSHLSRecordingState;
         peerCount: number;
+        localPeer: HMSLocalPeer;
     });
 }

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

@@ -17,6 +17,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;
     style?: ViewStyle;
@@ -24,11 +26,10 @@ interface HmsViewProps {
     scaleType?: HMSVideoViewMode;
     setZOrderMediaOverlay?: boolean;
 }
+interface PIPConfig {
+    aspectRatio?: [number, number];
+}
 export declare class HMSSDK {
-    room?: HMSRoom;
-    localPeer?: HMSLocalPeer;
-    remotePeers?: HMSRemotePeer[];
-    knownRoles?: HMSRole[];
     id: string;
     private muteStatus;
     private appStateSubscription?;
@@ -53,9 +54,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 +74,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 +94,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.
@@ -162,7 +166,7 @@ export declare class HMSSDK {
      * @param {message: string} and @param {type: string}
      * @memberof HMSSDK
      */
-    sendBroadcastMessage: (message: string, type?: string) => Promise<any>;
+    sendBroadcastMessage: (message: string, type?: HMSMessageType) => Promise<any>;
     /**
      * - sendGroupMessage sends a message to specific set of roles, whoever has any of those role in room
      * will get the message in onMessage listener.
@@ -171,7 +175,7 @@ export declare class HMSSDK {
      *
      * @memberof HMSSDK
      */
-    sendGroupMessage: (message: string, roles: HMSRole[], type?: string) => Promise<any>;
+    sendGroupMessage: (message: string, roles: HMSRole[], type?: HMSMessageType) => Promise<any>;
     /**
      * - sendDirectMessage sends a private message to a single peer, only that peer will get the message
      * in onMessage Listener.
@@ -180,7 +184,7 @@ export declare class HMSSDK {
      *
      * @memberof HMSSDK
      */
-    sendDirectMessage: (message: string, peer: HMSPeer, type?: string) => Promise<any>;
+    sendDirectMessage: (message: string, peer: HMSPeer, type?: HMSMessageType) => Promise<any>;
     /**
      * - changeMetadata changes a specific field in localPeer which is [metadata] it is a string that can
      * be used for various functionalities like raiseHand, beRightBack and many more that explains the
@@ -303,7 +307,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 +327,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 +417,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.
      *
@@ -477,6 +507,8 @@ export declare class HMSSDK {
      * @memberof HMSSDK
      */
     setAudioDeviceChangeListener: (callback: Function) => any;
+    setSessionMetaData: (sessionMetaData: string | null) => Promise<any>;
+    getSessionMetaData: () => Promise<any>;
     /**
      * - This is a prototype event listener that takes action and listens for updates related to that particular action
      *
@@ -536,5 +568,8 @@ export declare class HMSSDK {
         device: string;
         audioDevicesList: string[];
     }) => void;
+    isPipModeSupported(): Promise<undefined | boolean>;
+    enablePipMode(data?: PIPConfig): Promise<undefined | boolean>;
+    setPipParams(data?: PIPConfig): Promise<undefined | boolean>;
 }
 export {};

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,9 @@ 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';
+export * from './classes/HMSMessageType';
 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": "1.0.0",
   "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.7"
+  s.dependency 'HMSBroadcastExtensionSDK', '0.0.5'
 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

@@ -53,6 +53,7 @@ export class HMSEncoder {
       hlsRecordingState: HMSEncoder.encodeHLSRecordingState(
         room?.hlsRecordingState
       ),
+      localPeer: HMSEncoder.encodeHmsLocalPeer(room?.localPeer, id),
     };
 
     return new HMSRoom(encodedObj);
@@ -181,9 +182,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 +191,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 +239,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 +315,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/HMSMessage.ts

@@ -1,17 +1,18 @@
 import type { HMSMessageRecipient } from './HMSMessageRecipient';
+import type { HMSMessageType } from './HMSMessageType';
 import type { HMSPeer } from './HMSPeer';
 
 export class HMSMessage {
   // endpoint: string;
   public message: string;
-  public type: string;
+  public type: HMSMessageType;
   public time: Date;
   public sender?: HMSPeer;
   public recipient: HMSMessageRecipient;
 
   constructor(params: {
     message: string;
-    type: string;
+    type: HMSMessageType;
     time: Date;
     sender?: HMSPeer;
     recipient: HMSMessageRecipient;

package/src/classes/HMSMessageType.ts

@@ -0,0 +1,4 @@
+export enum HMSMessageType {
+  CHAT = 'chat',
+  METADATA = 'metadata',
+}

package/src/classes/HMSRoom.ts

@@ -4,6 +4,7 @@ import type { HMSServerRecordingState } from './HMSServerRecordingState';
 import type { HMSBrowserRecordingState } from './HMSBrowserRecordingState';
 import type { HMSHLSStreamingState } from './HMSHLSStreamingState';
 import type { HMSHLSRecordingState } from './HMSHLSRecordingState';
+import type { HMSLocalPeer } from './HMSLocalPeer';
 
 export class HMSRoom {
   id: string;
@@ -17,6 +18,7 @@ export class HMSRoom {
   hlsStreamingState: HMSHLSStreamingState;
   hlsRecordingState?: HMSHLSRecordingState;
   peerCount: number;
+  localPeer: HMSLocalPeer;
 
   constructor(params: {
     id: string;
@@ -30,6 +32,7 @@ export class HMSRoom {
     hlsStreamingState: HMSHLSStreamingState;
     hlsRecordingState?: HMSHLSRecordingState;
     peerCount: number;
+    localPeer: HMSLocalPeer;
   }) {
     this.id = params.id;
     this.sessionId = params.sessionId;
@@ -42,5 +45,6 @@ export class HMSRoom {
     this.hlsStreamingState = params.hlsStreamingState;
     this.hlsRecordingState = params.hlsRecordingState;
     this.peerCount = params.peerCount;
+    this.localPeer = params.localPeer;
   }
 }

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;