@100mslive/react-native-hms 0.8.4 → 0.9.2

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

@@ -4,6 +4,7 @@ export declare class HMSLogger {
     private _warning;
     private _error;
     private logs;
+    private onLog?;
     constructor(params?: {
         verbose: boolean;
         warning: boolean;
@@ -18,5 +19,6 @@ export declare class HMSLogger {
         data: any;
         id: string;
     }[];
+    setLogListener(callback: Function): void;
     updateLogLevel(level: HMSLogLevel, value: boolean): void;
 }

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

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

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

@@ -0,0 +1,13 @@
+import type { HMSMessageRecipientType } from './HMSMessageRecipientType';
+import type { HMSPeer } from './HMSPeer';
+import type { HMSRole } from './HMSRole';
+export declare class HMSMessageRecipient {
+    recipientType?: HMSMessageRecipientType;
+    recipientPeer?: HMSPeer;
+    recipientRoles?: HMSRole[];
+    constructor(params: {
+        recipientType: HMSMessageRecipientType;
+        recipientPeer?: HMSPeer;
+        recipientRoles?: HMSRole[];
+    });
+}

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

@@ -0,0 +1,5 @@
+export declare enum HMSMessageRecipientType {
+    BROADCAST = "BROADCAST",
+    PEER = "PEER",
+    ROLES = "ROLES"
+}

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

@@ -1,13 +1,7 @@
 export declare enum HMSPeerUpdate {
     PEER_JOINED = "PEER_JOINED",
     PEER_LEFT = "PEER_LEFT",
-    AUDIO_TOGGLED = "AUDIO_TOGGLED",
-    VIDEO_TOGGLED = "VIDEO_TOGGLED",
     METADATA_CHANGED = "METADATA_CHANGED",
-    BECAME_DOMINANT_SPEAKER = "BECAME_DOMINANT_SPEAKER",
-    NO_DOMINANT_SPEAKER = "NO_DOMINANT_SPEAKER",
-    RESIGNED_DOMINANT_SPEAKER = "RESIGNED_DOMINANT_SPEAKER",
-    STARTED_SPEAKING = "STARTED_SPEAKING",
-    STOPPED_SPEAKING = "STOPPED_SPEAKING",
-    ROLE_CHANGED = "ROLE_CHANGED"
+    ROLE_CHANGED = "ROLE_CHANGED",
+    NAME_CHANGED = "NAME_CHANGED"
 }

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

@@ -5,7 +5,7 @@ export declare class HMSPermissions {
     mute?: boolean;
     changeRole?: boolean;
     recording?: boolean;
-    rtmp?: boolean;
+    streaming?: boolean;
     constructor(params?: {
         endRoom?: boolean;
         removeOthers?: boolean;
@@ -13,6 +13,6 @@ export declare class HMSPermissions {
         mute?: boolean;
         changeRole?: boolean;
         recording?: boolean;
-        rtmp?: boolean;
+        streaming?: boolean;
     });
 }

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

@@ -0,0 +1,18 @@
+export declare class HMSRTCStats {
+    bitrateReceived?: number;
+    bitrateSent?: number;
+    bytesReceived?: number;
+    bytesSent?: number;
+    packetsLost?: number;
+    packetsReceived?: number;
+    roundTripTime?: number;
+    constructor(params: {
+        bitrateReceived?: number;
+        bitrateSent?: number;
+        bytesReceived?: number;
+        bytesSent?: number;
+        packetsLost?: number;
+        packetsReceived?: number;
+        roundTripTime?: number;
+    });
+}

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

@@ -0,0 +1,11 @@
+import type { HMSRTCStats } from './HMSRTCStats';
+export declare class HMSRTCStatsReport {
+    video?: HMSRTCStats;
+    audio?: HMSRTCStats;
+    combined?: HMSRTCStats;
+    constructor(params: {
+        video?: HMSRTCStats;
+        audio?: HMSRTCStats;
+        combined?: HMSRTCStats;
+    });
+}

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

@@ -0,0 +1,14 @@
+export declare class HMSRemoteAudioStats {
+    bitrate?: number;
+    packetsReceived?: number;
+    packetsLost?: number;
+    bytesReceived?: number;
+    jitter?: number;
+    constructor(params: {
+        bitrate?: number;
+        packetsReceived?: number;
+        packetsLost?: number;
+        bytesReceived?: number;
+        jitter?: number;
+    });
+}

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

@@ -0,0 +1,19 @@
+import type { HMSVideoResolution } from './HMSVideoResolution';
+export declare class HMSRemoteVideoStats {
+    bitrate?: number;
+    packetsReceived?: number;
+    packetsLost?: number;
+    bytesReceived?: number;
+    jitter?: number;
+    resolution?: HMSVideoResolution;
+    frameRate?: number;
+    constructor(params: {
+        bitrate?: number;
+        packetsReceived?: number;
+        packetsLost?: number;
+        bytesReceived?: number;
+        jitter?: number;
+        resolution?: HMSVideoResolution;
+        frameRate?: number;
+    });
+}

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

@@ -2,6 +2,8 @@ import type { HMSPeer } from './HMSPeer';
 import type { HMSRtmpStreamingState } from './HMSRtmpStreamingState';
 import type { HMSServerRecordingState } from './HMSServerRecordingState';
 import type { HMSBrowserRecordingState } from './HMSBrowserRecordingState';
+import type { HMSHLSStreamingState } from './HMSHLSStreamingState';
+import type { HMSHLSRecordingState } from './HMSHLSRecordingState';
 export declare class HMSRoom {
     id: string;
     name: string;
@@ -10,6 +12,9 @@ export declare class HMSRoom {
     browserRecordingState: HMSBrowserRecordingState;
     rtmpHMSRtmpStreamingState: HMSRtmpStreamingState;
     serverRecordingState: HMSServerRecordingState;
+    hlsStreamingState: HMSHLSStreamingState;
+    hlsRecordingState?: HMSHLSRecordingState;
+    peerCount: number;
     constructor(params: {
         id: string;
         name: string;
@@ -18,5 +23,8 @@ export declare class HMSRoom {
         browserRecordingState: HMSBrowserRecordingState;
         rtmpHMSRtmpStreamingState: HMSRtmpStreamingState;
         serverRecordingState: HMSServerRecordingState;
+        hlsStreamingState: HMSHLSStreamingState;
+        hlsRecordingState?: HMSHLSRecordingState;
+        peerCount: number;
     });
 }

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

@@ -1,4 +1,11 @@
 export declare enum HMSRoomUpdate {
     ROOM_MUTED = "ROOM_MUTED",
-    ROOM_UNMUTED = "ROOM_UNMUTED"
+    ROOM_UNMUTED = "ROOM_UNMUTED",
+    ROOM_TYPE_CHANGED = "ROOM_TYPE_CHANGED",
+    META_DATA_CHANGED = "META_DATA_CHANGED",
+    SERVER_RECORDING_STATE_UPDATED = "SERVER_RECORDING_STATE_UPDATED",
+    RTMP_STREAMING_STATE_UPDATED = "RTMP_STREAMING_STATE_UPDATED",
+    BROWSER_RECORDING_STATE_UPDATED = "BROWSER_RECORDING_STATE_UPDATED",
+    HLS_STREAMING_STATE_UPDATED = "HLS_STREAMING_STATE_UPDATED",
+    ROOM_ID_UPDATED = "ROOM_ID_UPDATED"
 }

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

@@ -2,8 +2,12 @@ import type { HMSException } from './HMSException';
 export declare class HMSRtmpStreamingState {
     running: string;
     error: HMSException;
+    startedAt: Date;
+    stoppedAt: Date;
     constructor(params: {
         running: string;
         error: HMSException;
+        startedAt: Date;
+        stoppedAt: Date;
     });
 }

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

@@ -13,6 +13,7 @@ import type { HMSPeer } from './HMSPeer';
 import { HMSVideoViewMode } from './HMSVideoViewMode';
 import type { HMSTrackSettings } from './HMSTrackSettings';
 import type { HMSRTMPConfig } from './HMSRTMPConfig';
+import type { HMSHLSConfig } from './HMSHLSConfig';
 interface HmsComponentProps {
     trackId: string;
     sink: boolean;
@@ -28,6 +29,7 @@ export declare class HMSSDK {
     knownRoles?: HMSRole[];
     id: string;
     private muteStatus;
+    appStateSubscription?: any;
     onPreviewDelegate?: any;
     onJoinDelegate?: any;
     onRoomDelegate?: any;
@@ -41,58 +43,349 @@ export declare class HMSSDK {
     onRoleChangeRequestDelegate?: any;
     onChangeTrackStateRequestDelegate?: any;
     onRemovedFromRoomDelegate?: any;
+    onRtcStatsDelegate?: any;
+    onLocalAudioStatsDelegate?: any;
+    onLocalVideoStatsDelegate?: any;
+    onRemoteAudioStatsDelegate?: any;
+    onRemoteVideoStatsDelegate?: any;
     constructor(id: string);
     /**
      * - 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
+     * - This function must be called to get an instance of HMSSDK class and only then user can interact with its methods.
      *
      * @static
      * @returns
      * @memberof HMSSDK
      */
     static build(params?: {
-        trackSettings?: HMSTrackSettings;
+        trackSettings: HMSTrackSettings;
     }): Promise<HMSSDK>;
+    /**
+     * - Returns the instance of logger which can be used to manipulate log levels.
+     * @returns @instance HMSLogger
+     * @memberof HMSSDK
+     */
     static getLogger(): HMSLogger | undefined;
+    /**
+     * - Updates the logger for this instance of HMSSDK
+     * @param {HMSLogger} hmsLogger
+     * @memberof HMSSDK
+     */
     setLogger: (hmsLogger: HMSLogger) => void;
+    /**
+     * - Calls removeListeners that in turn breaks all connections with native listeners.
+     *
+     * @memberof HMSSDK
+     */
     destroy: () => void;
+    /**
+     * - 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.
+     * @memberof HMSSDK
+     */
     attachListeners: () => void;
+    /**
+     * Disconnects all the listeners of this sdk from native listeners.
+     * Note: this function is only called from destroy function and should only be called when the current instance of {@link HMSSDK} is not required anymore.
+     * @memberof HMSSDK
+     */
     removeListeners: () => void;
     /**
-     * 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
+     * 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.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/join} for more info
      *
      * @param {HMSConfig} config
      * @memberof HMSSDK
      */
     join: (config: HMSConfig) => Promise<void>;
+    /**
+     * - preview function is used to initiate a preview for the localPeer.
+     * - We can call this function and wait for a response in previewListener, the response will contain previewTracks for local peer.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/preview} for more info
+     *
+     * @param {HMSConfig} config
+     * @memberof HMSSDK
+     */
     preview: (config: HMSConfig) => void;
+    /**
+     * - previewForRole can be used when there is role change request for current localPeer and we want
+     * to show the localPeer how the tracks look before publishing them to room.
+     *
+     * - It requires a role of type [HMSRole]{@link HMSRole} for which we want to preview the tracks.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native} for more info
+     *
+     * @param {HMSRole}
+     * @memberof HMSSDK
+     */
+    previewForRole: (role: HMSRole) => Promise<any>;
+    /**
+     * - HmsView is react component that takes one track and starts showing that track on a tile.
+     * - The appearance of tile is completely customizable with style prop.
+     * - setting sink true or false for a video tile will add or remove sink for a video.
+     * - scale type can determine how the incoming video will fit in the canvas check {@link HMSVideoViewMode} for more information.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/render-video} for more info
+     *
+     * @param {HmsComponentProps}
+     * @memberof HMSSDK
+     */
     HmsView: ({ sink, trackId, style, mirror, scaleType, }: HmsComponentProps) => JSX.Element;
     /**
-     * Calls leave function of native sdk and session of current user is invalidated
+     * Calls leave function of native sdk and session of current user is invalidated.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/leave} for more info
      *
      * @memberof HMSSDK
      */
     leave: () => Promise<any>;
-    sendBroadcastMessage: (message: string, type?: string | undefined) => Promise<any>;
-    sendGroupMessage: (message: string, roles: HMSRole[], type?: string | undefined) => Promise<any>;
-    sendDirectMessage: (message: string, peerId: string, type?: string | undefined) => Promise<any>;
+    /**
+     * - This function sends message to all the peers in the room, the get the message in onMessage listener.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/chat} for more info
+     *
+     * @param {message: string} and @param {type: string}
+     * @memberof HMSSDK
+     */
+    sendBroadcastMessage: (message: string, type?: string) => 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.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/chat} for more info
+     *
+     * @memberof HMSSDK
+     */
+    sendGroupMessage: (message: string, roles: HMSRole[], type?: string) => Promise<any>;
+    /**
+     * - sendDirectMessage sends a private message to a single peer, only that peer will get the message
+     * in onMessage Listener.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/chat} for more info
+     *
+     * @memberof HMSSDK
+     */
+    sendDirectMessage: (message: string, peer: HMSPeer, type?: string) => 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
+     * current status of the peer.
+     *
+     * - 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
+     *
+     * @param {string}
+     * @memberof HMSSDK
+     */
     changeMetadata: (metadata: string) => void;
+    /**
+     * - startRTMPOrRecording takes a configuration object {@link HMSRTMPConfig} and stats the RTMP recording
+     * - this object of {@link HMSRTMPConfig} sets the urls for streaming and weather to set recording on or not
+     * - we get the response of this function in onRoomUpdate as RTMP_STREAMING_STATE_UPDATED.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/recording} for more info
+     *
+     * @memberof HMSSDK
+     */
     startRTMPOrRecording: (data: HMSRTMPConfig) => Promise<any>;
+    /**
+     * - this function stops all the ongoing RTMP streaming and recording.
+     * - we get the response of this function in onRoomUpdate as RTMP_STREAMING_STATE_UPDATED.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/recording} for more info
+     *
+     * @memberof HMSSDK
+     */
     stopRtmpAndRecording: () => Promise<any>;
+    /**
+     * - This function starts HLSStreaming.
+     * - we get the response of this function in onRoomUpdate as HLS_STREAMING_STATE_UPDATED.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/hls-streaming} for more info
+     *
+     * @param {HMSHLSConfig}
+     * @memberof HMSSDK
+     */
+    startHLSStreaming: (data: HMSHLSConfig) => Promise<any>;
+    /**
+     * - stopHLSStreaming function stops the ongoing HLSStreams.
+     * - we get the response of this function in onRoomUpdate as HLS_STREAMING_STATE_UPDATED.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/hls-streaming} for more info
+     *
+     * @memberof HMSSDK
+     */
+    stopHLSStreaming: () => Promise<any>;
+    /**
+     * - This function can be used in a situation when we want to change role hence manipulate their
+     * access and rights in the current room, it takes the peer {@link HMSPeer} whom role we want to change,
+     * role {@link HMSRole} which will be the new role for that peer and weather to forcefully change
+     * the role or ask the to accept the role change request using a boolean force.
+     *
+     * - if we change the role forcefully the peer's role will be updated without asking the peer
+     * otherwise the user will get the roleChangeRequest in roleChangeRequest listener.
+     * for more information on this checkout {@link onRoleChangeRequestListener}
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-role} for more info
+     *
+     * @memberof HMSSDK
+     */
     changeRole: (peer: HMSPeer, role: HMSRole, force?: boolean) => Promise<any>;
+    /**
+     * - This function can be used to manipulate mute status of any track.
+     * - Targeted peer affected by this action will get a callback in {@link onChangeTrackStateRequestListener}.
+     *
+     * * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-track-state} for more info
+     *
+     * @param {HMSTrack}
+     * @memberof HMSSDK
+     */
     changeTrackState: (track: HMSTrack, mute: boolean) => Promise<any>;
-    changeTrackStateRoles: (type: HMSTrackType, mute: boolean, source: string, roles: Array<HMSRole>) => Promise<any>;
-    removePeer: (peerId: string, reason: string) => Promise<any>;
-    endRoom: (lock: boolean, reason: string) => Promise<any>;
+    /**
+     * - changeTrackStateForRoles is an enhancement on the functionality of {@link changeTrackState}.
+     * - We can change mute status for all the tracks of peers having a particular role.
+     * - @param source determines the source of the track ex. video, audio etc.
+     * - The peers affected by this action will get a callback in {@link onChangeTrackStateRequestListener}.
+     *
+     * @memberof HMSSDK
+     */
+    changeTrackStateForRoles: (mute: boolean, type?: HMSTrackType | undefined, source?: string | undefined, roles?: HMSRole[] | undefined) => Promise<any>;
+    /**
+     * - removePeer can forcefully disconnect a Peer from the room.
+     * - the user who's removed from this action will get a callback in {@link onRemovedFromRoomListener}.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/remove-peer} for more info
+     *
+     * @memberof HMSSDK
+     */
+    removePeer: (peer: HMSPeer, reason: string) => Promise<any>;
+    /**
+     * - endRoom can be used in a situation where we want to disconnect all the peers from current room
+     * and end the call.
+     * - everyone in the room will get an update of this action in {@link onRemovedFromRoomListener}.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/end-room} for more info
+     *
+     * @memberof HMSSDK
+     */
+    endRoom: (reason: string, lock?: boolean) => Promise<any>;
+    /**
+     * - This function can be used to change name of localPeer.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-name} for more info
+     *
+     * @memberof HMSSDK
+     */
+    changeName: (name: string) => Promise<any>;
+    /**
+     * - Calling this function will accept the most recent roleChange request made by anyone in the room
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-role} for more info
+     *
+     * @memberof HMSSDK
+     */
     acceptRoleChange: () => Promise<any>;
-    muteAllPeersAudio: (mute: boolean) => void;
+    /**
+     * - setPlaybackForAllAudio is an extension of the abilities of {@link setPlaybackAllowed} in
+     * {@link HMSRemoteAudioTrack}, it sets mute status for all peers in the room
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/playback-allowed} for more info
+     *
+     * @memberof HMSSDK
+     */
+    setPlaybackForAllAudio: (mute: boolean) => void;
+    /**
+     * - This function mutes audio for all peers in the room.
+     *
+     * @memberof HMSSDK
+     */
+    remoteMuteAllAudio: () => void;
+    /**
+     * - 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
+     *
+     * @memberof HMSSDK
+     * @return HMSRoom
+     */
     getRoom: () => Promise<HMSRoom>;
+    /**
+     * - 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
+     *
+     * @memberof HMSSDK
+     */
     setVolume: (track: HMSTrack, volume: number) => void;
+    resetVolume: () => void;
+    /**
+     * - This is a temporary solution for the situation when mic access is taken from the app and
+     * user returns to the app with no mic access. It will re-acquire the mic by setting the volume
+     * from native side
+     *
+     * @memberof HMSSDK
+     */
+    addAppStateListener: () => void;
+    /**
+     * - This function is used to start screenshare, currently available only for android
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/screenshare} for more info
+     *
+     * @memberof HMSSDK
+     */
+    startScreenshare: () => Promise<any>;
+    /**
+     * - Returns a boolean stating if the screen is currently shared or not
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/screenshare} for more info
+     *
+     * @memberof HMSSDK
+     */
+    isScreenShared: () => Promise<any>;
+    /**
+     * - stops the screenShare, currently available for android only.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/screenshare} for more info
+     *
+     * @memberof HMSSDK
+     */
+    stopScreenshare: () => Promise<any>;
+    /**
+     * - 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: () => void;
+    /**
+     * - 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: () => void;
     /**
      * - This is a prototype event listener that takes action and listens for updates related to that particular action
-     * - This method will be @deprecated in future and event listener will be passed in join method
      *
      * @param {string} action
      * @param {*} callback
@@ -101,7 +394,6 @@ export declare class HMSSDK {
     addEventListener: (action: HMSUpdateListenerActions, callback: any) => void;
     /**
      * - This is a prototype event listener that takes action and listens for updates related to that particular action
-     * - This method will be @deprecated in future and event listener will be passed in join method
      *
      * @param {string} action
      * @param {*} callback
@@ -114,6 +406,20 @@ export declare class HMSSDK {
      * @memberof HMSSDK
      */
     removeAllListeners: () => void;
+    /**
+     * - Below are all the listeners that are connected to native side.
+     *
+     * - All of the are connected when build function is called, we can connect them to the app by
+     * calling {@link addEventListener} with corresponding event type.
+     *
+     * - Before passing the data to the eventListener of the app these listeners encode the data in
+     * ts classes for a proper structuring of the data.
+     *
+     * - Even When event listeners of the app are disconnected using {@link removeEventListener} or
+     * {@link removeAllListeners} or not even connected in first place, these functions still run to
+     * maintain the current state of the instance of {@link HMSSDK}.
+     *
+     */
     onPreviewListener: (data: any) => void;
     onJoinListener: (data: any) => void;
     onRoomListener: (data: any) => void;
@@ -127,5 +433,10 @@ export declare class HMSSDK {
     onRemovedFromRoomListener: (data: any) => void;
     reconnectingListener: (data: any) => void;
     reconnectedListener: (data: any) => void;
+    RTCStatsListener: (data: any) => void;
+    onLocalAudioStatsListener: (data: any) => void;
+    onLocalVideoStatsListener: (data: any) => void;
+    onRemoteAudioStatsListener: (data: any) => void;
+    onRemoteVideoStatsListener: (data: any) => void;
 }
 export {};

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

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

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

@@ -11,5 +11,10 @@ export declare enum HMSUpdateListenerActions {
     RECONNECTED = "RECONNECTED",
     ON_ROLE_CHANGE_REQUEST = "ON_ROLE_CHANGE_REQUEST",
     ON_CHANGE_TRACK_STATE_REQUEST = "ON_CHANGE_TRACK_STATE_REQUEST",
-    ON_REMOVED_FROM_ROOM = "ON_REMOVED_FROM_ROOM"
+    ON_REMOVED_FROM_ROOM = "ON_REMOVED_FROM_ROOM",
+    ON_RTC_STATS = "ON_RTC_STATS",
+    ON_LOCAL_AUDIO_STATS = "ON_LOCAL_AUDIO_STATS",
+    ON_LOCAL_VIDEO_STATS = "ON_LOCAL_VIDEO_STATS",
+    ON_REMOTE_AUDIO_STATS = "ON_REMOTE_AUDIO_STATS",
+    ON_REMOTE_VIDEO_STATS = "ON_REMOTE_VIDEO_STATS"
 }