@100mslive/react-native-hms 0.9.1 → 0.9.4

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

@@ -3,10 +3,12 @@ export declare class HMSConfig {
     authToken: string;
     endpoint?: string;
     metadata?: string;
+    captureNetworkQualityInPreview?: boolean;
     constructor(params: {
         username: string;
         authToken: string;
         endpoint?: string;
         metadata?: string;
+        captureNetworkQualityInPreview?: boolean;
     });
 }

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

@@ -20,6 +20,8 @@ import { HMSRemoteVideoTrack } from './HMSRemoteVideoTrack';
 import { HMSSpeaker } from './HMSSpeaker';
 import { HMSSpeakerUpdate } from './HMSSpeakerUpdate';
 import { HMSBrowserRecordingState, HMSHLSStreamingState, HMSHLSVariant, HMSRtmpStreamingState, HMSServerRecordingState } from '..';
+import { HMSHLSRecordingState } from './HMSHLSRecordingState';
+import { HMSNetworkQuality } from './HMSNetworkQuality';
 export declare class HMSEncoder {
     static encodeHmsRoom(room: HMSRoom, id: string): HMSRoom;
     static encodeHmsPeers(peers: any, id: string): HMSPeer[];
@@ -55,5 +57,7 @@ export declare class HMSEncoder {
     static encodeServerRecordingState(data: any): HMSServerRecordingState;
     static encodeRTMPStreamingState(data: any): HMSRtmpStreamingState;
     static encodeHLSStreamingState(data: any): HMSHLSStreamingState;
+    static encodeHLSRecordingState(data: any): HMSHLSRecordingState | undefined;
     static encodeHLSVariants(data: any): HMSHLSVariant[];
+    static encodeHMSNetworkQuality(data: any): HMSNetworkQuality | undefined;
 }

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

@@ -1,7 +1,10 @@
 import type { HMSHLSMeetingURLVariant } from './HMSHLSMeetingURLVariant';
+import type { HMSHLSRecordingConfig } from './HMSHLSRecordingConfig';
 export declare class HMSHLSConfig {
-    meetingURLVariants?: Array<HMSHLSMeetingURLVariant>;
+    hlsRecordingConfig?: HMSHLSRecordingConfig;
+    meetingURLVariants: Array<HMSHLSMeetingURLVariant>;
     constructor(params: {
-        meetingURLVariants?: Array<HMSHLSMeetingURLVariant>;
+        hlsRecordingConfig?: HMSHLSRecordingConfig;
+        meetingURLVariants: Array<HMSHLSMeetingURLVariant>;
     });
 }

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

@@ -0,0 +1,8 @@
+export declare class HMSHLSRecordingConfig {
+    singleFilePerLayer: boolean;
+    videoOnDemand: boolean;
+    constructor(params: {
+        singleFilePerLayer: boolean;
+        videoOnDemand: boolean;
+    });
+}

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

@@ -0,0 +1,12 @@
+export declare class HMSHLSRecordingState {
+    singleFilePerLayer: boolean;
+    videoOnDemand: boolean;
+    running: boolean;
+    startedAt?: Date;
+    constructor(params: {
+        singleFilePerLayer: boolean;
+        videoOnDemand: boolean;
+        running: boolean;
+        startedAt?: Date;
+    });
+}

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

@@ -8,6 +8,7 @@ import { HMSLocalAudioTrack } from './HMSLocalAudioTrack';
 import { HMSLocalVideoTrack } from './HMSLocalVideoTrack';
 import type { HMSRole } from './HMSRole';
 import type { HMSTrackType } from './HMSTrackType';
+import type { HMSNetworkQuality } from './HMSNetworkQuality';
 export declare class HMSLocalPeer extends HMSPeer {
     private localAudio?;
     private localVideo?;
@@ -22,6 +23,7 @@ export declare class HMSLocalPeer extends HMSPeer {
         metadata?: string;
         audioTrack?: HMSAudioTrack;
         videoTrack?: HMSVideoTrack;
+        networkQuality?: HMSNetworkQuality;
         role?: HMSRole;
         auxiliaryTracks?: HMSTrack[];
         localAudioTrackData?: {

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

@@ -0,0 +1,6 @@
+export declare class HMSNetworkQuality {
+    downlinkQuality: number;
+    constructor(params: {
+        downlinkQuality: number;
+    });
+}

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

@@ -1,4 +1,5 @@
 import type { HMSAudioTrack } from './HMSAudioTrack';
+import type { HMSNetworkQuality } from './HMSNetworkQuality';
 import type { HMSRole } from './HMSRole';
 import type { HMSTrack } from './HMSTrack';
 import type { HMSVideoTrack } from './HMSVideoTrack';
@@ -10,6 +11,7 @@ export declare class HMSPeer {
     customerDescription?: string;
     metadata?: string;
     role?: HMSRole;
+    networkQuality?: HMSNetworkQuality;
     audioTrack?: HMSAudioTrack;
     videoTrack?: HMSVideoTrack;
     auxiliaryTracks?: HMSTrack[];
@@ -21,6 +23,7 @@ export declare class HMSPeer {
         customerDescription?: string;
         metadata?: string;
         role?: HMSRole;
+        networkQuality?: HMSNetworkQuality;
         audioTrack?: HMSAudioTrack;
         videoTrack?: HMSVideoTrack;
         auxiliaryTracks?: HMSTrack[];

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

@@ -1,15 +1,8 @@
 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",
     NAME_CHANGED = "NAME_CHANGED",
-    DEFAULT_UPDATE = "DEFAULT_UPDATE"
+    NETWORK_QUALITY_UPDATED = "NETWORK_QUALITY_UPDATED"
 }

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

@@ -1,4 +1,5 @@
 import type { HMSAudioTrack } from './HMSAudioTrack';
+import type { HMSNetworkQuality } from './HMSNetworkQuality';
 import { HMSPeer } from './HMSPeer';
 import { HMSRemoteAudioTrack } from './HMSRemoteAudioTrack';
 import { HMSRemoteVideoTrack } from './HMSRemoteVideoTrack';
@@ -20,6 +21,7 @@ export declare class HMSRemotePeer extends HMSPeer {
         audioTrack?: HMSAudioTrack;
         videoTrack?: HMSVideoTrack;
         role?: HMSRole;
+        networkQuality?: HMSNetworkQuality;
         auxiliaryTracks?: HMSTrack[];
         remoteAudioTrackData?: {
             trackId: string;

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

@@ -3,6 +3,7 @@ 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;
@@ -12,6 +13,7 @@ export declare class HMSRoom {
     rtmpHMSRtmpStreamingState: HMSRtmpStreamingState;
     serverRecordingState: HMSServerRecordingState;
     hlsStreamingState: HMSHLSStreamingState;
+    hlsRecordingState?: HMSHLSRecordingState;
     peerCount: number;
     constructor(params: {
         id: string;
@@ -22,6 +24,7 @@ export declare class HMSRoom {
         rtmpHMSRtmpStreamingState: HMSRtmpStreamingState;
         serverRecordingState: HMSServerRecordingState;
         hlsStreamingState: HMSHLSStreamingState;
+        hlsRecordingState?: HMSHLSRecordingState;
         peerCount: number;
     });
 }

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

@@ -10,7 +10,7 @@ import type { HMSTrack } from './HMSTrack';
 import type { HMSTrackType } from './HMSTrackType';
 import type { HMSLogger } from './HMSLogger';
 import type { HMSPeer } from './HMSPeer';
-import { HMSVideoViewMode } from './HMSVideoViewMode';
+import type { HMSVideoViewMode } from './HMSVideoViewMode';
 import type { HMSTrackSettings } from './HMSTrackSettings';
 import type { HMSRTMPConfig } from './HMSRTMPConfig';
 import type { HMSHLSConfig } from './HMSHLSConfig';
@@ -19,8 +19,10 @@ interface HmsComponentProps {
     sink: boolean;
     style: ViewStyle;
     mirror?: boolean;
-    scaleType: HMSVideoViewMode;
+    scaleType?: HMSVideoViewMode;
+    screenshot?: boolean;
     id?: string | null;
+    setZOrderMediaOverlay?: boolean;
 }
 export declare class HMSSDK {
     room?: HMSRoom;
@@ -51,7 +53,7 @@ export declare class HMSSDK {
     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
@@ -60,58 +62,332 @@ export declare class HMSSDK {
     static build(params?: {
         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: ({ sink, trackId, style, mirror, scaleType, }: HmsComponentProps) => JSX.Element;
     /**
-     * Calls leave function of native sdk and session of current user is invalidated
+     * - 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, screenshot, setZOrderMediaOverlay, }: HmsComponentProps) => JSX.Element;
+    /**
+     * 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>;
+    /**
+     * - 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>;
+    /**
+     * - 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>;
+    /**
+     * - 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;
-    startScreenshare: () => 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
@@ -120,7 +396,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
@@ -133,6 +408,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;

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

@@ -6,8 +6,10 @@ interface HmsComponentProps {
     sink: boolean;
     style: ViewStyle;
     mirror?: boolean;
-    scaleType: HMSVideoViewMode;
+    scaleType?: HMSVideoViewMode;
+    setZOrderMediaOverlay?: boolean;
+    screenshot?: boolean;
     id?: string | null;
 }
-export declare const HmsView: ({ sink, trackId, style, id, mirror, scaleType, }: HmsComponentProps) => JSX.Element;
+export declare const HmsView: ({ sink, trackId, style, id, mirror, setZOrderMediaOverlay, scaleType, screenshot, }: HmsComponentProps) => JSX.Element;
 export {};

package/lib/typescript/index.d.ts

@@ -57,5 +57,10 @@ export * from './classes/HMSRTCStats';
 export * from './classes/HMSRTCStatsReport';
 export * from './classes/HMSRemoteAudioStats';
 export * from './classes/HMSRemoteVideoStats';
+export * from './classes/HMSHLSRecordingConfig';
+export * from './classes/HMSHLSRecordingState';
+export * from './classes/HMSMessageRecipient';
+export * from './classes/HMSMessageRecipientType';
+export * from './classes/HMSNetworkQuality';
 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.1",
+  "version": "0.9.4",
   "description": "The React Native package for 100ms SDK",
   "main": "lib/commonjs/index",
   "module": "lib/module/index",

package/react-native-hms.podspec

@@ -16,5 +16,5 @@ Pod::Spec.new do |s|
   s.source_files = "ios/**/*.{h,m,mm,swift}"
 
   s.dependency "React-Core"
-  s.dependency "HMSSDK", "0.2.7"
+  s.dependency "HMSSDK", "0.2.9"
 end