@100mslive/react-native-hms 1.2.0 → 1.4.0

package/lib/commonjs/classes/HMSSDK.js

@@ -19,6 +19,9 @@ var _HmsView = require("./HmsView");
 var _HMSMessageType = require("./HMSMessageType");
 var _HMSPIPListenerActions = require("./HMSPIPListenerActions");
 var _HMSNativeEventEmitter = require("./HMSNativeEventEmitter");
+var _HMSPeersCache = require("./HMSPeersCache");
+var _HMSRoomCache = require("./HMSRoomCache");
+var _HMSPeerUpdate = require("./HMSPeerUpdate");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
 function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
 function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return typeof key === "symbol" ? key : String(key); }
@@ -59,29 +62,74 @@ class HMSSDK {
     _defineProperty(this, "onAudioDeviceChangedDelegate", void 0);
     _defineProperty(this, "onPIPRoomLeaveDelegate", void 0);
     _defineProperty(this, "emitterSubscriptions", {});
-    _defineProperty(this, "setLogger", hmsLogger => {
-      (0, _HMSLogger.setLogger)(this.id, hmsLogger);
-    });
+    /**
+     * - Calls removeListeners that in turn breaks all connections with native listeners.
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "destroy", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function destroy', {
         id: this.id
       });
+      (0, _HMSPeersCache.clearHmsPeersCache)();
+      (0, _HMSRoomCache.clearHmsRoomCache)();
       this.removeAllListeners();
       return await HMSManager.destroy({
         id: this.id
       });
     });
+    /**
+     * - getAuthTokenByRoomCode function is used to get the Auth Token by Room Code
+     *
+     * checkout {@link https://www.100ms.live/docs/concepts/v2/concepts/rooms/room-codes/room-codes} for more info
+     *
+     * @memberof HMSSDK
+     */
+    _defineProperty(this, "getAuthTokenByRoomCode", async (roomCode, userId, endpoint) => {
+      _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getAuthTokenByRoomCode', {
+        id: this.id,
+        roomCode,
+        userId,
+        endpoint
+      });
+      return HMSManager.getAuthTokenByRoomCode({
+        id: this.id,
+        roomCode,
+        userId,
+        endpoint
+      });
+    });
+    /**
+     * 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
+     */
     _defineProperty(this, "join", async config => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function join', {
         config,
         id: this.id
       });
       this.addAppStateListener();
+      (0, _HMSPeersCache.setHmsPeersCache)(new _HMSPeersCache.HMSPeersCache(this.id));
+      (0, _HMSRoomCache.setHmsRoomCache)(new _HMSRoomCache.HMSRoomCache(this.id));
       await HMSManager.join({
         ...config,
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "preview", config => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function preview', {
         config,
@@ -92,6 +140,17 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "previewForRole", async role => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function previewForRole', {
         role,
@@ -107,6 +166,17 @@ class HMSSDK {
         return 'API currently not available for android';
       }
     });
+    /**
+     * - HmsView is react component that takes trackId and starts showing that track on a tile.
+     * - The appearance of tile is completely customizable with style prop.
+     * - Scale type can determine how the incoming video will fit in the canvas check {@link HMSVideoViewMode} for more information.
+     * - Mirror to flip the video vertically.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/render-video} for more info
+     *
+     * @param {HmsViewProps}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "HmsView", /*#__PURE__*/_react.default.forwardRef((props, ref) => {
       const {
         trackId,
@@ -129,8 +199,17 @@ class HMSSDK {
       var _this$appStateSubscri;
       this.muteStatus = undefined;
       this === null || this === void 0 ? void 0 : (_this$appStateSubscri = this.appStateSubscription) === null || _this$appStateSubscri === void 0 ? void 0 : _this$appStateSubscri.remove();
+      (0, _HMSPeersCache.clearHmsPeersCache)();
+      (0, _HMSRoomCache.clearHmsRoomCache)();
       _HMSEncoder.HMSEncoder.clearData(); // Clearing cached data in encoder
     });
+    /**
+     * 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
+     */
     _defineProperty(this, "leave", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function leave', {
         id: this.id
@@ -142,6 +221,14 @@ class HMSSDK {
       this.roomLeaveCleanup();
       return op;
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "sendBroadcastMessage", async function (message) {
       let type = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : _HMSMessageType.HMSMessageType.CHAT;
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function sendBroadcastMessage', {
@@ -155,6 +242,14 @@ class HMSSDK {
         id: _this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "sendGroupMessage", async function (message, roles) {
       let type = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : _HMSMessageType.HMSMessageType.CHAT;
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function sendGroupMessage', {
@@ -170,6 +265,14 @@ class HMSSDK {
         type: type || null
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "sendDirectMessage", async function (message, peer) {
       let type = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : _HMSMessageType.HMSMessageType.CHAT;
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function sendDirectMessage', {
@@ -185,6 +288,18 @@ class HMSSDK {
         type: type || null
       });
     });
+    /**
+     * - 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/advanced-features/change-metadata} for more info
+     *
+     * @param {string}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "changeMetadata", async metadata => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function changeMetadata', {
         metadata,
@@ -195,6 +310,15 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "startRTMPOrRecording", async data => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function startRTMPOrRecording', {
         ...data,
@@ -206,6 +330,14 @@ class HMSSDK {
       });
       return op;
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "stopRtmpAndRecording", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function stopRtmpAndRecording', {});
       const op = await HMSManager.stopRtmpAndRecording({
@@ -213,6 +345,15 @@ class HMSSDK {
       });
       return op;
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "startHLSStreaming", async data => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function startHLSStreaming', {
         ...data,
@@ -223,12 +364,36 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "stopHLSStreaming", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function stopHLSStreaming', {});
       return await HMSManager.stopHLSStreaming({
         id: this.id
       });
     });
+    /**
+     * @deprecated This function has been deprecated in favor of #Function changeRoleOfPeer
+     *
+     * - 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
+     */
     _defineProperty(this, "changeRole", async function (peer, role) {
       let force = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
       const data = {
@@ -240,6 +405,20 @@ class HMSSDK {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function changeRole', data);
       return await HMSManager.changeRole(data);
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "changeRoleOfPeer", async function (peer, role) {
       let force = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : false;
       const data = {
@@ -251,6 +430,19 @@ class HMSSDK {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function changeRoleOfPeer', data);
       return HMSManager.changeRoleOfPeer(data);
     });
+    /**
+     * - This function can be used in a situation when we want to change role of multiple peers by specifying their roles.
+     * Hence manipulate their access and rights in the current room.
+     * It takes the list of roles {@link HMSRole} whom role we want to change
+     * and role {@link HMSRole} which will be the new role for peers.
+     *
+     * - Note that role will be updated without asking the peers.
+     * Meaning, Peers will not get the roleChangeRequest in roleChangeRequest listener.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-role} for more info
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "changeRoleOfPeersWithRoles", async (ofRoles, toRole) => {
       const data = {
         ofRoles: ofRoles.map(ofRole => ofRole.name).filter(Boolean),
@@ -260,6 +452,15 @@ class HMSSDK {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function changeRoleOfPeersWithRoles', data);
       return HMSManager.changeRoleOfPeersWithRoles(data);
     });
+    /**
+     * - This function can be used to manipulate mute status of any track.
+     * - Targeted peer affected by this action will get a callback in onChangeTrackStateRequestListener.
+     *
+     * * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-track-state} for more info
+     *
+     * @param {HMSTrack}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "changeTrackState", async (track, mute) => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function changeTrackState', {
         track,
@@ -273,6 +474,14 @@ class HMSSDK {
       };
       return await HMSManager.changeTrackState(data);
     });
+    /**
+     * - 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 onChangeTrackStateRequestListener.
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "changeTrackStateForRoles", async (mute, type, source, roles) => {
       let roleNames = null;
       if (roles) {
@@ -294,6 +503,14 @@ class HMSSDK {
       };
       return await HMSManager.changeTrackStateForRoles(data);
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "removePeer", async (peer, reason) => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function removePeer', {
         peerId: peer.peerID,
@@ -307,6 +524,15 @@ class HMSSDK {
       };
       return await HMSManager.removePeer(data);
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "endRoom", async function (reason) {
       let lock = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : false;
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function endRoom', {
@@ -321,6 +547,13 @@ class HMSSDK {
       };
       return await HMSManager.endRoom(data);
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "changeName", async name => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function changeName', {
         name,
@@ -332,6 +565,13 @@ class HMSSDK {
       };
       return await HMSManager.changeName(data);
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "acceptRoleChange", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function acceptRoleChange', {
         id: this.id
@@ -340,6 +580,14 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - setPlaybackForAllAudio is an extension of the abilities of setPlaybackAllowed in
+     * 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
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "setPlaybackForAllAudio", mute => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function setPlaybackForAllAudio', {
         mute,
@@ -351,6 +599,11 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - This function mutes audio for all peers in the room.
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "remoteMuteAllAudio", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function remoteMuteAllAudio', {
         id: this.id
@@ -359,16 +612,34 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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/join#get-room} for more info
+     *
+     * @memberof HMSSDK
+     * @return Promise<HMSRoom>
+     */
     _defineProperty(this, "getRoom", async () => {
+      var _getHmsRoomCache;
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getRoom', {
         id: this.id
       });
       const hmsRoom = await HMSManager.getRoom({
         id: this.id
       });
+      (_getHmsRoomCache = (0, _HMSRoomCache.getHmsRoomCache)()) === null || _getHmsRoomCache === void 0 ? void 0 : _getHmsRoomCache.updateRoomCache(hmsRoom);
       const encodedHmsRoom = _HMSEncoder.HMSEncoder.encodeHmsRoom(hmsRoom, this.id);
       return encodedHmsRoom;
     });
+    /**
+     * - 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>
+     */
     _defineProperty(this, "getLocalPeer", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getLocalPeer', {
         id: this.id
@@ -379,6 +650,13 @@ class HMSSDK {
       const encodedLocalPeer = _HMSEncoder.HMSEncoder.encodeHmsLocalPeer(localPeer, this.id);
       return encodedLocalPeer;
     });
+    /**
+     * - 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[]>
+     */
     _defineProperty(this, "getRemotePeers", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getRemotePeers', {
         id: this.id
@@ -389,6 +667,13 @@ class HMSSDK {
       const encodedRemotePeers = _HMSEncoder.HMSEncoder.encodeHmsRemotePeers(remotePeers, this.id);
       return encodedRemotePeers;
     });
+    /**
+     * - 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[]>
+     */
     _defineProperty(this, "getRoles", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getRoles', {
         id: this.id
@@ -399,6 +684,13 @@ class HMSSDK {
       const encodedRoles = _HMSEncoder.HMSEncoder.encodeHmsRoles(roles);
       return encodedRoles;
     });
+    /**
+     * - This function sets the volume of any peer in the room
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/advanced-features/set-volume} for more info
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "setVolume", (track, volume) => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function setVolume', {
         track,
@@ -419,6 +711,13 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "addAppStateListener", () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function addAppStateListener', {
         id: this.id
@@ -429,6 +728,13 @@ class HMSSDK {
         }
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "startScreenshare", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function startScreenshare', {
         id: this.id
@@ -437,6 +743,13 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "isScreenShared", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function isScreenShared', {
         id: this.id
@@ -445,6 +758,13 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "stopScreenshare", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function stopScreenshare', {
         id: this.id
@@ -453,6 +773,18 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "enableRTCStats", () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function enableRTCStats', {
         id: this.id
@@ -461,6 +793,14 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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
+     */
     _defineProperty(this, "disableRTCStats", () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function disableRTCStats', {
         id: this.id
@@ -485,6 +825,14 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - This wrapper function is used to start streaming device audio, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stream-device-audio-from-the-app} for more info.
+     *
+     * @param {HMSAudioMixingMode}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "startAudioshare", async audioMixingMode => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function startAudioshare', {
         id: this.id,
@@ -500,6 +848,13 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function returns true if audio is being shared and vice versa, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-get-audio-share-status} for more info.
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "isAudioShared", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function isAudioShared', {
         id: this.id
@@ -513,6 +868,13 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function is used to stop streaming device audio, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stop-audio-sharing} for more info.
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "stopAudioshare", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function stopAudioshare', {
         id: this.id
@@ -526,6 +888,12 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function returns the current audio mixing mode, currently available only for android.
+     *
+     * @memberof HMSSDK
+     * @return HMSAudioMixingMode
+     */
     _defineProperty(this, "getAudioMixingMode", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getAudioMixingMode', {
         id: this.id
@@ -539,6 +907,14 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function used to change the mode while the user is streaming audio, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-change-mode} for more info
+     *
+     * @param {HMSAudioMixingMode}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "setAudioMixingMode", async audioMixingMode => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function setAudioMixingMode', {
         id: this.id,
@@ -554,6 +930,15 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function returns the array of audio output devices which is of
+     * type {@link HMSAudioDevice[]}, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-list-of-audio-device} for more info
+     *
+     * @memberof HMSSDK
+     * @return HMSAudioDevice[]
+     */
     _defineProperty(this, "getAudioDevicesList", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getAudioDevicesList', {
         id: this.id
@@ -567,6 +952,15 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function returns the current audio output device which is of
+     * type {@link HMSAudioDevice}, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-current-focussed-device} for more info
+     *
+     * @memberof HMSSDK
+     * @return HMSAudioDevice
+     */
     _defineProperty(this, "getAudioOutputRouteType", async () => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function getAudioOutputRouteType', {
         id: this.id
@@ -580,6 +974,14 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function used to switch output to device other than the default, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#switch-audio-focus-to-another-device} for more info
+     *
+     * @param {HMSAudioDevice}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "switchAudioOutput", audioDevice => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function switchAudioOutput', {
         id: this.id,
@@ -595,6 +997,14 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This wrapper function used to change Audio Mode manually, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-mode-change} for more info
+     *
+     * @param {HMSAudioMode}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "setAudioMode", audioMode => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function setAudioMode', {
         id: this.id,
@@ -610,6 +1020,14 @@ class HMSSDK {
         return 'API currently not available for iOS';
       }
     });
+    /**
+     * - This is a wrapper function which adds a listener which is triggered when audio output device is switched, currently available only for android.
+     *
+     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#adding-a-listener} for more info
+     *
+     * @param {Function}
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "setAudioDeviceChangeListener", callback => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function setAudioDeviceChangeListener', {
         id: this.id
@@ -642,6 +1060,13 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - This is a prototype event listener that takes action and listens for updates related to that particular action
+     *
+     * @param {string} action
+     * @param {*} callback
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "addEventListener", (action, callback) => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function addEventListener', {
         action,
@@ -893,6 +1318,13 @@ class HMSSDK {
         default:
       }
     });
+    /**
+     * - This is a prototype event listener that takes action and listens for updates related to that particular action
+     *
+     * @param {string} action
+     * @param {*} callback
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "removeEventListener", action => {
       _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Function removeEventListener', {
         action,
@@ -1144,6 +1576,11 @@ class HMSSDK {
         default:
       }
     });
+    /**
+     * removes all the listeners
+     *
+     * @memberof HMSSDK
+     */
     _defineProperty(this, "removeAllListeners", () => {
       this.onPreviewDelegate = null;
       this.onJoinDelegate = null;
@@ -1171,6 +1608,20 @@ class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * - 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}.
+     *
+     */
     _defineProperty(this, "onPreviewListener", data => {
       if (data.id !== this.id) {
         return;
@@ -1203,11 +1654,13 @@ class HMSSDK {
       }
     });
     _defineProperty(this, "onRoomListener", data => {
+      var _getHmsRoomCache2;
       if (data.id !== this.id) {
         return;
       }
       const room = _HMSEncoder.HMSEncoder.encodeHmsRoom(data.room, this.id);
       const type = data.type;
+      (_getHmsRoomCache2 = (0, _HMSRoomCache.getHmsRoomCache)()) === null || _getHmsRoomCache2 === void 0 ? void 0 : _getHmsRoomCache2.updateRoomCache(data.room, data.type);
       if (this.onRoomDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener ON_ROOM_LISTENER_CALL', {
           room,
@@ -1219,12 +1672,22 @@ class HMSSDK {
         });
       }
     });
-    _defineProperty(this, "onPeerListener", data => {
-      if (data.id !== this.id) {
-        return;
+    _defineProperty(this, "onPeerListener", peerData => {
+      var _getHmsPeersCache;
+      const data = {
+        peer: peerData,
+        type: null
+      };
+      for (const ordinal of _HMSPeerUpdate.HMSPeerUpdateOrdinals.keys()) {
+        if (ordinal in peerData) {
+          data.peer.peerID = peerData[ordinal];
+          data.type = ordinal;
+          break;
+        }
       }
-      const peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer, this.id);
-      const type = data.type;
+      const peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
+      const type = _HMSEncoder.HMSEncoder.encodeHmsPeerUpdate(data.type) || data.type;
+      (_getHmsPeersCache = (0, _HMSPeersCache.getHmsPeersCache)()) === null || _getHmsPeersCache === void 0 ? void 0 : _getHmsPeersCache.updatePeerCache(data.peer.peerID, data.peer, type);
       if (this.onPeerDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener ON_PEER_LISTENER_CALL', {
           peer,
@@ -1237,12 +1700,16 @@ class HMSSDK {
       }
     });
     _defineProperty(this, "onTrackListener", data => {
+      var _getHmsPeersCache2;
       if (data.id !== this.id) {
         return;
       }
       const track = _HMSEncoder.HMSEncoder.encodeHmsTrack(data.track, this.id);
-      const peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer, this.id);
+      const peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
       const type = data.type;
+      (_getHmsPeersCache2 = (0, _HMSPeersCache.getHmsPeersCache)()) === null || _getHmsPeersCache2 === void 0 ? void 0 : _getHmsPeersCache2.updatePeerCache(data.peer.peerID, {
+        track
+      }, data.type);
       if (this.muteStatus && (data === null || data === void 0 ? void 0 : data.type) === 'TRACK_ADDED' && track.type === _HMSTrackType.HMSTrackType.AUDIO) {
         this.setPlaybackForAllAudio(this.muteStatus);
       }
@@ -1263,7 +1730,7 @@ class HMSSDK {
       if (data.id !== this.id) {
         return;
       }
-      const message = _HMSEncoder.HMSEncoder.encodeHMSMessage(data, this.id);
+      const message = _HMSEncoder.HMSEncoder.encodeHMSMessage(data);
       if (this.onMessageDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener ON_MESSAGE_LISTENER_CALL', message);
         this.onMessageDelegate(message);
@@ -1293,7 +1760,7 @@ class HMSSDK {
         return;
       }
       if (this.onRoleChangeRequestDelegate) {
-        const encodedRoleChangeRequest = _HMSEncoder.HMSEncoder.encodeHmsRoleChangeRequest(data, this.id);
+        const encodedRoleChangeRequest = _HMSEncoder.HMSEncoder.encodeHmsRoleChangeRequest(data);
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener ON_ROLE_CHANGE_LISTENER_CALL', encodedRoleChangeRequest);
         this.onRoleChangeRequestDelegate(encodedRoleChangeRequest);
       }
@@ -1303,7 +1770,7 @@ class HMSSDK {
         return;
       }
       if (this.onChangeTrackStateRequestDelegate) {
-        const encodedRoleChangeRequest = _HMSEncoder.HMSEncoder.encodeHmsChangeTrackStateRequest(data, this.id);
+        const encodedRoleChangeRequest = _HMSEncoder.HMSEncoder.encodeHmsChangeTrackStateRequest(data);
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener ON_CHANGE_TRACK_STATE_REQUEST_LISTENER_CALL', encodedRoleChangeRequest);
         this.onChangeTrackStateRequestDelegate(encodedRoleChangeRequest);
       }
@@ -1316,7 +1783,7 @@ class HMSSDK {
       if (this.onRemovedFromRoomDelegate) {
         let requestedBy = null;
         if (data.requestedBy) {
-          requestedBy = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.requestedBy, this.id);
+          requestedBy = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.requestedBy);
         }
         const reason = data.reason;
         const roomEnded = data.roomEnded;
@@ -1370,7 +1837,7 @@ class HMSSDK {
         return;
       }
       let localAudioStats = new _HMSLocalAudioStats.HMSLocalAudioStats(data.localAudioStats);
-      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer, this.id);
+      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
       let track = _HMSEncoder.HMSEncoder.encodeHmsLocalAudioTrack(data.track, this.id);
       if (this.onLocalAudioStatsDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener onLocalAudioStatsListener_CALL', {
@@ -1392,7 +1859,7 @@ class HMSSDK {
         return;
       }
       let localVideoStats = new _HMSLocalVideoStats.HMSLocalVideoStats(data.localVideoStats);
-      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer, this.id);
+      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
       let track = _HMSEncoder.HMSEncoder.encodeHmsLocalVideoTrack(data.track, this.id);
       if (this.onLocalVideoStatsDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener onLocalVideoStatsListener_CALL', {
@@ -1414,7 +1881,7 @@ class HMSSDK {
         return;
       }
       let remoteAudioStats = new _HMSRemoteAudioStats.HMSRemoteAudioStats(data.remoteAudioStats);
-      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer, this.id);
+      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
       let track = _HMSEncoder.HMSEncoder.encodeHmsRemoteAudioTrack(data.track, this.id);
       if (this.onRemoteAudioStatsDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener onRemoteAudioStatsListener_CALL', {
@@ -1436,7 +1903,7 @@ class HMSSDK {
         return;
       }
       let remoteVideoStats = new _HMSRemoteVideoStats.HMSRemoteVideoStats(data.remoteVideoStats);
-      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer, this.id);
+      let peer = _HMSEncoder.HMSEncoder.encodeHmsPeer(data.peer);
       let track = _HMSEncoder.HMSEncoder.encodeHmsRemoteVideoTrack(data.track, this.id);
       if (this.onRemoteVideoStatsDelegate) {
         _HMSLogger.logger === null || _HMSLogger.logger === void 0 ? void 0 : _HMSLogger.logger.verbose('#Listener onRemoteVideoStatsListener_CALL', {
@@ -1476,6 +1943,14 @@ class HMSSDK {
         });
       }
     });
+    /**
+     * - Updates the logger for this instance of HMSSDK
+     * @param {HMSLogger} hmsLogger
+     * @memberof HMSSDK
+     */
+    _defineProperty(this, "setLogger", hmsLogger => {
+      (0, _HMSLogger.setLogger)(this.id, hmsLogger);
+    });
     this.id = id;
   }
 
@@ -1520,22 +1995,6 @@ class HMSSDK {
     HmsSdk = new HMSSDK(id);
     return HmsSdk;
   }
-
-  /**
-   * - Returns the instance of logger which can be used to manipulate log levels.
-   * @returns @instance HMSLogger
-   * @memberof HMSSDK
-   */
-  static getLogger() {
-    return (0, _HMSLogger.getLogger)();
-  }
-
-  /**
-   * - Updates the logger for this instance of HMSSDK
-   * @param {HMSLogger} hmsLogger
-   * @memberof HMSSDK
-   */
-
   async isPipModeSupported() {
     return HMSManager.handlePipActions('isPipModeSupported', {
       id: this.id
@@ -1553,6 +2012,15 @@ class HMSSDK {
       id: this.id
     });
   }
+
+  /**
+   * - Returns the instance of logger which can be used to manipulate log levels.
+   * @returns @instance HMSLogger
+   * @memberof HMSSDK
+   */
+  static getLogger() {
+    return (0, _HMSLogger.getLogger)();
+  }
 }
 exports.HMSSDK = HMSSDK;
 //# sourceMappingURL=HMSSDK.js.map