@100mslive/react-native-hms 1.10.8 → 1.10.9

package/lib/module/classes/HMSSDK.js

@@ -19,6 +19,19 @@ import { HMSPeerListIterator } from './HMSPeerListIterator';
 import { HMSInteractivityCenter } from './HMSInteractivityCenter';
 const ReactNativeVersion = require('react-native/Libraries/Core/ReactNativeVersion');
 let HmsSdk;
+
+/**
+ * Represents the main SDK class for the 100ms (HMS) video conferencing service in a React Native application.
+ * This class provides methods to manage the video conferencing lifecycle including joining a room, leaving a room,
+ * managing streams, and handling events.
+ *
+ * @export
+ * @class HMSSDK
+ * @example
+ * const hmsInstance = await HMSSDK.build();
+ * await hmsInstance.join({ authToken: 'your_auth_token', username: 'John Appleseed' });
+ * @see https://www.100ms.live/docs/react-native/v2/quickstart/quickstart
+ */
 export class HMSSDK {
   constructor(id) {
     _defineProperty(this, "id", void 0);
@@ -26,6 +39,7 @@ export class HMSSDK {
     _defineProperty(this, "appStateSubscription", void 0);
     _defineProperty(this, "onPreviewDelegate", void 0);
     _defineProperty(this, "onJoinDelegate", void 0);
+    _defineProperty(this, "onPermissionsRequestedDelegate", void 0);
     _defineProperty(this, "onRoomDelegate", void 0);
     _defineProperty(this, "onTranscriptsDelegate", void 0);
     _defineProperty(this, "onPeerDelegate", void 0);
@@ -50,7 +64,20 @@ export class HMSSDK {
     _defineProperty(this, "onPIPModeChangedDelegate", void 0);
     _defineProperty(this, "emitterSubscriptions", {});
     /**
-     * - Calls removeListeners that in turn breaks all connections with native listeners.
+     * Asynchronously destroys the HMSSDK instance.
+     *
+     * - This method performs a series of cleanup actions before destroying the HMSSDK instance.
+     * - It logs the destruction process, clears both the HMS peers and room caches, removes all event listeners to prevent memory leaks, and finally calls the native
+     * `destroy` method on the `HMSManager` with the instance's ID.
+     * - This is typically used to ensure that all resources are properly released when the HMSSDK instance is no longer needed, such as when a user leaves a room or the application is shutting down.
+     *
+     * @returns {Promise<void>} A promise that resolves when the destruction process has completed.
+     * @throws {Error} If the HMSSDK instance cannot be destroyed.
+     *
+     * @example
+     * await hmsInstance.destroy();
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/install-the-sdk/hmssdk
      *
      * @memberof HMSSDK
      */
@@ -66,10 +93,23 @@ export class HMSSDK {
       });
     });
     /**
-     * - 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
-     *
+     * Asynchronously retrieves an authentication token using the room code, user ID, and endpoint.
+     *
+     * This method is responsible for fetching an authentication token that is required to join a room in the HMS ecosystem.
+     * It makes a call to the HMSManager's `getAuthTokenByRoomCode` method, passing in the necessary parameters.
+     * The function logs the attempt and returns the token as a string.
+     *
+     * @param {string} roomCode - The unique code of the room for which the token is being requested.
+     * @param {string} [userId] - Optional. The user ID of the participant requesting the token. This can be used for identifying the user in the backend.
+     * @param {string} [endpoint] - Optional. The endpoint URL to which the token request is sent. This can be used to specify a different authentication server if needed.
+     * @returns {Promise<string>} A promise that resolves to the authentication token as a string.
+     * @throws {Error} If the authentication token cannot be retrieved.
+     * @example
+     * const authToken = await hmsInstance.getAuthTokenByRoomCode('room-code');
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/listen-to-room-updates/get-methods#getauthtokenbyroomcode
+     * @async
+     * @function getAuthTokenByRoomCode
      * @memberof HMSSDK
      */
     _defineProperty(this, "getAuthTokenByRoomCode", async (roomCode, userId, endpoint) => {
@@ -87,12 +127,23 @@ export class HMSSDK {
       });
     });
     /**
-     * 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.
+     * Asynchronously joins a room with the provided configuration
+     *
+     * This method is responsible for initiating the process of joining a room in the HMS ecosystem. It performs several key actions:
+     * - Logs the attempt to join with the provided configuration and instance ID.
+     * - Initializes the peers and room caches for the current session.
+     * - Calls the `join` method on the `HMSManager` with the provided configuration and the instance ID.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/join} for more info
+     * @param {HMSConfig} config - The configuration object required to join a room. This includes credentials, room details, and user information.
+     * @returns {Promise<void>} A promise that resolves when the join operation has been successfully initiated.
+     * @throws {Error} If the join operation cannot be completed.
      *
-     * @param {HMSConfig} config
+     * @example
+     * await hmsInstance.join(hmsConfig);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/join
+     * @async
+     * @function join
      * @memberof HMSSDK
      */
     _defineProperty(this, "join", async config => {
@@ -108,32 +159,61 @@ export class HMSSDK {
       });
     });
     /**
-     * - 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
+     * Initiates a preview for the local peer.
+     *
+     * This function triggers the preview process for the local peer, allowing the application to display
+     * preview tracks (e.g., video or audio tracks) before joining a room. The response from the previewListener
+     * will contain the preview tracks for the local peer, which can be used to render a preview UI.
+     *
+     * @param {HMSConfig} config - The configuration object required for previewing, including credentials and user details.
+     * @example
+     * // Example usage of the preview function
+     * const previewConfig = {
+     *   authToken: "your_auth_token",
+     *   userName: "John Doe",
+     *   roomCode: "your_room_code"
+     * };
+     * hmsInstance.preview(previewConfig);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/features/preview
+     *
+     * @async
+     * @function preview
      * @memberof HMSSDK
      */
-    _defineProperty(this, "preview", config => {
+    _defineProperty(this, "preview", async config => {
       logger === null || logger === void 0 || logger.verbose('#Function preview', {
         config,
         id: this.id
       });
-      HMSManager.preview({
+      await HMSManager.preview({
         ...config,
         id: this.id
       });
     });
     /**
-     * - 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.
-     * - Auto Simulcast to automatically select the best Streaming Quality of track if feature is enabled in Room.
+     * `HmsView` is a React component that renders a video track within a view.
+     *
+     * It utilizes the `HmsViewComponent` to display the media track specified by the `trackId`.
+     * This component is designed to be used with React's `forwardRef` to allow for ref forwarding,
+     * enabling direct interaction with the DOM element.
+     *
+     * Props:
+     * - `trackId`: The unique identifier for the track to be displayed.
+     * - `style`: Custom styles to apply to the view.
+     * - `mirror`: If true, the video will be mirrored; commonly used for local video tracks.
+     * - `scaleType`: Determines how the video fits within the bounds of the view (e.g., aspect fill, aspect fit).
+     * - `setZOrderMediaOverlay`: When true, the video view will be rendered above the regular view hierarchy.
+     * - `autoSimulcast`: Enables automatic simulcast layer switching based on network conditions (if supported).
+     *
+     * @param {Object} props - The properties passed to the HmsView component.
+     * @param {React.Ref} ref - A ref provided by `forwardRef` for accessing the underlying DOM element.
+     * @returns {React.Element} A `HmsViewComponent` element configured with the provided props and ref.
+     * @memberof HMSSDK
+     * @example
+     * <HmsView trackId="track-id" style={{ width: 100, height: 100 }} mirror={true} scaleType="aspectFill" />
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/render-video} for more info
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/overview
      *
      * @param {HmsViewProps}
      * @memberof HMSSDK
@@ -166,10 +246,23 @@ export class HMSSDK {
       HMSEncoder.clearData(); // Clearing cached data in encoder
     });
     /**
-     * Calls leave function of native sdk and session of current user is invalidated.
+     * Asynchronously leaves the current room and performs cleanup.
+     *
+     * This method triggers the leave process for the current user, effectively disconnecting them from the room they are in.
+     * It logs the leave action with the user's ID, calls the native `leave` method in `HMSManager` with the user's ID,
+     * and then performs additional cleanup through `roomLeaveCleanup`. This cleanup includes removing app state subscriptions
+     * and clearing cached data related to peers and the room.
+     *
+     * @returns {Promise<boolean>} A promise that resolves to `true` if the user has successfully left the room, or `false` otherwise.
+     * @throws {Error} If the user cannot leave the room.
+     * @memberof HMSSDK
+     * @example
+     * await hmsInstance.leave();
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/leave} for more info
+     * @see https://www.100ms.live/docs/react-native/v2/features/leave
      *
+     * @async
+     * @function leave
      * @memberof HMSSDK
      */
     _defineProperty(this, "leave", async () => {
@@ -184,13 +277,28 @@ export class HMSSDK {
       return op;
     });
     /**
-     * - This function sends message to all the peers in the room, the get the message in onMessage listener.
+     * Sends a broadcast message to all peers in the room.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/chat} for more info
+     * This asynchronous function sends a message to all peers in the room, which they can receive through the `onMessage` listener.
+     * It can be used to send chat messages or custom types of messages like emoji reactions or notifications.
      *
+     * @param {string} message - The message to be sent to all peers.
+     * @param {string} [type='chat'] - The type of the message. Default is 'chat'. Custom types can be used for specific purposes.
+     * @returns {Promise<{messageId: string | undefined}>} A promise that resolves with the message ID of the sent message, or undefined if the message could not be sent.
+     *
+     * @example
+     * // Sending a chat message to all peers
+     * await hmsInstance.sendBroadcastMessage("Hello everyone!", "chat");
+     *
+     * @example
+     * // Sending a custom notification to all peers
+     * await hmsInstance.sendBroadcastMessage("Meeting starts in 5 minutes", "notification");
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/chat
+     *
+     * @async
+     * @function sendBroadcastMessage
      * @memberof HMSSDK
-     * @param message the message that is to be sent
-     * @param type the default type is set to CHAT. You can pass a custom type here for sending events like Emoji Reactions, Notifications, etc
      */
     _defineProperty(this, "sendBroadcastMessage", async (message, type = 'chat') => {
       logger === null || logger === void 0 || logger.verbose('#Function sendBroadcastMessage', {
@@ -206,11 +314,25 @@ export class HMSSDK {
       return data;
     });
     /**
-     * - sendGroupMessage sends a message to specific set of roles, whoever has any of those role in room
-     * will get the message in onMessage listener.
+     * Sends a message to a specific set of roles within the room.
+     *
+     * This method allows for targeted communication by sending a message to peers who have any of the specified roles.
+     * The message is received by the peers through the `onMessage` listener. This can be useful for sending announcements,
+     * instructions, or other types of messages to a subset of the room based on their roles.
+     *
+     * @param {string} message - The message to be sent.
+     * @param {HMSRole[]} roles - An array of roles to which the message will be sent. Peers with these roles will receive the message.
+     * @param {string} [type='chat'] - The type of the message. Defaults to 'chat'. Custom types can be used for specific messaging scenarios.
+     * @returns {Promise<{messageId: string | undefined}>} A promise that resolves with an object containing the `messageId` of the sent message. If the message could not be sent, `messageId` will be `undefined`.
+     *
+     * @example
+     * // Sending a message to all peers with the role of 'moderator'
+     * await hmsInstance.sendGroupMessage("Please start the meeting.", [moderator]);
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/chat} for more info
+     * @see https://www.100ms.live/docs/react-native/v2/features/chat
      *
+     * @async
+     * @function sendGroupMessage
      * @memberof HMSSDK
      */
     _defineProperty(this, "sendGroupMessage", async (message, roles, type = 'chat') => {
@@ -229,11 +351,27 @@ export class HMSSDK {
       return data;
     });
     /**
-     * - sendDirectMessage sends a private message to a single peer, only that peer will get the message
-     * in onMessage Listener.
+     * Sends a direct message to a specific peer in the room.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/chat} for more info
+     * This method allows sending a private message to a single peer, ensuring that only the specified recipient can receive and view the message.
+     * The message is delivered to the recipient through the `onMessage` listener. This functionality is useful for implementing private chat features
+     * within a larger group chat context.
      *
+     * @param {string} message - The message text to be sent.
+     * @param {HMSPeer} peer - The peer object representing the recipient of the message.
+     * @param {string} [type='chat'] - The type of the message being sent. Defaults to 'chat'. This can be customized to differentiate between various message types (e.g., 'private', 'system').
+     * @returns {Promise<{messageId: string | undefined}>} A promise that resolves with an object containing the `messageId` of the sent message. If the message could not be sent, `messageId` will be `undefined`.
+     * @throws {Error} Throws an error if the message could not be sent.
+     *
+     * @example
+     * // Sending a private chat message to a specific peer
+     * const peer = { peerID: 'peer123', ... };
+     * await hmsInstance.sendDirectMessage("Hello, this is a private message.", peer, "chat");
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/features/chat
+     *
+     * @async
+     * @function sendDirectMessage
      * @memberof HMSSDK
      */
     _defineProperty(this, "sendDirectMessage", async (message, peer, type = 'chat') => {
@@ -252,15 +390,24 @@ export class HMSSDK {
       return data;
     });
     /**
-     * - 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}
+     * Asynchronously changes the metadata for the local peer.
+     *
+     * This method updates the metadata field of the local peer in the room. The metadata is a versatile field that can be used
+     * to store various information such as the peer's current status (e.g., raising hand, be right back, etc.). It is recommended
+     * to use a JSON object in string format to store multiple data points within the metadata. This allows for a structured and
+     * easily parseable format for metadata management.
+     *
+     * @param {string} metadata - The new metadata in string format. It is advised to use a JSON string for structured data.
+     * @returns {Promise<void>} A promise that resolves when the metadata has been successfully changed.
+     * @throws {Error} Throws an error if the metadata change operation fails.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-metadata
+     * @example
+     * // Changing metadata to indicate the peer is raising their hand
+     * const newMetadata = JSON.stringify({ status: 'raiseHand' });
+     * await hmsInstance.changeMetadata(newMetadata);
+     *
+     * @async
+     * @function changeMetadata
      * @memberof HMSSDK
      */
     _defineProperty(this, "changeMetadata", async metadata => {
@@ -274,12 +421,28 @@ export class HMSSDK {
       });
     });
     /**
-     * - 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
-     *
+     * Initiates RTMP streaming or recording based on the provided configuration.
+     *
+     * This method starts RTMP streaming or recording by taking a configuration object of type HMSRTMPConfig.
+     * The configuration specifies the URLs for streaming and whether recording should be enabled. The response to this
+     * operation can be observed in the `onRoomUpdate` event, specifically when the `RTMP_STREAMING_STATE_UPDATED` action is triggered.
+     *
+     * @param {HMSRTMPConfig} data - The configuration object for RTMP streaming or recording. It includes streaming URLs and recording settings.
+     * @returns {Promise<any>} A promise that resolves with the operation result when the streaming or recording starts successfully.
+     * @throws {Error} Throws an error if the operation fails or the configuration is invalid.
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/recording
+     *
+     * @example
+     * const rtmpConfig = {
+     *   meetingURL: "https://meet.example.com/myMeeting",
+     *   rtmpURLs: ["rtmp://live.twitch.tv/app", "rtmp://a.rtmp.youtube.com/live2"],
+     *   record: true,
+     *   resolution: { width: 1280, height: 720 }
+     * };
+     * await hmsInstance.startRTMPOrRecording(rtmpConfig);
+     * @async
+     * @function startRTMPOrRecording
      * @memberof HMSSDK
      */
     _defineProperty(this, "startRTMPOrRecording", async data => {
@@ -294,12 +457,19 @@ export 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.
+     * Stops all ongoing RTMP streaming and recording.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/recording} for more info
+     * This function is responsible for halting any active RTMP streaming or recording sessions.
+     * It communicates with the native `HMSManager` module to execute the stop operation.
+     * The completion or status of this operation can be monitored through the `onRoomUpdate` event, specifically when the `RTMP_STREAMING_STATE_UPDATED` action is triggered, indicating that the streaming or recording has been successfully stopped.
      *
+     * @async
+     * @function stopRtmpAndRecording
+     * @returns {Promise<any>} A promise that resolves when the RTMP streaming and recording have been successfully stopped.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/recording
      * @memberof HMSSDK
+     * @example
+     * await hmsInstance.stopRtmpAndRecording();
      */
     _defineProperty(this, "stopRtmpAndRecording", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function stopRtmpAndRecording', {});
@@ -309,13 +479,21 @@ export 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}
+     * Initiates HLS (HTTP Live Streaming) based on the provided configuration.
+     *
+     * This asynchronous function starts HLS streaming, allowing for live video content to be delivered over the internet in a scalable manner.
+     * The function takes an optional `HMSHLSConfig` object as a parameter, which includes settings such as the meeting URL, HLS variant parameters, and recording settings.
+     * The operation's response can be observed through the `onRoomUpdate` event, specifically when the `HLS_STREAMING_STATE_UPDATED` action is triggered, indicating the streaming state has been updated.
+     *
+     * @param {HMSHLSConfig} [data] - Optional configuration object for HLS streaming. Defines parameters such as meeting URL, HLS variants, and recording options.
+     * @returns {Promise<any>} A promise that resolves when the HLS streaming starts successfully. The promise resolves with the operation result.
+     * @throws {Error} Throws an error if the operation fails or if the provided configuration is invalid.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/hls
+     * @async
+     * @function startHLSStreaming
      * @memberof HMSSDK
+     * @example
+     * await hmsInstance.startHLSStreaming();
      */
     _defineProperty(this, "startHLSStreaming", async data => {
       logger === null || logger === void 0 || logger.verbose('#Function startHLSStreaming', {
@@ -328,12 +506,19 @@ export class HMSSDK {
       });
     });
     /**
-     * - stopHLSStreaming function stops the ongoing HLSStreams.
-     * - we get the response of this function in onRoomUpdate as HLS_STREAMING_STATE_UPDATED.
+     * Stops the ongoing HLS (HTTP Live Streaming) streams.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/hls-streaming} for more info
+     * This asynchronous function is responsible for stopping any active HLS streaming sessions.
+     * It communicates with the native `HMSManager` module to execute the stop operation.
+     * The completion or status of this operation can be observed through the `onRoomUpdate` event, specifically when the `HLS_STREAMING_STATE_UPDATED` action is triggered, indicating that the HLS streaming has been successfully stopped.
      *
+     * @async
+     * @function stopHLSStreaming
+     * @returns {Promise<void>} A promise that resolves when the HLS streaming has been successfully stopped.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/hls for more details on HLS streaming.
      * @memberof HMSSDK
+     * @example
+     * await hmsInstance.stopHLSStreaming();
      */
     _defineProperty(this, "stopHLSStreaming", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function stopHLSStreaming', {});
@@ -342,9 +527,25 @@ export class HMSSDK {
       });
     });
     /**
-     * send timed metadata for HLS player
-     * @param metadata list of {@link HMSHLSTimedMetadata} to be sent
-     * @returns Promise<boolean>
+     * Sends timed metadata for HLS (HTTP Live Streaming) playback.
+     *
+     * This asynchronous function is designed to send metadata that can be synchronized with the HLS video playback.
+     * The metadata is sent to all viewers of the HLS stream, allowing for a variety of use cases such as displaying
+     * song titles, ads, or other information at specific times during the stream.
+     * The metadata should be an array of HMSHLSTimedMetadata objects, each specifying the content and timing for the metadata display.
+     *
+     * @async
+     * @function sendHLSTimedMetadata
+     * @param {HMSHLSTimedMetadata[]} metadata - An array of metadata objects to be sent.
+     * @returns {Promise<boolean>} A promise that resolves to `true` if the metadata was successfully sent, or `false` otherwise.
+     * @example
+     * const metadata = [
+     *   { time: 10, data: "Song: Example Song Title" },
+     *   { time: 20, data: "Advertisement: Buy Now!" }
+     * ];
+     * await hmsInstance.sendHLSTimedMetadata(metadata);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/hls-player#how-to-use-hls-timed-metadata-with-100ms-hls-player
      */
     _defineProperty(this, "sendHLSTimedMetadata", async metadata => {
       const data = {
@@ -355,19 +556,26 @@ export class HMSSDK {
       return await HMSManager.sendHLSTimedMetadata(data);
     });
     /**
-     * @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
-     *
+     * Deprecated. Changes the role of a specified peer within the room.
+     *
+     * This function is marked as deprecated and should not be used in new implementations. Use `changeRoleOfPeer` instead.
+     * It allows for the dynamic adjustment of a peer's permissions and capabilities within the room by changing their role.
+     * The role change can be enforced immediately or offered to the peer as a request, depending on the `force` parameter.
+     *
+     * @deprecated Since version 1.1.0. Use `changeRoleOfPeer` instead.
+     * @param {HMSPeer} peer - The peer whose role is to be changed.
+     * @param {HMSRole} role - The new role to be assigned to the peer.
+     * @param {boolean} [force=false] - If `true`, the role change is applied immediately without the peer's consent. If `false`, the peer receives a role change request.
+     * @returns {Promise<void>} A promise that resolves when the role change operation is complete.
+     * @throws {Error} Throws an error if the operation fails.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role
+     * @example
+     * // Change the role of a peer to 'viewer' forcefully
+     * const peer = { peerID: 'peer123', ... };
+     * const newRole = { name: 'viewer', ... };
+     * await hmsInstance.changeRole(peer, newRole, true);
+     * @async
+     * @function changeRole
      * @memberof HMSSDK
      */
     _defineProperty(this, "changeRole", async (peer, role, force = false) => {
@@ -381,17 +589,29 @@ export class HMSSDK {
       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
-     *
+     * Asynchronously changes the role of a specified peer within the room.
+     *
+     * This function is designed to dynamically adjust a peer's permissions and capabilities within the room by changing their role.
+     * It can enforce the role change immediately or offer it to the peer as a request, depending on the `force` parameter.
+     * If the role change is forced, it is applied immediately without the peer's consent. Otherwise, the peer receives a role change request,
+     * which can be accepted or declined. This functionality supports flexible room management and control over participant permissions.
+     *
+     * @async
+     * @function changeRoleOfPeer
+     * @param {HMSPeer} peer - The peer whose role is to be changed.
+     * @param {HMSRole} role - The new role to be assigned to the peer.
+     * @param {boolean} [force=false] - Determines whether the role change should be applied immediately (`true`) or sent as a request (`false`).
+     * @returns {Promise<void>} A promise that resolves to `true` if the role change operation is successful, or `false` otherwise.
+     * @throws {Error} Throws an error if the operation fails.
+     * @see  https://www.100ms.live/docs/react-native/v2/features/change-role
+     * @example
+     * // Change the role of a peer to 'viewer' forcefully
+     * const peer = { peerID: 'peer123', ... };
+     * const newRole = { name: 'viewer', ... };
+     * await hmsInstance.changeRoleOfPeer(peer, newRole, true);
+     *
+     * @async
+     * @function changeRoleOfPeer
      * @memberof HMSSDK
      */
     _defineProperty(this, "changeRoleOfPeer", async (peer, role, force = false) => {
@@ -405,15 +625,25 @@ export class HMSSDK {
       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
+     * Asynchronously changes the roles of multiple peers within the room.
+     *
+     * This function is designed to batch update the roles of peers based on their current roles. It is particularly useful
+     * in scenarios where a group of users need to be granted or restricted permissions en masse, such as promoting all viewers
+     * to participants or demoting all speakers to viewers. The function updates the roles of all peers that have any of the specified
+     * `ofRoles` to the new `toRole` without requiring individual consent, bypassing the `roleChangeRequest` listener on the peer's end.
+     *
+     * @async
+     * @function changeRoleOfPeersWithRoles
+     * @param {HMSRole[]} ofRoles - An array of roles to identify the peers whose roles are to be changed.
+     * @param {HMSRole} toRole - The new role to be assigned to the identified peers.
+     * @returns {Promise<void>} A promise that resolves when the role change operation is complete.
+     * @throws {Error} Throws an error if the operation fails.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role
+     * @example
+     * // Change the role of all peers with 'viewer' role to 'participant'
+     * const viewerRole = { name: 'viewer', ... };
+     * const participantRole = { name: 'participant', ... };
+     * await hmsInstance.changeRoleOfPeersWithRoles([viewerRole], participantRole);
      *
      * @memberof HMSSDK
      */
@@ -427,13 +657,33 @@ export class HMSSDK {
       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.
+     * Asynchronously changes the mute state of a specified track.
+     *
+     * This function is designed to control the mute state of any track (audio or video) within the room.
+     * When invoked, it sends a request to the HMSManager to change the mute state of the specified track.
+     * The targeted peer, whose track is being manipulated, will receive a callback on the `onChangeTrackStateRequestListener`,
+     * allowing for custom handling or UI updates based on the mute state change.
+     *
+     * @async
+     * @function changeTrackState
+     * @param {HMSTrack} track - The track object whose mute state is to be changed.
+     * @param {boolean} mute - The desired mute state of the track. `true` to mute the track, `false` to unmute.
+     * @returns {Promise<void>} A promise that resolves when the operation to change the track's mute state is complete.
+     * @throws {Error} Throws an error if the operation fails or the track cannot be found.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/remote-mute
+     * @async
+     * @function changeTrackState
+     * @memberof HMSSDK
      *
-     * * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-track-state} for more info
+     * @example
+     * // Mute a specific track
+     * const trackToMute = { trackId: 'track123', ... };
+     * await hmsInstance.changeTrackState(trackToMute, true);
      *
-     * @param {HMSTrack}
-     * @memberof HMSSDK
+     * @example
+     * // Unmute a specific track
+     * const trackToUnmute = { trackId: 'track456', ... };
+     * await hmsInstance.changeTrackState(trackToUnmute, false);
      */
     _defineProperty(this, "changeTrackState", async (track, mute) => {
       logger === null || logger === void 0 || logger.verbose('#Function changeTrackState', {
@@ -449,12 +699,30 @@ export 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.
-     *
+     * Asynchronously changes the mute state of tracks for peers with specified roles.
+     *
+     * This method extends the functionality of `changeTrackState` by allowing the mute state of all tracks (audio, video, etc.)
+     * belonging to peers with certain roles to be changed in a single operation. It is particularly useful for managing the audio
+     * and video state of groups of users, such as muting all participants except the speaker in a conference call.
+     *
+     * The peers whose track states are being changed will receive a callback on `onChangeTrackStateRequestListener`, allowing for
+     * custom handling or UI updates based on the mute state change.
+     *
+     * @async
+     * @function changeTrackStateForRoles
+     * @param {boolean} mute - The desired mute state of the tracks. `true` to mute, `false` to unmute.
+     * @param {HMSTrackType} [type] - Optional. The type of the tracks to be muted/unmuted (e.g., audio, video).
+     * @param {string} [source] - Optional. The source of the track (e.g., camera, screen).
+     * @param {Array<HMSRole>} [roles] - The roles of the peers whose tracks are to be muted/unmuted. If not specified, affects all roles.
+     * @returns {Promise<void>} A promise that resolves when the operation to change the track's mute state is complete.
+     * @throws {Error} Throws an error if the operation fails.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/change-track-state-roles
      * @memberof HMSSDK
+     *
+     * @example
+     * // Mute all audio tracks for peers with the role of 'viewer'
+     * const viewerRole = { name: 'viewer', ... };
+     * await hmsInstance.changeTrackStateForRoles(true, 'audio', undefined, [viewerRole]);
      */
     _defineProperty(this, "changeTrackStateForRoles", async (mute, type, source, roles) => {
       let roleNames = null;
@@ -478,11 +746,27 @@ export 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}.
+     * Asynchronously removes a peer from the room.
+     *
+     * This method forcefully disconnects a specified peer from the room.
+     * Upon successful removal, the removed peer will receive a callback through the `onRemovedFromRoomListener`, indicating
+     * they have been removed from the room.
+     * This can be used for managing room participants, such as removing disruptive users or managing room capacity.
+     *
+     * @param {HMSPeer} peer - The peer object representing the participant to be removed.
+     * @param {string} reason - A string detailing the reason for the removal. This reason is communicated
+     *                          to the removed peer, providing context for the action.
+     * @returns {Promise<void>} A promise that resolves when the peer has been successfully removed.
+     *                          If the operation fails, the promise will reject with an error.
+     *
+     * @example
+     * // Assuming `peer` is an instance of HMSPeer representing the participant to remove
+     * await hmsInstance.removePeer(peer, "Violation of room rules");
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/remove-peer} for more info
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/remove-peer
      *
+     * @async
+     * @function removePeer
      * @memberof HMSSDK
      */
     _defineProperty(this, "removePeer", async (peer, reason) => {
@@ -499,12 +783,25 @@ export 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}.
+     * Asynchronously ends the current room session for all participants.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/end-room} for more info
+     * This method is used to programmatically end the current room session, effectively disconnecting all participants.
+     * It can also optionally lock the room to prevent new participants from joining. This is particularly useful for
+     * managing the end of scheduled events or meetings, ensuring that all participants are removed at the same time.
+     * Upon successful execution, all participants will receive a notification through the `onRemovedFromRoomListener`
+     * indicating that they have been removed from the room.
      *
+     * @param {string} reason - A descriptive reason for ending the room session. This reason is communicated to all participants.
+     * @param {boolean} [lock=false] - Optional. Specifies whether the room should be locked after ending the session. Default is `false`.
+     * @returns {Promise<void>} A promise that resolves when the room has been successfully ended and, optionally, locked.
+     *
+     * @example
+     * // End the room and lock it to prevent rejoining
+     * await hmsInstance.endRoom("Meeting concluded", true);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/room/end-room
+     * @async
+     * @function endRoom
      * @memberof HMSSDK
      */
     _defineProperty(this, "endRoom", async (reason, lock = false) => {
@@ -521,11 +818,23 @@ export class HMSSDK {
       return await HMSManager.endRoom(data);
     });
     /**
-     * - This function can be used to change name of localPeer.
+     * Asynchronously changes the name of the local peer.
+     *
+     * This function updates the name of the local peer in the room. It is useful for scenarios where a user's display name needs to be updated during a session, such as when a user decides to change their nickname or when correcting a typo in the user's name. The updated name is reflected across all participants in the room.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-name} for more info
+     * Once the name change is successful, all the peers receive HMSUpdateListenerActions.ON_PEER_UPDATE event with HMSPeerUpdate.NAME_CHANGED as update type. When this event is received, the UI for that peer should be updated.
      *
+     * @param {string} name - The new name to be set for the local peer.
+     * @returns {Promise<void>} A promise that resolves when the name change operation has been successfully completed.
+     * @throws {Error} Throws an error if the name change operation fails.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-name for more information on changing the peer's name.
+     * @async
+     * @function changeName
      * @memberof HMSSDK
+     *
+     * @example
+     * // Change the name of the local peer to 'Alice'
+     * await hmsInstance.changeName("Alice");
      */
     _defineProperty(this, "changeName", async name => {
       logger === null || logger === void 0 || logger.verbose('#Function changeName', {
@@ -539,13 +848,22 @@ export class HMSSDK {
       return await HMSManager.changeName(data);
     });
     /**
-     * -Preview for a specific Role before changing it.
+     * Asynchronously previews the audio and video tracks for a specific role before applying the role change.
+     *
+     * This method allows users to preview the expected audio and video tracks that will be visible to other peers in the room
+     * after changing their role. It is useful for scenarios where a user wants to understand the impact of a role change on their
+     * media tracks before making the change. This can help in ensuring that the right media settings are applied for the new role.
      *
-     * By previewing before doing a Role Change, users can see their expected Audio & Video tracks which will be visible to other Peers in Room post changing the Role.
+     * @param {string} role - The role for which the preview is requested. The role should be defined within the room's role configurations.
+     * @returns {Promise<any>} A promise that resolves with the preview tracks information. The resolved object contains details about the audio and video tracks that would be available to the user if the role were changed to the specified role.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role} for more info
+     * @example
+     * // Preview the tracks for the 'speaker' role
+     * const previewTracks = await hmsInstance.previewForRole('speaker');
+     * console.log(previewTracks);
      *
-     * @param {role: string}
+     * @async
+     * @function previewForRole
      * @memberof HMSSDK
      */
     _defineProperty(this, "previewForRole", async role => {
@@ -561,13 +879,22 @@ export class HMSSDK {
       return previewTracks;
     });
     /**
-     * Cancel the Previewing for Role invocation.
+     * Asynchronously cancels the preview for a role change.
      *
-     * If a [previewForRole] call was performed previously then calling this method clears the tracks created anticipating a Change of Role
-     *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role} for more info
+     * This method is intended to be used after a `previewForRole` invocation. It cancels the ongoing preview operation,
+     * effectively clearing any tracks that were created in anticipation of a role change. This is useful in scenarios where
+     * a role change preview was initiated but needs to be aborted before the actual role change occurs, allowing for clean
+     * state management and resource cleanup.
      *
+     * @async
+     * @function cancelPreview
      * @memberof HMSSDK
+     * @returns {Promise<{data: string}>} A promise that resolves with an object containing a data string.
+     *
+     * @example
+     * // Cancel a previously initiated role change preview
+     * await hmsInstance.cancelPreview();
+     *
      */
     _defineProperty(this, "cancelPreview", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function cancelPreview', {
@@ -579,11 +906,25 @@ export class HMSSDK {
       return data;
     });
     /**
-     * - Calling this function will accept the most recent roleChange request made by anyone in the room
+     * Asynchronously accepts a role change request for the local peer.
+     *
+     * This method is used when a role change request has been made to the local peer, typically by an admin or moderator of the room.
+     * Invoking this method signals acceptance of the new role, and the role change is applied to the local peer. This can affect the peer's
+     * permissions and capabilities within the room, such as the ability to send video, audio, or chat messages.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/change-role} for more info
+     * The successful execution of this method triggers an update across the room, notifying other peers of the role change.
+     * It is important to handle this method's response to ensure the local UI reflects the new role's permissions and capabilities.
      *
+     * @async
+     * @function acceptRoleChange
      * @memberof HMSSDK
+     * @returns {Promise<void>} A promise that resolves when the role change has been successfully accepted and applied.
+     * @throws {Error} Throws an error if the role change acceptance operation fails.
+     * @example
+     * // Accept a role change request to become a 'moderator'
+     * await hmsInstance.acceptRoleChange();
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-role
      */
     _defineProperty(this, "acceptRoleChange", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function acceptRoleChange', {
@@ -594,27 +935,54 @@ export class HMSSDK {
       });
     });
     /**
-     * - 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.
+     * Sets the mute status for all remote audio tracks in the room for the local peer.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/playback-allowed} for more info
+     * This method allows the local user to mute or unmute the playback of all remote audio tracks in the room.
+     * It affects only the local peer's audio playback and does not impact other peers. This can be useful in scenarios
+     * where a user needs to quickly mute all incoming audio without affecting the audio state for other participants in the room.
      *
+     * @param {boolean} mute - A boolean value indicating whether to mute (`true`) or unmute (`false`) all remote audio tracks for the local peer.
+     * @returns {Promise<boolean>} A promise that resolves with a boolean value indicating the success of the operation.
+     * @throws {Error} Throws an error if the operation fails.
+     * @async
+     * @function setPlaybackForAllAudio
      * @memberof HMSSDK
+     * @example
+     * // Mute all remote audio tracks for the local peer
+     * hmsInstance.setPlaybackForAllAudio(true);
+     *
+     * @example
+     * // Unmute all remote audio tracks for the local peer
+     * hmsInstance.setPlaybackForAllAudio(false);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/playback-allowed
      */
-    _defineProperty(this, "setPlaybackForAllAudio", mute => {
+    _defineProperty(this, "setPlaybackForAllAudio", async mute => {
       logger === null || logger === void 0 || logger.verbose('#Function setPlaybackForAllAudio', {
         mute,
         id: this.id
       });
-      HMSManager.setPlaybackForAllAudio({
+      return await HMSManager.setPlaybackForAllAudio({
         mute,
         id: this.id
       });
     });
     /**
-     * - This function mutes audio for all peers in the room.
+     * Mutes the audio for all peers in the room.
      *
+     * This asynchronous function communicates with the native `HMSManager` module to mute the audio tracks of all remote peers in the room.
+     * It is particularly useful in scenarios where a moderator needs to quickly mute all participants to prevent background noise or interruptions during a session.
+     *
+     * @async
+     * @function remoteMuteAllAudio
      * @memberof HMSSDK
+     * @returns {Promise<{success: boolean}>} A promise that resolves with a boolean value indicating the success of the operation.
+     * @throws {Error} Throws an error if the operation fails.
+     * @example
+     * // Mute all remote audio tracks in the room
+     * await hmsInstance.remoteMuteAllAudio();
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/remote-mute
      */
     _defineProperty(this, "remoteMuteAllAudio", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function remoteMuteAllAudio', {
@@ -625,13 +993,23 @@ export class HMSSDK {
       });
     });
     /**
-     * - getRoom is a wrapper function on an existing native function also known as getRoom the returns
-     * current room object which is of type {@link HMSRoom}
+     * Retrieves the current room's details.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/join#get-room} for more info
+     * This method acts as a wrapper around the native `getRoom` function, providing an easy way to obtain the current room's state and details,
+     * including participants, tracks, and other relevant information. The room object is fetched from the native module and then processed
+     * to match the expected format in the React Native layer. This method is useful for getting the room's state at any point in time, such as
+     * when needing to display current room information or for debugging purposes.
      *
+     * @async
+     * @function getRoom
      * @memberof HMSSDK
-     * @return Promise<HMSRoom>
+     * @returns {Promise<HMSRoom>} A promise that resolves to the current room object.
+     * @example
+     * // Fetch the current room details
+     * const roomDetails = await hmsInstance.getRoom();
+     * console.log(roomDetails);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/listen-to-room-updates/get-methods
      */
     _defineProperty(this, "getRoom", async () => {
       var _getHmsRoomCache;
@@ -646,11 +1024,23 @@ export class HMSSDK {
       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}
+     * Retrieves the current local peer's details.
+     *
+     * This asynchronous method wraps around the native `getLocalPeer` function, providing a straightforward way to obtain the current local peer's details,
+     * including their ID, name, role, and any tracks they may be publishing. The local peer object is fetched from the native module and then processed
+     * to match the expected format in the React Native layer. This method is particularly useful for operations that require information about the local user,
+     * such as updating UI elements to reflect the current user's status or for debugging purposes.
      *
+     * @async
+     * @function getLocalPeer
      * @memberof HMSSDK
-     * @return Promise<HMSLocalPeer>
+     * @returns {Promise<HMSLocalPeer>} A promise that resolves to the current local peer object.
+     * @example
+     * // Fetch the current local peer's details
+     * const localPeerDetails = await hmsInstance.getLocalPeer();
+     * console.log(localPeerDetails);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/listen-to-room-updates/get-methods
      */
     _defineProperty(this, "getLocalPeer", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function getLocalPeer', {
@@ -663,11 +1053,22 @@ export class HMSSDK {
       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}
+     * Retrieves an array of remote peers currently in the room.
+     *
+     * This asynchronous method serves as a wrapper around the native `getRemotePeers` function, facilitating the retrieval of remote peers' details.
+     * It fetches an array of `HMSRemotePeer` objects, each representing a remote participant in the room. The method processes the fetched data
+     * to conform to the expected format in the React Native layer, making it suitable for UI rendering or further processing.
      *
+     * @async
+     * @function getRemotePeers
      * @memberof HMSSDK
-     * @return Promise<HMSRemotePeer[]>
+     * @returns {Promise<HMSRemotePeer[]>} A promise that resolves with an array of `HMSRemotePeer` objects, representing the remote peers in the room.
+     * @example
+     * // Fetch the list of remote peers in the room
+     * const remotePeers = await hmsInstance.getRemotePeers();
+     * console.log(remotePeers);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/listen-to-room-updates/get-methods
      */
     _defineProperty(this, "getRemotePeers", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function getRemotePeers', {
@@ -680,11 +1081,22 @@ export class HMSSDK {
       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}
+     * Retrieves a list of all roles currently available in the room.
+     *
+     * This asynchronous method calls the native `getRoles` function to fetch an array of `HMSRole` objects, representing the roles defined for the room.
+     * Each `HMSRole` object includes details such as the role name, permissions, and other role-specific settings. The roles are then processed
+     * to match the expected format in the React Native layer. This method is useful for operations that require a comprehensive list of roles,
+     * such as displaying role options in a UI dropdown for role assignment or for role-based access control checks.
      *
+     * @async
+     * @function getRoles
      * @memberof HMSSDK
-     * @return Promise<HMSRole[]>
+     * @returns {Promise<HMSRole[]>} A promise that resolves with an array of `HMSRole` objects, representing the available roles in the room.
+     *
+     * @example
+     * // Fetch the list of available roles in the room
+     * const roles = await hmsInstance.getRoles();
+     * console.log(roles);
      */
     _defineProperty(this, "getRoles", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function getRoles', {
@@ -697,30 +1109,56 @@ export class HMSSDK {
       return encodedRoles;
     });
     /**
-     * - This function sets the volume of any peer in the room
+     * Sets the volume for a specific track of any peer in the room.
+     *
+     * This function allows the adjustment of the playback volume for any given audio track of a peer within the room.
+     * It is particularly useful for controlling the audio levels of individual participants in a conference call or meeting.
+     * The volume level is specified as a number. Volume level can vary from 0(min) to 10(max). The default value for volume is 1.0.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/advanced-features/set-volume} for more info
+     * @param {HMSTrack} track - The track object whose volume is to be set. This object must include a valid `trackId`.
+     * @param {number} volume - The volume level to set for the specified track.
+     * @returns {Promise<void>} A promise that resolves when the operation to set the track's volume is complete.
+     * @throws {Error} Throws an error if the operation fails or the track cannot be found.
      *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/track/set-volume
+     *
+     * @async
      * @memberof HMSSDK
+     *
+     * @example
+     * // Assuming `track` is an instance of HMSTrack representing the participant's audio track
+     * hmsInstance.setVolume(track, 10);
      */
-    _defineProperty(this, "setVolume", (track, volume) => {
+    _defineProperty(this, "setVolume", async (track, volume) => {
       logger === null || logger === void 0 || logger.verbose('#Function setVolume', {
         track,
         volume,
         id: this.id
       });
-      HMSManager.setVolume({
+      return await HMSManager.setVolume({
         id: this.id,
         trackId: track.trackId,
         volume
       });
     });
     /**
-     * - This function is used to start screenshare, currently available only for android
+     * Initiates screen sharing in the room.
+     *
+     * This asynchronous function triggers the screen sharing feature, allowing the local peer to share their screen with other participants in the room.
+     * Upon successful execution, other participants in the room will be able to see the shared screen as part of the video conference.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/screenshare} for more info
+     * Note: Proper permissions must be granted by the user for screen sharing to work. Ensure to handle permission requests appropriately in your application.
      *
+     * @async
+     * @function startScreenshare
      * @memberof HMSSDK
+     * @returns {Promise<void>} A promise that resolves when the screen sharing has successfully started.
+     * @throws {Error} Throws an error if the operation fails or screen sharing cannot be initiated.
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/screenshare
+     * @example
+     * // Start screen sharing
+     * await hmsInstance.startScreenshare();
      */
     _defineProperty(this, "startScreenshare", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function startScreenshare', {
@@ -731,11 +1169,22 @@ export class HMSSDK {
       });
     });
     /**
-     * - Returns a boolean stating if the screen is currently shared or not
+     * Checks if the screen sharing is currently active in the room.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/screenshare} for more info
+     * This asynchronous method queries the native `HMSManager` module to determine if the screen is currently being shared by the local peer in the room.
+     * It returns a promise that resolves to a boolean value, indicating the screen sharing status. `true` signifies that the screen sharing is active,
+     * while `false` indicates that it is not. This method can be used to toggle UI elements or to decide whether to start or stop screen sharing based on the current state.
      *
+     * @async
+     * @function isScreenShared
      * @memberof HMSSDK
+     * @returns {Promise<boolean>} A promise that resolves to a boolean indicating whether the screen is currently shared.
+     * @example
+     * // Check if the screen is currently shared
+     * const isShared = await hmsInstance.isScreenShared();
+     * console.log(isShared ? "Screen is being shared" : "Screen is not being shared");
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/screenshare
      */
     _defineProperty(this, "isScreenShared", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function isScreenShared', {
@@ -746,11 +1195,25 @@ export class HMSSDK {
       });
     });
     /**
-     * - stops the screenShare, currently available for android only.
+     * Asynchronously stops the screen sharing session.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/screenshare} for more info
+     * This method communicates with the native `HMSManager` module to stop the ongoing screen sharing session initiated by the local peer.
+     * Upon successful execution, the screen sharing session is terminated, and other participants
+     * in the room will no longer be able to see the shared screen. This method can be used to programmatically control the end of a screen sharing session,
+     * providing flexibility in managing the screen sharing feature within your application.
      *
+     * Note: Ensure that the necessary permissions and conditions for screen sharing are managed appropriately in your application.
+     *
+     * @async
+     * @function stopScreenshare
      * @memberof HMSSDK
+     * @returns {Promise<void>} A promise that resolves when the screen sharing has successfully stopped.
+     * @throws {Error} Throws an error if the operation fails or the screen sharing cannot be stopped.
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/screenshare
+     * @example
+     * // Stop screen sharing
+     * await hmsInstance.stopScreenshare();
      */
     _defineProperty(this, "stopScreenshare", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function stopScreenshare', {
@@ -760,6 +1223,21 @@ export class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * Enables network quality updates for the local peer.
+     *
+     * This method activates the network quality monitoring feature, which periodically assesses and reports the network quality of peers in a room.
+     * The network quality updates are useful for providing feedback to the user about their current connection status, potentially prompting them to improve their network environment if necessary.
+     * Upon enabling, network quality updates are emitted through the appropriate event listeners - `HMSPeerUpdate.NETWORK_QUALITY_UPDATED` allowing the application to react or display the network status dynamically.
+     *
+     * @function enableNetworkQualityUpdates
+     * @memberof HMSSDK
+     * @example
+     * // Enable network quality updates
+     * hmsInstance.enableNetworkQualityUpdates();
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/measure-network-quality-and-performance/network-quality
+     */
     _defineProperty(this, "enableNetworkQualityUpdates", () => {
       logger === null || logger === void 0 || logger.verbose('#Function enableNetworkQualityUpdates', {
         id: this.id
@@ -768,6 +1246,21 @@ export class HMSSDK {
         id: this.id
       });
     });
+    /**
+     * Disables network quality updates for the local peer.
+     *
+     * This method deactivates the network quality monitoring feature, which stops the periodic assessment and reporting of the network quality of peers in a room.
+     * Disabling network quality updates can be useful in scenarios where network quality information is no longer needed, or to reduce the computational overhead associated with monitoring network quality.
+     * Once disabled, network quality updates will no longer be emitted through the event listeners, allowing the application to cease reacting to or displaying network status information.
+     *
+     * @function disableNetworkQualityUpdates
+     * @memberof HMSSDK
+     * @example
+     * // Disable network quality updates
+     * hmsInstance.disableNetworkQualityUpdates();
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/measure-network-quality-and-performance/network-quality
+     */
     _defineProperty(this, "disableNetworkQualityUpdates", () => {
       logger === null || logger === void 0 || logger.verbose('#Function disableNetworkQualityUpdates', {
         id: this.id
@@ -777,12 +1270,26 @@ export class HMSSDK {
       });
     });
     /**
-     * - This wrapper function is used to start streaming device audio, currently available only for android.
+     * Starts streaming device audio, available only on Android devices.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stream-device-audio-from-the-app} for more info.
+     * This method allows the application to share device audio, such as music or system sounds, with other participants in a video conference.
+     * It leverages the native HMSManager's `startAudioshare` method to initiate audio sharing. The function takes an `HMSAudioMixingMode` parameter,
+     * which specifies the audio mixing mode to be used during the audio share session.
      *
-     * @param {HMSAudioMixingMode}
-     * @memberof HMSSDK
+     * Note: This feature is currently supported only on Android. Attempting to use this feature on iOS will result in a console log indicating
+     * that the API is not available for iOS.
+     *
+     * @async
+     * @function startAudioshare
+     * @param {HMSAudioMixingMode} audioMixingMode - The audio mixing mode to be used for the audio share session.
+     * @returns {Promise} A promise that resolves to a success if the audio share is started successfully
+     * @throws {Error} Throws an error if the operation fails or the audio share cannot be started.
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share
+     *
+     * @example
+     * // Start audio sharing with the default mixing mode
+     * await hmsInstance.startAudioshare(HMSAudioMixingMode.DEFAULT);
      */
     _defineProperty(this, "startAudioshare", async audioMixingMode => {
       logger === null || logger === void 0 || logger.verbose('#Function startAudioshare', {
@@ -800,11 +1307,21 @@ export class HMSSDK {
       }
     });
     /**
-     * - This wrapper function returns true if audio is being shared and vice versa, currently available only for android.
+     * Checks if audio sharing is currently active.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-get-audio-share-status} for more info.
+     * This asynchronous method determines whether audio sharing is currently active, with support limited to Android devices.
+     * On Android, it queries the native `HMSManager` module to check the audio sharing status and returns a promise that resolves to a boolean value.
      *
+     * @async
+     * @function isAudioShared
      * @memberof HMSSDK
+     * @returns {Promise<boolean>} A promise that resolves to a boolean indicating whether audio sharing is currently active.
+     * @example
+     * // Check if audio is being shared on an Android device
+     * const isSharing = await hmsInstance.isAudioShared();
+     * console.log(isSharing); // true or false based on the sharing status, or a message for iOS
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share
      */
     _defineProperty(this, "isAudioShared", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function isAudioShared', {
@@ -816,15 +1333,25 @@ export class HMSSDK {
         });
       } else {
         console.log('API currently not available for iOS');
-        return 'API currently not available for iOS';
+        return Promise.resolve(false);
       }
     });
     /**
-     * - This wrapper function is used to stop streaming device audio, currently available only for android.
+     * Stops the streaming of device audio, with functionality currently limited to Android devices.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-stop-audio-sharing} for more info.
+     * This asynchronous method communicates with the native `HMSManager` module to stop the audio sharing session that was previously started.
+     * It is primarily used when the application needs to cease sharing device audio, such as music or system sounds, with other participants in a video conference.
+     * On Android devices, it successfully terminates the audio share session. On iOS devices, since the feature is not supported, it logs a message indicating the unavailability of the API.
      *
+     * @async
+     * @function stopAudioshare
      * @memberof HMSSDK
+     * @returns {Promise<boolean>} A promise that resolves to a boolean indicating the success of the operation.
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share
+     *
+     * @example
+     * // Stop audio sharing
+     * await hmsInstance.stopAudioshare();
      */
     _defineProperty(this, "stopAudioshare", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function stopAudioshare', {
@@ -836,14 +1363,30 @@ export class HMSSDK {
         });
       } else {
         console.log('API currently not available for iOS');
-        return 'API currently not available for iOS';
+        return Promise.resolve(false);
       }
     });
     /**
-     * - This wrapper function returns the current audio mixing mode, currently available only for android.
+     * Asynchronously retrieves the current audio mixing mode, with functionality currently limited to Android devices.
+     *
+     * This method queries the native `HMSManager` module to obtain the current audio mixing mode used in the audio share session.
+     * The audio mixing mode determines how local and remote audio tracks are mixed together during an audio share session.
+     *
+     * Note: This feature is only supported on Android. Attempting to use this feature on iOS will result in a console log indicating
+     * that the API is not available for iOS devices.
      *
+     * @async
+     * @function getAudioMixingMode
      * @memberof HMSSDK
-     * @return HMSAudioMixingMode
+     * @returns {Promise<string>} A promise that resolves to a string indicating the current audio mixing mode.
+     *
+     * @throws {Error} Throws an error if the operation fails or the audio mixing mode cannot be retrieved.
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share
+     * @example
+     * // Get the current audio mixing mode on an Android device
+     * const mixingMode = await hmsInstance.getAudioMixingMode();
+     * console.log(mixingMode); // Outputs the current audio mixing mode or a message for iOS
      */
     _defineProperty(this, "getAudioMixingMode", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function getAudioMixingMode', {
@@ -855,15 +1398,27 @@ export class HMSSDK {
         });
       } else {
         console.log('API currently not available for iOS');
-        return 'API currently not available for iOS';
+        return Promise.reject('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.
+     * Sets the audio mixing mode for the current session. Android only.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-share#how-to-change-mode} for more info
+     * This asynchronous function is used to change the mode of audio mixing during a session. It is currently
+     * available only for Android. The function logs the action with the instance ID and the specified audio mixing mode,
+     * then calls the native `setAudioMixingMode` method in `HMSManager` with the provided parameters.
+     *
+     * If the platform is not Android, it logs a message indicating that the API is not available for iOS.
+     *
+     * @param {HMSAudioMixingMode} audioMixingMode - The audio mixing mode to be set.
+     * @returns {Promise<boolean>} A promise that resolves to a boolean indicating the success of the operation.
+     * @throws {Error} Throws an error if the operation fails or the audio mixing mode cannot be set.
+     *
+     * @example
+     * await hmsInstance.setAudioMixingMode(HMSAudioMixingMode.TALK_AND_MUSIC);
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share
      *
-     * @param {HMSAudioMixingMode}
      * @memberof HMSSDK
      */
     _defineProperty(this, "setAudioMixingMode", async audioMixingMode => {
@@ -878,17 +1433,24 @@ export class HMSSDK {
         });
       } else {
         console.log('API currently not available for iOS');
-        return 'API currently not available for iOS';
+        return Promise.reject('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.
+     * Retrieves a list of audio output devices. Android only.
+     *
+     * This method asynchronously fetches and returns an array of audio output devices available on the device.
+     * It is designed to work specifically on Android platforms. For iOS, it will reject the promise with a message
+     * indicating that the API is not available. This can be useful for applications that need to display or allow
+     * the user to select from available audio output options, such as speakers, headphones, or Bluetooth devices.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-list-of-audio-device} for more info
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/speaker/audio-output-routing
      *
      * @memberof HMSSDK
-     * @return HMSAudioDevice[]
+     * @returns {Promise<HMSAudioDevice[]>} A promise that resolves to an array of `HMSAudioDevice` objects on Android. On iOS, the promise is rejected.
+     * @example
+     * // Get the list of audio output devices
+     * const audioDevices = await hmsInstance.getAudioDevicesList();
      */
     _defineProperty(this, "getAudioDevicesList", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function getAudioDevicesList', {
@@ -900,17 +1462,25 @@ export class HMSSDK {
         });
       } else {
         console.log('API currently not available for iOS');
-        return 'API currently not available for iOS';
+        return Promise.reject('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.
+     * Retrieves the current audio output device type on Android devices.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#get-current-focussed-device} for more info
+     * This method is a wrapper function that returns the type of the current audio output device.
+     * The return type is a `HMSAudioDevice`, which is an enumeration representing different types of audio output devices.
+     *
+     * Note: This API is not available for iOS devices. If invoked on iOS, it logs a message indicating the unavailability and rejects the promise.
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/speaker/audio-output-routing
      *
      * @memberof HMSSDK
-     * @return HMSAudioDevice
+     * @returns {Promise<HMSAudioDevice>} A promise that resolves to the current audio output device type if the platform is Android. If the platform is iOS, the promise is rejected.
+     *
+     * @example
+     * // Get the current audio output device type
+     * const currentAudioOutputDevice = await hmsInstance.getAudioOutputRouteType();
      */
     _defineProperty(this, "getAudioOutputRouteType", async () => {
       logger === null || logger === void 0 || logger.verbose('#Function getAudioOutputRouteType', {
@@ -922,16 +1492,23 @@ export class HMSSDK {
         });
       } else {
         console.log('API currently not available for iOS');
-        return 'API currently not available for iOS';
+        return Promise.reject('API currently not available for iOS');
       }
     });
     /**
-     * - This wrapper function used to switch output to device other than the default route.
+     * Switches the audio output device to a specified device.
+     * This function is a wrapper around the native module's method to change the audio output route.
+     * It allows for changing the audio output to a device other than the default one, such as a Bluetooth headset or speaker.
      *
-     * 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} audioDevice - The audio device to switch the output to. This should be one of the devices available in `HMSAudioDevice`.
+     *
+     * @returns {Promise<void>} A promise that resolves when the audio output device is successfully switched. Rejected if the operation fails.
+     *
+     *  @example
+     * // To switch audio output to a Bluetooth device
+     * hmsSDK.switchAudioOutput(HMSAudioDevice.Bluetooth);
      *
      * @memberof HMSSDK
-     * @param audioDevice
      */
     _defineProperty(this, "switchAudioOutput", audioDevice => {
       logger === null || logger === void 0 || logger.verbose('#Function switchAudioOutput', {
@@ -957,7 +1534,7 @@ export class HMSSDK {
     /**
      * - 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
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/speaker/audio-mode-change
      *
      * @param {HMSAudioMode}
      * @memberof HMSSDK
@@ -978,12 +1555,16 @@ export class HMSSDK {
       }
     });
     /**
-     * - This is a wrapper function which adds a listener which is triggered when audio output device is switched, currently available only for android.
+     * Adds a listener for changes in the audio output device.
+     * This function is platform-specific and currently only implemented for Android devices.
+     * When the audio output device changes (e.g., switching from the phone speaker to a Bluetooth headset), the specified callback function is triggered.
+     * This can be useful for applications that need to react to changes in audio routing, such as updating the UI to reflect the current output device.
      *
-     * checkout {@link https://www.100ms.live/docs/react-native/v2/features/audio-output-routing#adding-a-listener} for more info
+     * Note: This API is not available on iOS as of the current implementation. Attempting to use it on iOS will result in a rejected promise with an appropriate error message.
      *
-     * @param {Function}
+     * @param {Function} callback - The function to be called when the audio output device changes. This function does not receive any parameters.
      * @memberof HMSSDK
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/speaker/audio-output-routing
      */
     _defineProperty(this, "setAudioDeviceChangeListener", callback => {
       logger === null || logger === void 0 || logger.verbose('#Function setAudioDeviceChangeListener', {
@@ -996,9 +1577,15 @@ export class HMSSDK {
         });
       } else {
         console.log('API currently not available for iOS');
-        return 'API currently not available for iOS';
+        return Promise.reject('API currently not available for iOS');
       }
     });
+    /**
+     * Asynchronously retrieves a remote video track by its track ID.
+     *
+     * @param {string} trackId - The unique identifier for the remote video track to be retrieved.
+     * @returns {Promise<HMSRemoteVideoTrack>} A promise that resolves to the encoded remote video track data.
+     */
     _defineProperty(this, "getRemoteVideoTrackFromTrackId", async trackId => {
       logger === null || logger === void 0 || logger.verbose('#Function getRemoteVideoTrackFromTrackId', {
         id: this.id,
@@ -1010,17 +1597,33 @@ export class HMSSDK {
       });
       return HMSEncoder.encodeHmsRemoteVideoTrack(remoteVideoTrackData, this.id);
     });
+    /**
+     * Retrieves a remote audio track by its track ID.
+     *
+     * @param {string} trackId - The unique identifier for the remote audio track to be retrieved.
+     * @returns {Promise<HMSRemoteAudioTrack>} A promise that resolves to the encoded remote audio track data.
+     */
     _defineProperty(this, "getRemoteAudioTrackFromTrackId", async trackId => {
+      // Log the function call with the track ID for debugging purposes.
       logger === null || logger === void 0 || logger.verbose('#Function getRemoteAudioTrackFromTrackId', {
         id: this.id,
         trackId
       });
+
+      // Fetch the remote audio track data from the native HMSManager.
       const remoteAudioTrackData = await HMSManager.getRemoteAudioTrackFromTrackId({
         id: this.id,
         trackId
       });
+      // Encode and return the remote audio track data.
       return HMSEncoder.encodeHmsRemoteAudioTrack(remoteAudioTrackData, this.id);
     });
+    /**
+     * Retrieves a peer object based on the provided peer ID.
+     *
+     * @param {string} peerId - The ID of the peer to retrieve.
+     * @returns {HMSPeer | undefined} An encoded HMSPeer object if the peer is found otherwise `undefined`.
+     */
     _defineProperty(this, "getPeerFromPeerId", peerId => {
       logger === null || logger === void 0 || logger.verbose('#Function getPeerFromPeerId', {
         id: this.id,
@@ -1123,12 +1726,39 @@ export class HMSSDK {
         enabled
       });
     });
+    _defineProperty(this, "setPermissionsAcceptedOnAndroid", async () => {
+      if (Platform.OS === 'ios') {
+        Promise.reject('setPermissionsAcceptedOnAndroid API not available for iOS');
+        return;
+      }
+      logger === null || logger === void 0 || logger.verbose('#Function setPermissionsAcceptedOnAndroid', {
+        id: this.id
+      });
+      return await HMSManager.setPermissionsAccepted({
+        id: this.id
+      });
+    });
     /**
-     * - This is a prototype event listener that takes action and listens for updates related to that particular action
+     * Registers an event listener for various HMS SDK events.
      *
-     * @param {string} action
-     * @param {*} callback
+     * This method allows the registration of callbacks for different types of events that can occur within the HMS SDK.
+     * These events include but are not limited to updates about the room, peers, tracks, and errors.
+     * The method dynamically adds listeners based on the specified action and associates them with a callback function
+     * to handle the event. It ensures that only one subscription exists per event type to avoid duplicate listeners.
+     *
+     * @param {HMSUpdateListenerActions | HMSPIPListenerActions} action - The specific action/event to listen for.
+     * @param {Function} callback - The callback function to execute when the event occurs. The specifics of the callback parameters depend on the event type.
      * @memberof HMSSDK
+     *
+     * @example
+     * hmsInstance.addEventListener(HMSUpdateListenerActions.ON_JOIN, (event) => {
+     *   console.log('Joined the room:', event);
+     * });
+     *
+     * @example
+     * hmsInstance.addEventListener(HMSUpdateListenerActions.ON_PEER_UPDATE, (event) => {
+     *   console.log('Peer update:', event);
+     * });
      */
     _defineProperty(this, "addEventListener", (action, callback) => {
       logger === null || logger === void 0 || logger.verbose('#Function addEventListener', {
@@ -1160,6 +1790,18 @@ export class HMSSDK {
             this.onJoinDelegate = callback;
             break;
           }
+        case HMSUpdateListenerActions.ON_PERMISSIONS_REQUESTED:
+          {
+            // Checking if we already have ON_PERMISSIONS_REQUESTED subscription
+            if (!this.emitterSubscriptions[HMSUpdateListenerActions.ON_PERMISSIONS_REQUESTED]) {
+              // Adding ON_PERMISSIONS_REQUESTED native listener
+              const permissionsRequestedSubscription = HMSNativeEventListener.addListener(this.id, HMSUpdateListenerActions.ON_PERMISSIONS_REQUESTED, this.onPermissionsRequestedListener);
+              this.emitterSubscriptions[HMSUpdateListenerActions.ON_PERMISSIONS_REQUESTED] = permissionsRequestedSubscription;
+            }
+            // Adding App Delegate listener
+            this.onPermissionsRequestedDelegate = callback;
+            break;
+          }
         case HMSUpdateListenerActions.ON_ROOM_UPDATE:
           {
             // Checking if we already have ON_ROOM_UPDATE subscription
@@ -1429,11 +2071,21 @@ export class HMSSDK {
       }
     });
     /**
-     * - This is a prototype event listener that takes action and listens for updates related to that particular action
+     * Removes an event listener for a specified event action.
+     *
+     * This method allows for the deregistration of previously registered callbacks for specific event types within the HMS SDK.
+     * By specifying the action and the callback, it ensures that the event listener associated with that action is removed,
+     * preventing the callback from being executed when the event occurs in the future. This is useful for cleaning up resources
+     * and avoiding potential memory leaks in applications that dynamically add and remove event listeners based on component lifecycle
+     * or user interactions.
      *
-     * @param {string} action
-     * @param {*} callback
+     * @param {HMSUpdateListenerActions | HMSPIPListenerActions} action - The specific action/event for which the listener is to be removed.
+     * @param {Function} callback - The callback function that was originally registered for the event. This parameter is necessary to ensure
+     *                              that only the specific callback associated with the action is removed.
      * @memberof HMSSDK
+     * @example
+     * // Remove a listener for the ON_JOIN event
+     * hmsInstance.removeEventListener(HMSUpdateListenerActions.ON_JOIN, onJoinCallback);
      */
     _defineProperty(this, "removeEventListener", action => {
       logger === null || logger === void 0 || logger.verbose('#Function removeEventListener', {
@@ -1465,6 +2117,18 @@ export class HMSSDK {
             this.onJoinDelegate = null;
             break;
           }
+        case HMSUpdateListenerActions.ON_PERMISSIONS_REQUESTED:
+          {
+            const subscription = this.emitterSubscriptions[HMSUpdateListenerActions.ON_PERMISSIONS_REQUESTED];
+            // Removing ON_PERMISSIONS_REQUESTED native listener
+            if (subscription) {
+              subscription.remove();
+              this.emitterSubscriptions[HMSUpdateListenerActions.ON_PERMISSIONS_REQUESTED] = undefined;
+            }
+            // Removing App Delegate listener
+            this.onPermissionsRequestedDelegate = null;
+            break;
+          }
         case HMSUpdateListenerActions.ON_ROOM_UPDATE:
           {
             const subscription = this.emitterSubscriptions[HMSUpdateListenerActions.ON_ROOM_UPDATE];
@@ -1756,20 +2420,6 @@ export 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;
@@ -1801,6 +2451,17 @@ export class HMSSDK {
         });
       }
     });
+    _defineProperty(this, "onPermissionsRequestedListener", data => {
+      if (data.id !== this.id) {
+        return;
+      }
+      if (this.onPermissionsRequestedDelegate) {
+        logger === null || logger === void 0 || logger.verbose('#Listener ON_PERMISSIONS_REQUESTED_LISTENER_CALL', data);
+        this.onPermissionsRequestedDelegate({
+          ...data
+        });
+      }
+    });
     _defineProperty(this, "onRoomListener", data => {
       var _getHmsRoomCache2;
       if (data.id !== this.id) {
@@ -2115,6 +2776,15 @@ export class HMSSDK {
         });
       }
     });
+    /**
+     * Listener for the `SessionStoreAvailable` event.
+     *
+     * This listener is triggered when the session store becomes available in the SDK. It is an important event
+     * for developers who need to access or manipulate the session store after it has been initialized and made available.
+     *
+     * @param {Object} data - The event data.
+     * @param {HMSSessionStore} data.sessionStore - The session store object that has been made available.
+     */
     _defineProperty(this, "onSessionStoreAvailableListener", data => {
       if (data.id !== this.id) {
         return;
@@ -2127,8 +2797,20 @@ export class HMSSDK {
         });
       }
     });
-    /*
-     * - This listener is fired when Room is left from the Picture in Picture mode. Android only.
+    /**
+     * Listener for the `PIPRoomLeave` event. Android only.
+     *
+     * This listener is triggered when a room is left from the Picture in Picture (PIP) mode, which is currently supported only on Android platforms.
+     * It is an essential event for handling cleanup or UI updates when the user exits the room while in PIP mode.
+     * @param {Object} data - The event data.
+     * @memberof HMSSDK
+     * @example
+     * // Example of handling the `PIPRoomLeave` event
+     * hms.onPIPRoomLeave((data) => {
+     * // Handle PIP room leave event
+     * });
+     *
+     * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/pip-mode
      */
     _defineProperty(this, "onPIPRoomLeaveListener", data => {
       if (data.id !== this.id) {
@@ -2142,8 +2824,25 @@ export class HMSSDK {
         });
       }
     });
-    /*
-     * - Attach this listener to get notified when Picture in Picture mode is changed
+    /**
+     * Listener for the `PIPModeChanged` event.
+     * This listener is triggered when the Picture in Picture (PIP) mode is toggled on or off.
+     * It is an important event for handling UI updates or other actions when the user enters or exits PIP mode.
+     * @param {Object} data - The event data.
+     * @param {boolean} data.isInPictureInPictureMode - A boolean value indicating whether the user is currently in PIP mode.
+     * @returns {void} - Returns nothing.
+     * @memberof HMSSDK
+     * @example
+     * // Example of handling the `PIPModeChanged` event
+     * hms.onPIPModeChanged((data) => {
+     *  if (data.isInPictureInPictureMode) {
+     *  // Handle PIP mode enabled
+     *  } else {
+     *  // Handle PIP mode disabled
+     *  }
+     *  });
+     *
+     *  @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/pip-mode
      */
     _defineProperty(this, "onPIPModeChangedListener", data => {
       if (this.onPIPModeChangedDelegate) {
@@ -2152,9 +2851,20 @@ export class HMSSDK {
       }
     });
     /**
-     * - Updates the logger for this instance of HMSSDK
-     * @param {HMSLogger} hmsLogger
+     * Updates the logger instance for this HMSSDK instance.
+     *
+     * This method allows for the dynamic updating of the logger instance used by the HMSSDK.
+     * It can be used to change the logger settings or replace the logger entirely at runtime.
+     * This is particularly useful for adjusting log levels or redirecting log output based on application state or user preferences.
+     *
+     * @param {HMSLogger} hmsLogger - The new logger instance to be used. If not provided, the logger will be reset to default.
      * @memberof HMSSDK
+     * @example
+     * // Set a custom logger with a specific configuration
+     * const customLogger = new HMSLogger();
+     * customLogger.setLevel('verbose');
+     * hmsInstance.setLogger(customLogger);
+     *
      */
     _defineProperty(this, "setLogger", hmsLogger => {
       setLogger(this.id, hmsLogger);
@@ -2163,20 +2873,40 @@ export class HMSSDK {
   }
 
   /**
-   * - Returns an instance of [HMSSDK] {@link HMSSDK}
-   * - This function must be called to get an instance of HMSSDK class and only then user can interact with its methods.
+   * Asynchronously builds and returns an instance of the HMSSDK class.
    *
-   * Regular Usage:
+   * This method initializes the HMSSDK with optional configuration parameters and returns the initialized instance.
+   * It is responsible for setting up the SDK with specific settings for track management, app groups, extensions for iOS screen sharing,
+   * logging configurations, etc.
    *
+   *
+   * @param {Object} params - Optional configuration parameters for initializing the HMSSDK.
+   * @param {trackSettings} params.trackSettings is an optional value only required to enable features like iOS Screen/Audio Share, Android Software Echo Cancellation, etc
+   * @param {appGroup} params.appGroup is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
+   * @param {preferredExtension} params.preferredExtension is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
+   * @param {boolean} params.haltPreviewJoinForPermissionsRequestOnAndroid - Optional flag to halt the preview/join process until permissions are explicitly granted by the user. Android only. This is particularly useful when you might want to request permissions before proceeding with the preview or join operation.
+   * @param {HMSLogSettings} params.logSettings - Optional settings for logging.
+   *
+   * @returns {Promise<HMSSDK>} A promise that resolves to an instance of HMSSDK.
+   * @throws {Error} If the HMSSDK instance cannot be created.
+   *
+   * @example
+   * // Regular usage:
    * const hmsInstance = await HMSSDK.build();
    *
-   * For Advanced Use-Cases:
-   * @param {trackSettings} trackSettings is an optional value only required to enable features like iOS Screen/Audio Share, Android Software Echo Cancellation, etc
-   * @param {appGroup} appGroup is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
-   * @param {preferredExtension} preferredExtension is an optional value only required for implementing Screen & Audio Share on iOS. They are not required for Android. DO NOT USE if your app does not implements Screen or Audio Share on iOS.
+   * @example
+   * // Advanced Usage:
+   * const hmsInstance = await HMSSDK.build({
+   *   trackSettings: {...},
+   *   appGroup: 'group.example',
+   *   preferredExtension: 'com.example.extension',
+   *   logSettings: {...},
+   * });
    *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/install-the-sdk/hmssdk
    * @static
-   * @returns
+   * @async
+   * @function build
    * @memberof HMSSDK
    */
   static async build(params) {
@@ -2190,6 +2920,8 @@ export class HMSSDK {
     } = ReactNativeVersion.version;
     let id = await HMSManager.build({
       trackSettings: params === null || params === void 0 ? void 0 : params.trackSettings,
+      haltPreviewJoinForPermissionsRequest: params === null || params === void 0 ? void 0 : params.haltPreviewJoinForPermissionsRequestOnAndroid,
+      // required for Android Permissions, not required for iOS
       appGroup: params === null || params === void 0 ? void 0 : params.appGroup,
       // required for iOS Screenshare, not required for Android
       preferredExtension: params === null || params === void 0 ? void 0 : params.preferredExtension,
@@ -2204,8 +2936,29 @@ export class HMSSDK {
     HmsSdk = new HMSSDK(id);
     return HmsSdk;
   }
-  /*
+  /**
    * - This function is used to check if Picture in Picture mode is supported on the device
+   * @returns {Promise<boolean>} - Returns a boolean value indicating whether Picture in Picture mode is supported on the device.
+   * @memberof HMSSDK
+   * @example
+   * // Example of checking if Picture in Picture mode is supported
+   * const isPipModeSupported = await hms.isPipModeSupported();
+   * if (isPipModeSupported) {
+   * // Picture in Picture mode is supported
+   * } else {
+   * // Picture in Picture mode is not supported
+   * }
+   * @example
+   * // Example of checking if Picture in Picture mode is supported
+   * hms.isPipModeSupported().then((isPipModeSupported) => {
+   * if (isPipModeSupported) {
+   * // Picture in Picture mode is supported
+   * } else {
+   * // Picture in Picture mode is not supported
+   * }
+   * });
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/pip-mode
    */
   async isPipModeSupported() {
     const data = {
@@ -2215,8 +2968,36 @@ export class HMSSDK {
     return HMSManager.handlePipActions('isPipModeSupported', data);
   }
 
-  /*
-   * - This function can be used to manually enter Picture in Picture mode
+  /**
+   * Asynchronously enters Picture in Picture (PIP) mode with optional configuration.
+   *
+   * This method attempts to enter PIP mode based on the provided configuration.
+   * It returns a promise that resolves to a boolean indicating the success of the operation.
+   * If PIP mode is not supported or fails to activate, the promise may resolve to `undefined` or `false`.
+   *
+   * @param {HMSPIPConfig} [data] - Optional configuration for entering PIP mode. This can include settings such as `autoEnterPipMode` and `aspectRatio`.
+   * @returns {Promise<boolean>} - A promise that resolves to `true` if PIP mode was successfully entered, `false` if unsuccessful or PIP mode is not supported.
+   * @throws {Error} - Throws an error if the operation fails.
+   * @memberof HMSSDK
+   * @example
+   * // Example of entering Picture in Picture mode
+   * hms.enterPipMode().then((success) => {
+   * if (success) {
+   * // Picture in Picture mode entered successfully
+   * } else {
+   * // Picture in Picture mode could not be entered
+   * }
+   * });
+   * @example
+   * // Example of entering Picture in Picture mode with configuration
+   * const success = await hms.enterPipMode({ autoEnterPipMode: true, aspectRatio: [16,9] });
+   * if (success) {
+   * // Picture in Picture mode entered successfully
+   * } else {
+   * // Picture in Picture mode could not be entered
+   * }
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/pip-mode
    */
   async enterPipMode(data) {
     logger === null || logger === void 0 || logger.verbose('#Function enterPipMode', data);
@@ -2226,8 +3007,26 @@ export class HMSSDK {
     });
   }
 
-  /*
-   * - This function is to be used to configure the Picture in Picture window
+  /**
+   * Asynchronously sets the parameters for Picture in Picture (PIP) mode.
+   *
+   * This method configures the PIP window according to the provided `HMSPIPConfig` settings. It can be used to adjust various aspects of the PIP mode, such as its size, aspect ratio, and more. The method returns a promise that resolves to a boolean indicating the success of the operation. If the PIP mode is not supported or the configuration fails, the promise may resolve to `undefined` or `false`.
+   *
+   * @param {HMSPIPConfig} [data] - Optional configuration for setting PIP mode parameters. This can include settings such as `aspectRatio`, `autoEnterPipMode`, etc.
+   * @returns {Promise<boolean | undefined>} - A promise that resolves to `true` if the PIP parameters were successfully set, `false` if unsuccessful. `undefined` may be returned if PIP mode is not supported.
+   * @throws {Error} - Throws an error if the operation fails.
+   * @memberof HMSSDK
+   * @example
+   * // Example of setting Picture in Picture mode parameters
+   * hms.setPipParams({ aspectRatio: [16, 9], autoEnterPipMode: true }).then((success) => {
+   * if (success) {
+   * // Picture in Picture mode parameters set successfully
+   * } else {
+   * // Picture in Picture mode parameters could not be set
+   * }
+   * });
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/pip-mode
    */
   async setPipParams(data) {
     return HMSManager.handlePipActions('setPictureInPictureParams', {
@@ -2236,29 +3035,88 @@ export class HMSSDK {
     });
   }
 
-  /*
-   * - Use this function to set Video Track for Picture in Picture mode. iOS Only.
+  /**
+   * Changes the video track used in Picture in Picture (PIP) mode on iOS devices.
+   *
+   * This function is specifically designed for iOS platforms to switch the video track displayed in PIP mode.
+   * It takes a `HMSVideoTrack` object as an argument, which contains the track ID of the video track to be displayed in PIP mode.
+   * This allows for dynamic changes to the video source in PIP mode, enhancing the flexibility of video presentation in applications that support PIP.
+   *
+   * @param {HMSVideoTrack} track - The video track to be used in PIP mode. Must contain a valid `trackId`.
+   * @returns {Promise} - A promise that resolves when the video track has been successfully changed for PIP mode, or rejects with an error if the operation fails.
+   * @throws {Error} - Throws an error if the operation fails.
+   * @async
+   * @function changeIOSPIPVideoTrack
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/pip-mode
+   * @memberof HMSSDK
+   * @example
+   * // Example of changing the video track for PIP mode on iOS
+   * hms.changeIOSPIPVideoTrack(videoTrack).then(() => {
+   *   console.log('Video track for PIP mode changed successfully');
+   * }).catch(error => {
+   *   console.error('Failed to change video track for PIP mode', error);
+   * });
+   *
    */
   async changeIOSPIPVideoTrack(track) {
-    const data = {
-      id: this.id,
-      trackId: track.trackId
-    };
-    logger === null || logger === void 0 || logger.verbose('#Function changeIOSPIPVideoTrack', data);
-    return await HMSManager.changeIOSPIPVideoTrack(data);
+    if (Platform.OS === 'ios') {
+      const data = {
+        id: this.id,
+        trackId: track.trackId
+      };
+      logger === null || logger === void 0 || logger.verbose('#Function changeIOSPIPVideoTrack', data);
+      return await HMSManager.changeIOSPIPVideoTrack(data);
+    } else {
+      return Promise.resolve(false);
+    }
   }
 
-  /*
-   * - Use this function to automatically show the current Active Speaker Peer video in the PIP Mode window. iOS Only.
+  /**
+   * - This function is used to automatically switch the video track of the active speaker to the Picture in Picture (PIP) mode window on iOS devices.
+   * - When enabled, the video track of the active speaker will be displayed in the PIP mode window, providing a focused view of the current speaker during a meeting or conference.
+   * @param {boolean} enable - A boolean value indicating whether to enable or disable the automatic switching of the active speaker video track in PIP mode.
+   * @returns {Promise} - A promise that resolves when the operation is successful, or rejects with an error if the operation fails.
+   * @throws {Error} - Throws an error if the operation fails.
+   * @async
+   * @function setActiveSpeakerInIOSPIP
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/pip-mode
+   * @memberof HMSSDK
+   * @example
+   * // Example of enabling the automatic switching of the active speaker video track in PIP mode
+   * hms.setActiveSpeakerInIOSPIP(true).then(() => {
+   *  console.log('Active speaker video track enabled in PIP mode');
+   *  }).catch(error => {
+   *  console.error('Failed to enable active speaker video track in PIP mode', error);
+   *  });
    */
   async setActiveSpeakerInIOSPIP(enable) {
-    const data = {
-      id: this.id,
-      enable
-    };
-    logger === null || logger === void 0 || logger.verbose('#Function setActiveSpeakerInIOSPIP', data);
-    return await HMSManager.setActiveSpeakerInIOSPIP(data);
+    if (Platform.OS === 'ios') {
+      const data = {
+        id: this.id,
+        enable
+      };
+      logger === null || logger === void 0 || logger.verbose('#Function setActiveSpeakerInIOSPIP', data);
+      return await HMSManager.setActiveSpeakerInIOSPIP(data);
+    } else {
+      return Promise.resolve(false);
+    }
   }
+
+  /**
+   * Initiates real-time transcription services.
+   *
+   * This asynchronous function triggers the HMSManager to start real-time transcription services,
+   * capturing and transcribing audio in real time.
+   *
+   * @async
+   * @function startRealTimeTranscription
+   * @memberof HMSSDK
+   * @example
+   * // Example of starting real-time transcription services
+   * await hmsInstance.startRealTimeTranscription();
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/extend-capabilities/live-captions
+   */
   async startRealTimeTranscription() {
     const data = {
       id: this.id,
@@ -2267,6 +3125,20 @@ export class HMSSDK {
     logger === null || logger === void 0 || logger.verbose('#Function startRealTimeTranscription', data);
     return HMSManager.handleRealTimeTranscription(data);
   }
+
+  /**
+   * Stops the real-time transcription services.
+   *
+   * This asynchronous function signals the HMSManager to terminate the ongoing real-time transcription services.
+   *
+   * @async
+   * @function stopRealTimeTranscription
+   * @memberof HMSSDK
+   * @example
+   * await hmsInstance.stopRealTimeTranscription();
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/extend-capabilities/live-captions
+   */
   async stopRealTimeTranscription() {
     const data = {
       id: this.id,
@@ -2283,9 +3155,15 @@ export class HMSSDK {
   }
 
   /**
-   * - Returns the instance of logger which can be used to manipulate log levels.
-   * @returns @instance HMSLogger
+   * Retrieves the current logger instance used by the HMSSDK.
+   *
+   * This static method provides access to the logger instance, allowing for the manipulation of log levels and the retrieval of log information. It is useful for debugging purposes, enabling developers to monitor and adjust the verbosity of logs generated by the HMS SDK.
+   *
+   * @returns {HMSLogger} The current logger instance.
    * @memberof HMSSDK
+   * @example
+   * const logger = HMSSDK.getLogger();
+   * logger.setLevel('debug'); // Adjusting the log level to debug
    */
   static getLogger() {
     return getLogger();