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

package/README.md

@@ -1,5 +1,5 @@
 <a href="https://100ms.live/">
-<img src="https://raw.githubusercontent.com/100mslive/react-native-hms/main/100ms.svg" title="100ms logo" float=center height=256>
+<img src="https://raw.githubusercontent.com/100mslive/react-native-hms/main/100ms.svg" title="100ms logo" float=center height=256 alt="100ms logo">
 </a>
 
 [![npm](https://img.shields.io/npm/v/@100mslive/react-native-hms)](https://www.npmjs.com/package/@100mslive/react-native-hms)
@@ -22,10 +22,11 @@ With support for HLS and RTMP Live Streaming and Recording, Picture-in-Picture (
 
 📖 Read the Complete Documentation here: https://www.100ms.live/docs/react-native/v2/foundation/basics
 
-| Package                          | Version                                                                                                                                 |
-| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
-| @100mslive/react-native-room-kit | [![npm](https://img.shields.io/npm/v/@100mslive/react-native-room-kit)](https://www.npmjs.com/package/@100mslive/react-native-room-kit) |
-| @100mslive/react-native-hms      | [![npm](https://img.shields.io/npm/v/@100mslive/react-native-hms)](https://www.npmjs.com/package/@100mslive/react-native-hms)           |
+| Package                              | Version                                                                                                                                         |
+| ------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------- |
+| @100mslive/react-native-room-kit     | [![npm](https://img.shields.io/npm/v/@100mslive/react-native-room-kit)](https://www.npmjs.com/package/@100mslive/react-native-room-kit)         |
+| @100mslive/react-native-hms          | [![npm](https://img.shields.io/npm/v/@100mslive/react-native-hms)](https://www.npmjs.com/package/@100mslive/react-native-hms)                   |
+| @100mslive/react-native-video-plugin | [![npm](https://img.shields.io/npm/v/@100mslive/react-native-video-plugin)](https://www.npmjs.com/package/@100mslive/react-native-video-plugin) |
 
 ## 🏃 Example App
 

package/android/src/main/java/com/reactnativehmssdk/HMSManager.kt

@@ -1093,7 +1093,7 @@ class HMSManager(
       activity.setPictureInPictureParams(pipParams)
       return true
     } catch (e: Exception) {
-      throw e
+      return false
     }
   }
 
@@ -1128,7 +1128,7 @@ class HMSManager(
 
       return activity.enterPictureInPictureMode(pipParams)
     } catch (e: Exception) {
-      throw e
+      return false
     }
   }
 
@@ -1646,6 +1646,23 @@ class HMSManager(
   }
   // endregion
 
+  @ReactMethod
+  fun setPermissionsAccepted(
+    data: ReadableMap,
+    promise: Promise?,
+  ) {
+    val rnSDK =
+      HMSHelper.getHms(data, hmsCollection) ?: run {
+        promise?.reject(
+          "6004",
+          "RN HMS SDK not initialized",
+        )
+        return
+      }
+    rnSDK.hmsSDK?.setPermissionsAccepted()
+    promise?.resolve(null)
+  }
+
   // region Warning on JS side
   @ReactMethod
   fun addListener(eventName: String) {

package/android/src/main/java/com/reactnativehmssdk/HMSRNSDK.kt

@@ -87,6 +87,13 @@ class HMSRNSDK(
       }
     }
 
+    if (data?.hasKey("haltPreviewJoinForPermissionsRequest") == true) {
+      val halt = data?.getBoolean("haltPreviewJoinForPermissionsRequest")
+      if (halt != null) {
+        builder.haltPreviewJoinForPermissionsRequest(halt)
+      }
+    }
+
     this.hmsSDK = builder.build()
 
     hmsSDK?.let {
@@ -286,6 +293,17 @@ class HMSRNSDK(
             data.putArray("removedPeers", removedPeersArray)
             delegate.emitEvent("ON_PEER_LIST_UPDATED", data)
           }
+
+          override fun onPermissionsRequested(permissions: List<String>) {
+            if (eventsEnableStatus["ON_PERMISSIONS_REQUESTED"] != true) {
+              return
+            }
+            val data: WritableMap = Arguments.createMap()
+
+            data.putArray("permissions", Arguments.fromList(permissions))
+            data.putString("id", id)
+            delegate.emitEvent("ON_PERMISSIONS_REQUESTED", data)
+          }
         },
       )
     } else {
@@ -557,6 +575,17 @@ class HMSRNSDK(
               data.putString("id", id)
               delegate.emitEvent("ON_TRANSCRIPTS", data)
             }
+
+            override fun onPermissionsRequested(permissions: List<String>) {
+              if (eventsEnableStatus["ON_PERMISSIONS_REQUESTED"] != true) {
+                return
+              }
+              val data: WritableMap = Arguments.createMap()
+
+              data.putArray("permissions", Arguments.fromList(permissions))
+              data.putString("id", id)
+              delegate.emitEvent("ON_PERMISSIONS_REQUESTED", data)
+            }
           },
         )
 
@@ -1440,6 +1469,7 @@ class HMSRNSDK(
 
           if (audioTrackId == trackId) {
             peer.audioTrack?.setVolume(volume)
+            callback?.resolve(null)
             return
           }
 
@@ -1449,6 +1479,7 @@ class HMSRNSDK(
 
               if (trackExtracted != null) {
                 trackExtracted.setVolume(volume)
+                callback?.resolve(null)
                 return
               }
             }
@@ -1721,7 +1752,7 @@ class HMSRNSDK(
       val audioDevice = data.getString("audioDevice")
       hmsSDK?.let {
         it.switchAudioOutput(HMSHelper.getAudioDevice(audioDevice))
-        callback?.resolve(true)
+        callback?.resolve(null)
       }
     } else {
       val errorMessage = "switchAudioOutput: $requiredKeys"
@@ -1807,7 +1838,7 @@ class HMSRNSDK(
         override fun onSuccess() {
           isAudioSharing = false
           audioshareCallback = null
-          callback?.resolve(getPromiseResolveData())
+          callback?.resolve(true)
         }
       },
     )
@@ -1825,7 +1856,7 @@ class HMSRNSDK(
       val mode = HMSHelper.getAudioMixingMode(data.getString("audioMixingMode"))
       audioMixingMode = mode
       hmsSDK?.setAudioMixingMode(mode)
-      callback?.resolve(getPromiseResolveData())
+      callback?.resolve(true)
     } else {
       val errorMessage = "setAudioMixingMode: $requiredKeys"
       rejectCallback(callback, errorMessage)

package/android/src/main/java/com/reactnativehmssdk/PipActionReceiver.kt

@@ -7,6 +7,8 @@ import android.content.Intent
 import android.content.IntentFilter
 import android.os.Build
 import androidx.annotation.RequiresApi
+import androidx.core.content.ContextCompat
+import androidx.core.content.ContextCompat.RECEIVER_NOT_EXPORTED
 
 data class PIPAction(
   val title: String,
@@ -62,7 +64,7 @@ class PipActionReceiver(
 
     IntentFilter().also {
       it.addAction(PIP_INTENT_ACTION)
-      activity.registerReceiver(this, it)
+      ContextCompat.registerReceiver(activity, this, it, RECEIVER_NOT_EXPORTED)
     }
     registered = true
   }

package/ios/HMSRNSDK.swift

@@ -776,7 +776,7 @@ class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
 
             if remoteAudioTrack != nil {
                 remoteAudioTrack?.setVolume(volume)
-                resolve?(true)
+                resolve?(nil)
             } else {
                 let errorMessage = "setVolume: No remote audio track not available"
                 reject?(errorMessage, errorMessage, nil)
@@ -1537,7 +1537,7 @@ class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
                 }
             }
         }
-        
+
         if #available(iOS 15.0, *),
             useActiveSpeakerInPIP,
             let controller = pipController,
@@ -1545,7 +1545,7 @@ class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
             track.kind == .video,
             update == .trackRemoved,
             pipModel?.track == track {
-            
+
             pipModel?.text = hms?.localPeer?.name
             pipModel?.track = nil
         }
@@ -1577,14 +1577,14 @@ class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
     }
 
     func on(updated speakers: [HMSSpeaker]) {
-        
+
         if #available(iOS 15.0, *),
            useActiveSpeakerInPIP,
            let controller = pipController,
            controller.isPictureInPictureActive,
            let peer = speakers.first?.peer,
            let track = peer.videoTrack {
-            
+
             if track.isMute() {
                 pipModel?.text = peer.name
                 pipModel?.track = nil
@@ -1605,7 +1605,7 @@ class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
                 }
             }
         }
-        
+
         if eventsEnableStatus[HMSConstants.ON_SPEAKER] != true {
             return
         }
@@ -2545,13 +2545,13 @@ class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
             self?.stopPIP(nil, nil)
         }
 
-        resolve?(nil)
+        resolve?(true)
     }
 
     func enterPipMode(_ resolve: RCTPromiseResolveBlock?,
                       _ reject: RCTPromiseRejectBlock?) {
         pipController?.startPictureInPicture()
-        resolve?(nil)
+        resolve?(true)
     }
 
     func stopPIP(_ resolve: RCTPromiseResolveBlock?,
@@ -2578,6 +2578,11 @@ class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
         }
     }
 
+    /// Change the video track in PIP Mode
+    /// - Parameters:
+    ///   - data: Data containing the trackId of the video track to be changed
+    ///   - resolve: Promise resolve block
+    ///   - reject: Promise reject block
     @available(iOS 15.0, *)
     func changeIOSPIPVideoTrack(_ data: NSDictionary,
                                 _ resolve: RCTPromiseResolveBlock?,

package/lib/commonjs/classes/HMSAudioDevice.js

@@ -4,6 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HMSAudioDevice = void 0;
+/**
+ * Enum for HMSAudioDevice types.
+ *
+ * This enum represents the different types of audio devices that can be used
+ * in the context of the HMS SDK. It provides a way to specify the preferred
+ * audio output device for audio playback.
+ *
+ * @enum {string}
+ */
 let HMSAudioDevice = exports.HMSAudioDevice = /*#__PURE__*/function (HMSAudioDevice) {
   HMSAudioDevice["SPEAKER_PHONE"] = "SPEAKER_PHONE";
   HMSAudioDevice["WIRED_HEADSET"] = "WIRED_HEADSET";

package/lib/commonjs/classes/HMSAudioDevice.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSAudioDevice","exports"],"sources":["HMSAudioDevice.ts"],"sourcesContent":["export enum HMSAudioDevice {\n  SPEAKER_PHONE = 'SPEAKER_PHONE',\n  WIRED_HEADSET = 'WIRED_HEADSET',\n  EARPIECE = 'EARPIECE',\n  BLUETOOTH = 'BLUETOOTH',\n  AUTOMATIC = 'AUTOMATIC',\n}\n"],"mappings":";;;;;;IAAYA,cAAc,GAAAC,OAAA,CAAAD,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}
+{"version":3,"names":["HMSAudioDevice","exports"],"sources":["HMSAudioDevice.ts"],"sourcesContent":["/**\n * Enum for HMSAudioDevice types.\n *\n * This enum represents the different types of audio devices that can be used\n * in the context of the HMS SDK. It provides a way to specify the preferred\n * audio output device for audio playback.\n *\n * @enum {string}\n */\nexport enum HMSAudioDevice {\n  /** Use the speakerphone for audio output. */\n  SPEAKER_PHONE = 'SPEAKER_PHONE',\n\n  /** Use a wired headset for audio output, if connected. */\n  WIRED_HEADSET = 'WIRED_HEADSET',\n\n  /** Use the earpiece for audio output. */\n  EARPIECE = 'EARPIECE',\n\n  /** Use a Bluetooth device for audio output, if connected. */\n  BLUETOOTH = 'BLUETOOTH',\n\n  /** Automatically select the best audio output device based on the current state. */\n  AUTOMATIC = 'AUTOMATIC',\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AARA,IASYA,cAAc,GAAAC,OAAA,CAAAD,cAAA,0BAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAdA,cAAc;EAAA,OAAdA,cAAc;AAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSAudioMixingMode.js

@@ -4,6 +4,17 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HMSAudioMixingMode = void 0;
+/**
+ * Enum for HMS Audio Mixing Mode options.
+ *
+ * Defines the modes available for audio mixing in a session. These modes determine how audio tracks are mixed and played back.
+ *
+ * - `TALK_ONLY`: Only the talk (voice) track is active, suitable for sessions focusing on voice communication.
+ * - `TALK_AND_MUSIC`: Both talk and music tracks are active, allowing for background music with clear voice overlay.
+ * - `MUSIC_ONLY`: Only the music track is active, ideal for sessions focusing on music playback.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share
+ */
 let HMSAudioMixingMode = exports.HMSAudioMixingMode = /*#__PURE__*/function (HMSAudioMixingMode) {
   HMSAudioMixingMode["TALK_ONLY"] = "TALK_ONLY";
   HMSAudioMixingMode["TALK_AND_MUSIC"] = "TALK_AND_MUSIC";

package/lib/commonjs/classes/HMSAudioMixingMode.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSAudioMixingMode","exports"],"sources":["HMSAudioMixingMode.ts"],"sourcesContent":["export enum HMSAudioMixingMode {\n  TALK_ONLY = 'TALK_ONLY',\n  TALK_AND_MUSIC = 'TALK_AND_MUSIC',\n  MUSIC_ONLY = 'MUSIC_ONLY',\n}\n"],"mappings":";;;;;;IAAYA,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA","ignoreList":[]}
+{"version":3,"names":["HMSAudioMixingMode","exports"],"sources":["HMSAudioMixingMode.ts"],"sourcesContent":["/**\n * Enum for HMS Audio Mixing Mode options.\n *\n * Defines the modes available for audio mixing in a session. These modes determine how audio tracks are mixed and played back.\n *\n * - `TALK_ONLY`: Only the talk (voice) track is active, suitable for sessions focusing on voice communication.\n * - `TALK_AND_MUSIC`: Both talk and music tracks are active, allowing for background music with clear voice overlay.\n * - `MUSIC_ONLY`: Only the music track is active, ideal for sessions focusing on music playback.\n *\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/local-audio-share\n */\nexport enum HMSAudioMixingMode {\n  TALK_ONLY = 'TALK_ONLY',\n  TALK_AND_MUSIC = 'TALK_AND_MUSIC',\n  MUSIC_ONLY = 'MUSIC_ONLY',\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAVA,IAWYA,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSAudioTrack.js

@@ -5,6 +5,15 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.HMSAudioTrack = void 0;
 var _HMSTrack = require("./HMSTrack");
+/**
+ * Represents an audio track within the HMS (100ms) system.
+ *
+ * This class extends `HMSTrack` to provide functionalities specific to audio tracks. It includes a constructor
+ * that allows for the initialization of the audio track with various parameters such as track ID, source, description,
+ * mute state, ID, and type. These parameters provide detailed information about the audio track and its characteristics.
+ *
+ * @extends HMSTrack
+ */
 class HMSAudioTrack extends _HMSTrack.HMSTrack {
   constructor(params) {
     if (params) {

package/lib/commonjs/classes/HMSAudioTrack.js.map

@@ -1 +1 @@
-{"version":3,"names":["_HMSTrack","require","HMSAudioTrack","HMSTrack","constructor","params","exports"],"sources":["HMSAudioTrack.ts"],"sourcesContent":["import { HMSTrack } from './HMSTrack';\nimport type { HMSTrackSource } from './HMSTrackSource';\nimport type { HMSTrackType } from './HMSTrackType';\n\nexport class HMSAudioTrack extends HMSTrack {\n  constructor(params?: {\n    trackId: string;\n    source?: HMSTrackSource;\n    trackDescription?: string;\n    isMute?: boolean;\n    id: string;\n    type?: HMSTrackType;\n  }) {\n    if (params) {\n      super(params);\n    }\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,OAAA;AAIO,MAAMC,aAAa,SAASC,kBAAQ,CAAC;EAC1CC,WAAWA,CAACC,MAOX,EAAE;IACD,IAAIA,MAAM,EAAE;MACV,KAAK,CAACA,MAAM,CAAC;IACf;EACF;AACF;AAACC,OAAA,CAAAJ,aAAA,GAAAA,aAAA","ignoreList":[]}
+{"version":3,"names":["_HMSTrack","require","HMSAudioTrack","HMSTrack","constructor","params","exports"],"sources":["HMSAudioTrack.ts"],"sourcesContent":["import { HMSTrack } from './HMSTrack';\nimport type { HMSTrackSource } from './HMSTrackSource';\nimport type { HMSTrackType } from './HMSTrackType';\n\n/**\n * Represents an audio track within the HMS (100ms) system.\n *\n * This class extends `HMSTrack` to provide functionalities specific to audio tracks. It includes a constructor\n * that allows for the initialization of the audio track with various parameters such as track ID, source, description,\n * mute state, ID, and type. These parameters provide detailed information about the audio track and its characteristics.\n *\n * @extends HMSTrack\n */\nexport class HMSAudioTrack extends HMSTrack {\n  constructor(params?: {\n    trackId: string;\n    source?: HMSTrackSource;\n    trackDescription?: string;\n    isMute?: boolean;\n    id: string;\n    type?: HMSTrackType;\n  }) {\n    if (params) {\n      super(params);\n    }\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,SAAA,GAAAC,OAAA;AAIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,aAAa,SAASC,kBAAQ,CAAC;EAC1CC,WAAWA,CAACC,MAOX,EAAE;IACD,IAAIA,MAAM,EAAE;MACV,KAAK,CAACA,MAAM,CAAC;IACf;EACF;AACF;AAACC,OAAA,CAAAJ,aAAA,GAAAA,aAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSCameraFacing.js

@@ -4,6 +4,15 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HMSCameraFacing = void 0;
+/**
+ * Enum for camera facing directions in a 100ms (HMS) application.
+ *
+ * This enumeration defines the possible camera facing options for video tracks in a 100ms (HMS) application, allowing developers to specify whether the front or back camera should be used during a video session.
+ * This can be particularly useful for applications that need to switch between cameras or provide users with the option to choose their preferred camera.
+ *
+ * @enum {string}
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/mute#switch-camera
+ */
 let HMSCameraFacing = exports.HMSCameraFacing = /*#__PURE__*/function (HMSCameraFacing) {
   HMSCameraFacing["FRONT"] = "FRONT";
   HMSCameraFacing["BACK"] = "BACK";

package/lib/commonjs/classes/HMSCameraFacing.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSCameraFacing","exports"],"sources":["HMSCameraFacing.ts"],"sourcesContent":["export enum HMSCameraFacing {\n  FRONT = 'FRONT',\n  BACK = 'BACK',\n}\n"],"mappings":";;;;;;IAAYA,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA","ignoreList":[]}
+{"version":3,"names":["HMSCameraFacing","exports"],"sources":["HMSCameraFacing.ts"],"sourcesContent":["/**\n * Enum for camera facing directions in a 100ms (HMS) application.\n *\n * This enumeration defines the possible camera facing options for video tracks in a 100ms (HMS) application, allowing developers to specify whether the front or back camera should be used during a video session.\n * This can be particularly useful for applications that need to switch between cameras or provide users with the option to choose their preferred camera.\n *\n * @enum {string}\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/mute#switch-camera\n */\nexport enum HMSCameraFacing {\n  /** Represents the front camera on a device. */\n  FRONT = 'FRONT',\n  /** Represents the back camera on a device. */\n  BACK = 'BACK',\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AARA,IASYA,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSConfig.js

@@ -7,6 +7,33 @@ exports.HMSConfig = void 0;
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * Represents the configuration needed to join a room in the HMS ecosystem.
+ *
+ * This class encapsulates all necessary details required to initiate a connection to a room, including user identification,
+ * authentication token, optional endpoint for different server connections, metadata for additional information about the connection,
+ * and a flag to capture network quality during the preview phase.
+ *
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/join
+ *
+ * @param {Object} params - The configuration parameters.
+ * @param {string} params.username - The username of the participant.
+ * @param {string} params.authToken - The authentication token for room access.
+ * @param {string} [params.endpoint] - Optional. The endpoint URL for the connection.
+ * @param {string} [params.metadata] - Optional. Additional metadata associated with the Local Peer.
+ * @param {boolean} [params.captureNetworkQualityInPreview] - Optional. Flag to capture network quality in the preview phase.
+ * @constructor
+ *
+ * @example
+ * const config = new HMSConfig({
+ *  username: 'username',
+ *  authToken: 'authToken',
+ *  metadata: 'metadata',
+ *  captureNetworkQualityInPreview: true,
+ * });
+ *
+ */
 class HMSConfig {
   constructor(params) {
     _defineProperty(this, "username", void 0);

package/lib/commonjs/classes/HMSConfig.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSConfig","constructor","params","_defineProperty","username","authToken","endpoint","metadata","captureNetworkQualityInPreview","exports"],"sources":["HMSConfig.ts"],"sourcesContent":["export class HMSConfig {\n  username: string;\n  authToken: string;\n  endpoint?: string;\n  metadata?: string;\n  captureNetworkQualityInPreview?: boolean;\n\n  constructor(params: {\n    username: string;\n    authToken: string;\n    endpoint?: string;\n    metadata?: string;\n    captureNetworkQualityInPreview?: boolean;\n  }) {\n    this.username = params.username;\n    this.authToken = params.authToken;\n    this.endpoint = params.endpoint;\n    this.metadata = params.metadata;\n    this.captureNetworkQualityInPreview = params.captureNetworkQualityInPreview;\n  }\n}\n"],"mappings":";;;;;;;;;AAAO,MAAMA,SAAS,CAAC;EAOrBC,WAAWA,CAACC,MAMX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAI,CAACC,QAAQ,GAAGF,MAAM,CAACE,QAAQ;IAC/B,IAAI,CAACC,SAAS,GAAGH,MAAM,CAACG,SAAS;IACjC,IAAI,CAACC,QAAQ,GAAGJ,MAAM,CAACI,QAAQ;IAC/B,IAAI,CAACC,QAAQ,GAAGL,MAAM,CAACK,QAAQ;IAC/B,IAAI,CAACC,8BAA8B,GAAGN,MAAM,CAACM,8BAA8B;EAC7E;AACF;AAACC,OAAA,CAAAT,SAAA,GAAAA,SAAA","ignoreList":[]}
+{"version":3,"names":["HMSConfig","constructor","params","_defineProperty","username","authToken","endpoint","metadata","captureNetworkQualityInPreview","exports"],"sources":["HMSConfig.ts"],"sourcesContent":["/**\n * Represents the configuration needed to join a room in the HMS ecosystem.\n *\n * This class encapsulates all necessary details required to initiate a connection to a room, including user identification,\n * authentication token, optional endpoint for different server connections, metadata for additional information about the connection,\n * and a flag to capture network quality during the preview phase.\n *\n *\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/join\n *\n * @param {Object} params - The configuration parameters.\n * @param {string} params.username - The username of the participant.\n * @param {string} params.authToken - The authentication token for room access.\n * @param {string} [params.endpoint] - Optional. The endpoint URL for the connection.\n * @param {string} [params.metadata] - Optional. Additional metadata associated with the Local Peer.\n * @param {boolean} [params.captureNetworkQualityInPreview] - Optional. Flag to capture network quality in the preview phase.\n * @constructor\n *\n * @example\n * const config = new HMSConfig({\n *  username: 'username',\n *  authToken: 'authToken',\n *  metadata: 'metadata',\n *  captureNetworkQualityInPreview: true,\n * });\n *\n */\nexport class HMSConfig {\n  username: string;\n  authToken: string;\n  endpoint?: string;\n  metadata?: string;\n  captureNetworkQualityInPreview?: boolean;\n\n  constructor(params: {\n    username: string;\n    authToken: string;\n    endpoint?: string;\n    metadata?: string;\n    captureNetworkQualityInPreview?: boolean;\n  }) {\n    this.username = params.username;\n    this.authToken = params.authToken;\n    this.endpoint = params.endpoint;\n    this.metadata = params.metadata;\n    this.captureNetworkQualityInPreview = params.captureNetworkQualityInPreview;\n  }\n}\n"],"mappings":";;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,SAAS,CAAC;EAOrBC,WAAWA,CAACC,MAMX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAI,CAACC,QAAQ,GAAGF,MAAM,CAACE,QAAQ;IAC/B,IAAI,CAACC,SAAS,GAAGH,MAAM,CAACG,SAAS;IACjC,IAAI,CAACC,QAAQ,GAAGJ,MAAM,CAACI,QAAQ;IAC/B,IAAI,CAACC,QAAQ,GAAGL,MAAM,CAACK,QAAQ;IAC/B,IAAI,CAACC,8BAA8B,GAAGN,MAAM,CAACM,8BAA8B;EAC7E;AACF;AAACC,OAAA,CAAAT,SAAA,GAAAA,SAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSException.js

@@ -7,6 +7,24 @@ exports.HMSException = void 0;
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * Represents an exception specific to the HMS SDK in a React Native context.
+ *
+ * This class encapsulates detailed information about errors that can occur while interacting with the HMS SDK.
+ * It includes a numeric code to identify the type of error, a human-readable description, and optionally,
+ * a message, name, and action that are primarily available on Android. Additionally, it indicates whether
+ * the error is terminal (i.e., cannot be recovered from) and whether a retry might be possible.
+ *
+ * @class HMSException
+ * @property {number} code - Numeric error code representing the type of error.
+ * @property {string} description - A brief, human-readable description of the error.
+ * @property {string} [message] - Additional message information about the error (Android only).
+ * @property {string} [name] - The name of the error (Android only).
+ * @property {string} [action] - The action during which the error occurred (Android only).
+ * @property {boolean} isTerminal - Indicates whether the error is terminal.
+ * @property {boolean} [canRetry] - Indicates whether the operation that caused the error can be retried (Android only).
+ *
+ */
 class HMSException {
   // `canRetry` is available only on Android
 

package/lib/commonjs/classes/HMSException.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSException","constructor","params","_defineProperty","code","description","message","name","action","isTerminal","canRetry","exports"],"sources":["HMSException.ts"],"sourcesContent":["export class HMSException {\n  code: number;\n  description: string;\n  message?: string; // `message` is available only on Android\n  name?: string; // `name` is available only on Android\n  action?: string; // `action` is available only on Android\n  isTerminal: boolean;\n  canRetry?: boolean; // `canRetry` is available only on Android\n\n  constructor(params: {\n    code: number;\n    description: string;\n    message?: string;\n    name?: string;\n    action?: string;\n    isTerminal: boolean;\n    canRetry?: boolean;\n  }) {\n    this.code = params.code;\n    this.description = params.description;\n    this.message = params.message;\n    this.name = params.name;\n    this.action = params.action;\n    this.isTerminal = params.isTerminal;\n    this.canRetry = params.canRetry;\n  }\n}\n"],"mappings":";;;;;;;;;AAAO,MAAMA,YAAY,CAAC;EAOJ;;EAEpBC,WAAWA,CAACC,MAQX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAde;IAAAA,eAAA;IACH;IAAAA,eAAA;IACE;IAAAA,eAAA;IAAAA,eAAA;IAaf,IAAI,CAACC,IAAI,GAAGF,MAAM,CAACE,IAAI;IACvB,IAAI,CAACC,WAAW,GAAGH,MAAM,CAACG,WAAW;IACrC,IAAI,CAACC,OAAO,GAAGJ,MAAM,CAACI,OAAO;IAC7B,IAAI,CAACC,IAAI,GAAGL,MAAM,CAACK,IAAI;IACvB,IAAI,CAACC,MAAM,GAAGN,MAAM,CAACM,MAAM;IAC3B,IAAI,CAACC,UAAU,GAAGP,MAAM,CAACO,UAAU;IACnC,IAAI,CAACC,QAAQ,GAAGR,MAAM,CAACQ,QAAQ;EACjC;AACF;AAACC,OAAA,CAAAX,YAAA,GAAAA,YAAA","ignoreList":[]}
+{"version":3,"names":["HMSException","constructor","params","_defineProperty","code","description","message","name","action","isTerminal","canRetry","exports"],"sources":["HMSException.ts"],"sourcesContent":["/**\n * Represents an exception specific to the HMS SDK in a React Native context.\n *\n * This class encapsulates detailed information about errors that can occur while interacting with the HMS SDK.\n * It includes a numeric code to identify the type of error, a human-readable description, and optionally,\n * a message, name, and action that are primarily available on Android. Additionally, it indicates whether\n * the error is terminal (i.e., cannot be recovered from) and whether a retry might be possible.\n *\n * @class HMSException\n * @property {number} code - Numeric error code representing the type of error.\n * @property {string} description - A brief, human-readable description of the error.\n * @property {string} [message] - Additional message information about the error (Android only).\n * @property {string} [name] - The name of the error (Android only).\n * @property {string} [action] - The action during which the error occurred (Android only).\n * @property {boolean} isTerminal - Indicates whether the error is terminal.\n * @property {boolean} [canRetry] - Indicates whether the operation that caused the error can be retried (Android only).\n *\n */\nexport class HMSException {\n  code: number;\n  description: string;\n  message?: string; // `message` is available only on Android\n  name?: string; // `name` is available only on Android\n  action?: string; // `action` is available only on Android\n  isTerminal: boolean;\n  canRetry?: boolean; // `canRetry` is available only on Android\n\n  constructor(params: {\n    code: number;\n    description: string;\n    message?: string;\n    name?: string;\n    action?: string;\n    isTerminal: boolean;\n    canRetry?: boolean;\n  }) {\n    this.code = params.code;\n    this.description = params.description;\n    this.message = params.message;\n    this.name = params.name;\n    this.action = params.action;\n    this.isTerminal = params.isTerminal;\n    this.canRetry = params.canRetry;\n  }\n}\n"],"mappings":";;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,YAAY,CAAC;EAOJ;;EAEpBC,WAAWA,CAACC,MAQX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAde;IAAAA,eAAA;IACH;IAAAA,eAAA;IACE;IAAAA,eAAA;IAAAA,eAAA;IAaf,IAAI,CAACC,IAAI,GAAGF,MAAM,CAACE,IAAI;IACvB,IAAI,CAACC,WAAW,GAAGH,MAAM,CAACG,WAAW;IACrC,IAAI,CAACC,OAAO,GAAGJ,MAAM,CAACI,OAAO;IAC7B,IAAI,CAACC,IAAI,GAAGL,MAAM,CAACK,IAAI;IACvB,IAAI,CAACC,MAAM,GAAGN,MAAM,CAACM,MAAM;IAC3B,IAAI,CAACC,UAAU,GAAGP,MAAM,CAACO,UAAU;IACnC,IAAI,CAACC,QAAQ,GAAGR,MAAM,CAACQ,QAAQ;EACjC;AACF;AAACC,OAAA,CAAAX,YAAA,GAAAA,YAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSHLSTimedMetadata.js.map

@@ -1 +1 @@
-{"version":3,"names":[],"sources":["HMSHLSTimedMetadata.ts"],"sourcesContent":["export interface HMSHLSTimedMetadata {\n  payload: string;\n  duration: number;\n}\n"],"mappings":"","ignoreList":[]}
+{"version":3,"names":[],"sources":["HMSHLSTimedMetadata.ts"],"sourcesContent":["/**\n * Defines the structure for HLS (HTTP Live Streaming) timed metadata.\n *\n * This interface is used to represent metadata that can be synchronized with HLS video playback.\n * The metadata includes a payload, which is the content of the metadata, and a duration, specifying how long (in seconds)\n * the metadata should be displayed during the stream.\n * This can be used for a variety of purposes such as displaying song titles, advertisements, or other relevant information at specific times during the stream.\n *\n * @interface HMSHLSTimedMetadata\n * @property {string} payload - The content of the metadata to be displayed.\n * @property {number} duration - The duration (in seconds) for which the metadata should be displayed.\n */\nexport interface HMSHLSTimedMetadata {\n  payload: string;\n  duration: number;\n}\n"],"mappings":"","ignoreList":[]}

package/lib/commonjs/classes/HMSIOSAudioMode.js

@@ -4,6 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HMSIOSAudioMode = void 0;
+/**
+ * Enum for specifying the audio mode in an iOS environment within a 100ms (HMS) application.
+ *
+ * This enumeration provides options to configure the audio mode for an iOS application using the 100ms (HMS) SDK.
+ * It allows for the selection between `voice` and `music` modes, catering to different use cases such as
+ * prioritizing voice clarity or enhancing music quality during a session.
+ *
+ * @enum {string}
+ * @property {string} VOICE - Configures the audio session for optimized voice communication.
+ *                            This mode enhances voice clarity, making it suitable for calls or conferences.
+ * @property {string} MUSIC - Configures the audio session for music playback.
+ *                            This mode enhances music fidelity, making it suitable for streams or recordings that prioritize music quality.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/microphone/music-mode
+ */
 let HMSIOSAudioMode = exports.HMSIOSAudioMode = /*#__PURE__*/function (HMSIOSAudioMode) {
   HMSIOSAudioMode["VOICE"] = "voice";
   HMSIOSAudioMode["MUSIC"] = "music";

package/lib/commonjs/classes/HMSIOSAudioMode.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSIOSAudioMode","exports"],"sources":["HMSIOSAudioMode.ts"],"sourcesContent":["export enum HMSIOSAudioMode {\n  VOICE = 'voice',\n  MUSIC = 'music',\n}\n"],"mappings":";;;;;;IAAYA,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA","ignoreList":[]}
+{"version":3,"names":["HMSIOSAudioMode","exports"],"sources":["HMSIOSAudioMode.ts"],"sourcesContent":["/**\n * Enum for specifying the audio mode in an iOS environment within a 100ms (HMS) application.\n *\n * This enumeration provides options to configure the audio mode for an iOS application using the 100ms (HMS) SDK.\n * It allows for the selection between `voice` and `music` modes, catering to different use cases such as\n * prioritizing voice clarity or enhancing music quality during a session.\n *\n * @enum {string}\n * @property {string} VOICE - Configures the audio session for optimized voice communication.\n *                            This mode enhances voice clarity, making it suitable for calls or conferences.\n * @property {string} MUSIC - Configures the audio session for music playback.\n *                            This mode enhances music fidelity, making it suitable for streams or recordings that prioritize music quality.\n *\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/configure-your-device/microphone/music-mode\n */\nexport enum HMSIOSAudioMode {\n  VOICE = 'voice',\n  MUSIC = 'music',\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAdA,IAeYA,eAAe,GAAAC,OAAA,CAAAD,eAAA,0BAAfA,eAAe;EAAfA,eAAe;EAAfA,eAAe;EAAA,OAAfA,eAAe;AAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSLogAlarmManager.js

@@ -4,6 +4,18 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HMSLogAlarmManager = void 0;
+/**
+ * Enumeration for managing log alarm settings in HMS SDK for React Native applications. Android only.
+ *
+ * This enumeration defines constants used to configure the alarm manager for log files in the HMS SDK.
+ * It includes settings for the default directory size, default log file name, and maximum directory size,
+ * allowing for detailed control over how log files are managed and stored.
+ *
+ * @enum {string}
+ * @property {string} DEFAULT_DIR_SIZE - Represents the default size for the log directory.
+ * @property {string} DEFAULT_LOGS_FILE_NAME - Represents the default name for log files.
+ * @property {string} MAX_DIR_SIZE - Represents the maximum size for the log directory.
+ */
 let HMSLogAlarmManager = exports.HMSLogAlarmManager = /*#__PURE__*/function (HMSLogAlarmManager) {
   HMSLogAlarmManager["DEFAULT_DIR_SIZE"] = "DEFAULT_DIR_SIZE";
   HMSLogAlarmManager["DEFAULT_LOGS_FILE_NAME"] = "DEFAULT_LOGS_FILE_NAME";

package/lib/commonjs/classes/HMSLogAlarmManager.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSLogAlarmManager","exports"],"sources":["HMSLogAlarmManager.ts"],"sourcesContent":["export enum HMSLogAlarmManager {\n  DEFAULT_DIR_SIZE = 'DEFAULT_DIR_SIZE',\n  DEFAULT_LOGS_FILE_NAME = 'DEFAULT_LOGS_FILE_NAME',\n  MAX_DIR_SIZE = 'MAX_DIR_SIZE',\n}\n"],"mappings":";;;;;;IAAYA,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA","ignoreList":[]}
+{"version":3,"names":["HMSLogAlarmManager","exports"],"sources":["HMSLogAlarmManager.ts"],"sourcesContent":["/**\n * Enumeration for managing log alarm settings in HMS SDK for React Native applications. Android only.\n *\n * This enumeration defines constants used to configure the alarm manager for log files in the HMS SDK.\n * It includes settings for the default directory size, default log file name, and maximum directory size,\n * allowing for detailed control over how log files are managed and stored.\n *\n * @enum {string}\n * @property {string} DEFAULT_DIR_SIZE - Represents the default size for the log directory.\n * @property {string} DEFAULT_LOGS_FILE_NAME - Represents the default name for log files.\n * @property {string} MAX_DIR_SIZE - Represents the maximum size for the log directory.\n */\nexport enum HMSLogAlarmManager {\n  DEFAULT_DIR_SIZE = 'DEFAULT_DIR_SIZE',\n  DEFAULT_LOGS_FILE_NAME = 'DEFAULT_LOGS_FILE_NAME',\n  MAX_DIR_SIZE = 'MAX_DIR_SIZE',\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAXA,IAYYA,kBAAkB,GAAAC,OAAA,CAAAD,kBAAA,0BAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAlBA,kBAAkB;EAAA,OAAlBA,kBAAkB;AAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSLogLevel.js

@@ -4,6 +4,18 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HMSLogLevel = void 0;
+/**
+ * Enumeration for defining log levels in the HMS SDK for React Native applications.
+ *
+ * This enumeration provides a set of predefined log levels that can be used to control the verbosity of logging
+ * within the HMS SDK. It allows developers to specify how much detail they want in their logs, which can be
+ * helpful for debugging or monitoring the application's behavior.
+ *
+ * @enum {string}
+ * @property {string} VERBOSE - Represents the most verbose log level, including detailed debug information.
+ * @property {string} WARNING - Represents a log level for warning messages that might indicate potential issues.
+ * @property {string} ERROR - Represents a log level for error messages indicating failures that need attention.
+ */
 let HMSLogLevel = exports.HMSLogLevel = /*#__PURE__*/function (HMSLogLevel) {
   HMSLogLevel["VERBOSE"] = "VERBOSE";
   HMSLogLevel["WARNING"] = "WARNING";

package/lib/commonjs/classes/HMSLogLevel.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSLogLevel","exports"],"sources":["HMSLogLevel.ts"],"sourcesContent":["export enum HMSLogLevel {\n  VERBOSE = 'VERBOSE',\n  WARNING = 'WARNING',\n  ERROR = 'ERROR',\n}\n"],"mappings":";;;;;;IAAYA,WAAW,GAAAC,OAAA,CAAAD,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA","ignoreList":[]}
+{"version":3,"names":["HMSLogLevel","exports"],"sources":["HMSLogLevel.ts"],"sourcesContent":["/**\n * Enumeration for defining log levels in the HMS SDK for React Native applications.\n *\n * This enumeration provides a set of predefined log levels that can be used to control the verbosity of logging\n * within the HMS SDK. It allows developers to specify how much detail they want in their logs, which can be\n * helpful for debugging or monitoring the application's behavior.\n *\n * @enum {string}\n * @property {string} VERBOSE - Represents the most verbose log level, including detailed debug information.\n * @property {string} WARNING - Represents a log level for warning messages that might indicate potential issues.\n * @property {string} ERROR - Represents a log level for error messages indicating failures that need attention.\n */\nexport enum HMSLogLevel {\n  VERBOSE = 'VERBOSE',\n  WARNING = 'WARNING',\n  ERROR = 'ERROR',\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AAXA,IAYYA,WAAW,GAAAC,OAAA,CAAAD,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSLogSettings.js

@@ -7,6 +7,20 @@ exports.HMSLogSettings = void 0;
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * Represents the logging settings for the HMS SDK.
+ *
+ * This class encapsulates the settings related to logging within the HMS SDK, including the log level,
+ * whether log storage is enabled, and the maximum directory size for log storage.
+ * It is used to configure how logs are handled by the SDK, allowing for customization of log verbosity and storage requirements.
+ *
+ * @class HMSLogSettings
+ * @property {HMSLogLevel} level - The log level setting, determining the verbosity of the logs.
+ * @property {boolean} isLogStorageEnabled - Flag indicating whether log storage is enabled. Android only.
+ * @property {HMSLogAlarmManager} maxDirSizeInBytes - The maximum size of the log directory in bytes, managed by an instance of HMSLogAlarmManager. Android only.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/debugging/logger
+ */
 class HMSLogSettings {
   constructor(params) {
     _defineProperty(this, "level", void 0);

package/lib/commonjs/classes/HMSLogSettings.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSLogSettings","constructor","params","_defineProperty","level","isLogStorageEnabled","maxDirSizeInBytes","exports"],"sources":["HMSLogSettings.ts"],"sourcesContent":["import type { HMSLogAlarmManager } from './HMSLogAlarmManager';\nimport type { HMSLogLevel } from './HMSLogLevel';\n\nexport class HMSLogSettings {\n  level: HMSLogLevel;\n  isLogStorageEnabled: boolean;\n  maxDirSizeInBytes: HMSLogAlarmManager;\n\n  constructor(params: {\n    level: HMSLogLevel;\n    isLogStorageEnabled: boolean;\n    maxDirSizeInBytes: HMSLogAlarmManager;\n  }) {\n    this.level = params.level;\n    this.isLogStorageEnabled = params.isLogStorageEnabled;\n    this.maxDirSizeInBytes = params.maxDirSizeInBytes;\n  }\n}\n"],"mappings":";;;;;;;;;AAGO,MAAMA,cAAc,CAAC;EAK1BC,WAAWA,CAACC,MAIX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAI,CAACC,KAAK,GAAGF,MAAM,CAACE,KAAK;IACzB,IAAI,CAACC,mBAAmB,GAAGH,MAAM,CAACG,mBAAmB;IACrD,IAAI,CAACC,iBAAiB,GAAGJ,MAAM,CAACI,iBAAiB;EACnD;AACF;AAACC,OAAA,CAAAP,cAAA,GAAAA,cAAA","ignoreList":[]}
+{"version":3,"names":["HMSLogSettings","constructor","params","_defineProperty","level","isLogStorageEnabled","maxDirSizeInBytes","exports"],"sources":["HMSLogSettings.ts"],"sourcesContent":["import type { HMSLogAlarmManager } from './HMSLogAlarmManager';\nimport type { HMSLogLevel } from './HMSLogLevel';\n\n/**\n * Represents the logging settings for the HMS SDK.\n *\n * This class encapsulates the settings related to logging within the HMS SDK, including the log level,\n * whether log storage is enabled, and the maximum directory size for log storage.\n * It is used to configure how logs are handled by the SDK, allowing for customization of log verbosity and storage requirements.\n *\n * @class HMSLogSettings\n * @property {HMSLogLevel} level - The log level setting, determining the verbosity of the logs.\n * @property {boolean} isLogStorageEnabled - Flag indicating whether log storage is enabled. Android only.\n * @property {HMSLogAlarmManager} maxDirSizeInBytes - The maximum size of the log directory in bytes, managed by an instance of HMSLogAlarmManager. Android only.\n *\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/debugging/logger\n */\nexport class HMSLogSettings {\n  level: HMSLogLevel;\n  isLogStorageEnabled: boolean;\n  maxDirSizeInBytes: HMSLogAlarmManager;\n\n  constructor(params: {\n    level: HMSLogLevel;\n    isLogStorageEnabled: boolean;\n    maxDirSizeInBytes: HMSLogAlarmManager;\n  }) {\n    this.level = params.level;\n    this.isLogStorageEnabled = params.isLogStorageEnabled;\n    this.maxDirSizeInBytes = params.maxDirSizeInBytes;\n  }\n}\n"],"mappings":";;;;;;;;;AAGA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,cAAc,CAAC;EAK1BC,WAAWA,CAACC,MAIX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAI,CAACC,KAAK,GAAGF,MAAM,CAACE,KAAK;IACzB,IAAI,CAACC,mBAAmB,GAAGH,MAAM,CAACG,mBAAmB;IACrD,IAAI,CAACC,iBAAiB,GAAGJ,MAAM,CAACI,iBAAiB;EACnD;AACF;AAACC,OAAA,CAAAP,cAAA,GAAAA,cAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSNetworkQuality.js

@@ -7,6 +7,17 @@ exports.HMSNetworkQuality = void 0;
 function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
 function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
 function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+/**
+ * Represents the network quality of a connection in the HMS (100ms) system.
+ *
+ * This class encapsulates the network quality information, specifically focusing on the downlink quality of the connection.
+ * The downlink quality is represented as a numerical value, providing a quantifiable measure of the receiving end's network performance.
+ *
+ * @param {Object} params - The constructor parameters.
+ * @param {number} params.downlinkQuality - The downlink quality of the network connection.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/measure-network-quality-and-performance/network-quality
+ */
 class HMSNetworkQuality {
   constructor(params) {
     _defineProperty(this, "downlinkQuality", void 0);

package/lib/commonjs/classes/HMSNetworkQuality.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSNetworkQuality","constructor","params","_defineProperty","downlinkQuality","exports"],"sources":["HMSNetworkQuality.ts"],"sourcesContent":["export class HMSNetworkQuality {\n  downlinkQuality: number;\n\n  constructor(params: { downlinkQuality: number }) {\n    this.downlinkQuality = params.downlinkQuality;\n  }\n}\n"],"mappings":";;;;;;;;;AAAO,MAAMA,iBAAiB,CAAC;EAG7BC,WAAWA,CAACC,MAAmC,EAAE;IAAAC,eAAA;IAC/C,IAAI,CAACC,eAAe,GAAGF,MAAM,CAACE,eAAe;EAC/C;AACF;AAACC,OAAA,CAAAL,iBAAA,GAAAA,iBAAA","ignoreList":[]}
+{"version":3,"names":["HMSNetworkQuality","constructor","params","_defineProperty","downlinkQuality","exports"],"sources":["HMSNetworkQuality.ts"],"sourcesContent":["/**\n * Represents the network quality of a connection in the HMS (100ms) system.\n *\n * This class encapsulates the network quality information, specifically focusing on the downlink quality of the connection.\n * The downlink quality is represented as a numerical value, providing a quantifiable measure of the receiving end's network performance.\n *\n * @param {Object} params - The constructor parameters.\n * @param {number} params.downlinkQuality - The downlink quality of the network connection.\n *\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/measure-network-quality-and-performance/network-quality\n */\nexport class HMSNetworkQuality {\n  downlinkQuality: number;\n\n  constructor(params: { downlinkQuality: number }) {\n    this.downlinkQuality = params.downlinkQuality;\n  }\n}\n"],"mappings":";;;;;;;;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,iBAAiB,CAAC;EAG7BC,WAAWA,CAACC,MAAmC,EAAE;IAAAC,eAAA;IAC/C,IAAI,CAACC,eAAe,GAAGF,MAAM,CAACE,eAAe;EAC/C;AACF;AAACC,OAAA,CAAAL,iBAAA,GAAAA,iBAAA","ignoreList":[]}