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

package/ios/HMSRNSDK.swift

@@ -8,8 +8,10 @@
 import Foundation
 import HMSSDK
 import ReplayKit
+import AVKit
+import SwiftUI
 
-class HMSRNSDK: HMSUpdateListener, HMSPreviewListener {
+class HMSRNSDK: NSObject, HMSUpdateListener, HMSPreviewListener {
 
     var hms: HMSSDK?
     var interactivity: HMSRNInteractivityCenter?
@@ -38,6 +40,7 @@ class HMSRNSDK: HMSUpdateListener, HMSPreviewListener {
 
     // MARK: - Setup
     init(data: NSDictionary?, delegate manager: HMSManager?, uid id: String) {
+        super.init()
         preferredExtension = data?.value(forKey: "preferredExtension") as? String
         self.delegate = manager
         self.id = id
@@ -773,7 +776,7 @@ class HMSRNSDK: 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)
@@ -1535,6 +1538,18 @@ class HMSRNSDK: HMSUpdateListener, HMSPreviewListener {
             }
         }
 
+        if #available(iOS 15.0, *),
+            useActiveSpeakerInPIP,
+            let controller = pipController,
+            controller.isPictureInPictureActive,
+            track.kind == .video,
+            update == .trackRemoved,
+            pipModel?.track == track {
+
+            pipModel?.text = hms?.localPeer?.name
+            pipModel?.track = nil
+        }
+
         if eventsEnableStatus[HMSConstants.ON_TRACK_UPDATE] != true {
             return
         }
@@ -1562,6 +1577,35 @@ class HMSRNSDK: 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
+            } else {
+                if peer.isLocal {
+                    if #available(iOS 16.0, *) {
+                        if AVCaptureSession().isMultitaskingCameraAccessSupported {
+                            pipModel?.text = nil
+                            pipModel?.track = track
+                            return
+                        }
+                    }
+                    pipModel?.text = peer.name
+                    pipModel?.track = nil
+                } else {
+                    pipModel?.text = nil
+                    pipModel?.track = track
+                }
+            }
+        }
+
         if eventsEnableStatus[HMSConstants.ON_SPEAKER] != true {
             return
         }
@@ -2414,6 +2458,163 @@ class HMSRNSDK: HMSUpdateListener, HMSPreviewListener {
         }
     }
 
+    // MARK: - PIP Mode Support
+
+    internal var _pipVideoCallViewController: Any?
+
+    @available(iOS 15.0, *)
+    internal var pipVideoCallViewController: AVPictureInPictureVideoCallViewController? {
+        if _pipVideoCallViewController == nil {
+            _pipVideoCallViewController = AVPictureInPictureVideoCallViewController()
+        }
+        return _pipVideoCallViewController as? AVPictureInPictureVideoCallViewController
+    }
+
+    internal var _pipModel: Any?
+
+    @available(iOS 15.0, *)
+    internal var pipModel: HMSPipModel? {
+        if _pipModel == nil {
+            _pipModel = HMSPipModel()
+        }
+        return _pipModel as? HMSPipModel
+    }
+
+    internal var pipController: AVPictureInPictureController?
+
+    private var useActiveSpeakerInPIP: Bool = true
+
+    @available(iOS 15.0, *)
+    func setPictureInPictureParams(_ data: NSDictionary,
+                                   _ resolve: RCTPromiseResolveBlock?,
+                                   _ reject: RCTPromiseRejectBlock?) {
+
+        guard AVPictureInPictureController.isPictureInPictureSupported() else {
+            let errorMessage = "\(#function) PIP is not supported on this device"
+            reject?("6004", errorMessage, nil)
+            return
+        }
+
+        guard let uiView = UIApplication.shared.keyWindow?.rootViewController?.view else {
+            let errorMessage = "\(#function) Failed to setup PIP"
+            reject?("6004", errorMessage, nil)
+            return
+        }
+
+        pipModel?.pipViewEnabled = true
+
+        if let scaleType = data["scaleType"] as? String {
+            pipModel?.scaleType = getViewContentMode(scaleType)
+        } else {
+            pipModel?.scaleType = .scaleAspectFill
+        }
+
+        pipModel?.color = .black
+        pipModel?.text = hms?.localPeer?.name
+
+        let controller = UIHostingController(rootView: HMSPipView(model: pipModel!))
+
+        pipVideoCallViewController?.view.addConstrained(subview: controller.view)
+
+        if let ratio = data["aspectRatio"] as? [Int], ratio.count == 2 {
+            pipVideoCallViewController?.preferredContentSize = CGSize(width: ratio[0], height: ratio[1])
+        } else {
+            pipVideoCallViewController?.preferredContentSize = CGSize(width: uiView.frame.size.width, height: uiView.frame.size.height)
+        }
+
+        guard let pipVideoCallViewController = pipVideoCallViewController else {
+            let errorMessage = "\(#function) Failed to setup PIP"
+            reject?("6004", errorMessage, nil)
+            return
+        }
+
+        let pipContentSource = AVPictureInPictureController.ContentSource(activeVideoCallSourceView: uiView, contentViewController: pipVideoCallViewController)
+
+        pipController = AVPictureInPictureController(contentSource: pipContentSource)
+
+        pipController?.delegate = self
+
+        pipController?.canStartPictureInPictureAutomaticallyFromInline = true
+
+        if let autoEnterPIP = data["autoEnterPipMode"] as? Bool {
+            pipController?.canStartPictureInPictureAutomaticallyFromInline = autoEnterPIP
+        }
+
+        NotificationCenter.default.addObserver(forName: UIApplication.didBecomeActiveNotification,
+                                               object: nil, queue: .main) { [weak self] _ in
+            self?.stopPIP(nil, nil)
+        }
+
+        resolve?(true)
+    }
+
+    func enterPipMode(_ resolve: RCTPromiseResolveBlock?,
+                      _ reject: RCTPromiseRejectBlock?) {
+        pipController?.startPictureInPicture()
+        resolve?(true)
+    }
+
+    func stopPIP(_ resolve: RCTPromiseResolveBlock?,
+                 _ reject: RCTPromiseRejectBlock?) {
+        pipController?.stopPictureInPicture()
+        resolve?(nil)
+    }
+
+    func disposePIP(_ resolve: RCTPromiseResolveBlock?,
+                    _ reject: RCTPromiseRejectBlock?) {
+        pipController = nil
+        _pipModel = nil
+        _pipVideoCallViewController = nil
+        NotificationCenter.default.removeObserver(UIApplication.didBecomeActiveNotification)
+        resolve?(nil)
+    }
+
+    func isPIPActive(_ resolve: RCTPromiseResolveBlock?,
+                     _ reject: RCTPromiseRejectBlock?) {
+        if pipController != nil && pipController!.isPictureInPictureActive {
+            resolve?(true)
+        } else {
+            resolve?(false)
+        }
+    }
+
+    /// 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?,
+                                _ reject: RCTPromiseRejectBlock?) {
+
+        guard let trackID = data["trackId"] as? String,
+              let room = hms?.room,
+              let track = HMSUtilities.getVideoTrack(for: trackID, in: room)
+        else {
+            let errorMessage = "\(#function) Incorrect data passed for changing track in PIP Mode"
+            reject?("6004", errorMessage, nil)
+            return
+        }
+
+        useActiveSpeakerInPIP = false
+        pipModel?.track = track
+        resolve?(nil)
+    }
+
+    func setActiveSpeakerInIOSPIP(_ data: NSDictionary,
+                                  _ resolve: RCTPromiseResolveBlock?,
+                                  _ reject: RCTPromiseRejectBlock?) {
+        guard let enabled = data["enable"] as? Bool else {
+            let errorMessage = "\(#function) Incorrect data passed for setActiveSpeakerInIOSPIP in PIP Mode"
+            reject?("6004", errorMessage, nil)
+            return
+        }
+
+        useActiveSpeakerInPIP = enabled
+        resolve?(nil)
+    }
+
     // MARK: - Helper Functions
 
     // Handle resetting states and data cleanup
@@ -2514,6 +2715,19 @@ class HMSRNSDK: HMSUpdateListener, HMSPreviewListener {
     static private func getTimeStamp() -> String {
         "\(Date().timeIntervalSince1970)"
     }
+
+    private func getViewContentMode(_ type: String?) -> UIView.ContentMode {
+        switch type {
+        case "ASPECT_FILL":
+            return .scaleAspectFill
+        case "ASPECT_FIT":
+            return .scaleAspectFit
+        case "ASPECT_BALANCED":
+            return .center
+        default:
+            return .scaleAspectFill
+        }
+    }
 }
 
 extension UIImage {
@@ -2529,3 +2743,63 @@ extension UIImage {
         return normalizedImage
     }
 }
+
+extension HMSRNSDK: AVPictureInPictureControllerDelegate {
+
+    public func pictureInPictureControllerWillStartPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
+        print(#function)
+    }
+
+    public func pictureInPictureControllerDidStartPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
+
+        if eventsEnableStatus[HMSConstants.ON_PIP_MODE_CHANGED] != true {
+            return
+        }
+
+        self.delegate?.emitEvent(HMSConstants.ON_PIP_MODE_CHANGED,
+                                 ["event": HMSConstants.ON_PIP_MODE_CHANGED,
+                                  "id": self.id,
+                                  "isInPictureInPictureMode": true])
+    }
+
+    public func pictureInPictureControllerWillStopPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
+        print(#function)
+    }
+
+    public func pictureInPictureControllerDidStopPictureInPicture(_ pictureInPictureController: AVPictureInPictureController) {
+        if eventsEnableStatus[HMSConstants.ON_PIP_MODE_CHANGED] != true {
+            return
+        }
+
+        self.delegate?.emitEvent(HMSConstants.ON_PIP_MODE_CHANGED,
+                                 ["event": HMSConstants.ON_PIP_MODE_CHANGED,
+                                  "id": self.id,
+                                  "isInPictureInPictureMode": false])
+    }
+
+    public func pictureInPictureController(_ pictureInPictureController: AVPictureInPictureController, failedToStartPictureInPictureWithError error: Error) {
+        if eventsEnableStatus[HMSConstants.ON_PIP_MODE_CHANGED] != true {
+            return
+        }
+
+        self.delegate?.emitEvent(HMSConstants.ON_PIP_MODE_CHANGED,
+                                 ["event": HMSConstants.ON_PIP_MODE_CHANGED,
+                                  "id": self.id,
+                                  "isInPictureInPictureMode": false])
+    }
+
+    public func pictureInPictureController(_ pictureInPictureController: AVPictureInPictureController, restoreUserInterfaceForPictureInPictureStopWithCompletionHandler completionHandler: @escaping (Bool) -> Void) {
+        print(#function)
+    }
+}
+
+extension UIView {
+    func addConstrained(subview: UIView) {
+        addSubview(subview)
+        subview.translatesAutoresizingMaskIntoConstraints = false
+        subview.topAnchor.constraint(equalTo: topAnchor).isActive = true
+        subview.leadingAnchor.constraint(equalTo: leadingAnchor).isActive = true
+        subview.trailingAnchor.constraint(equalTo: trailingAnchor).isActive = true
+        subview.bottomAnchor.constraint(equalTo: bottomAnchor).isActive = true
+    }
+}

package/ios/PIPMode/HMSPipModel.swift

@@ -0,0 +1,18 @@
+//
+//  HMSPipModel.swift
+//  react-native-hms
+//
+//  Created by Yogesh Singh on 21/06/24.
+//
+
+import SwiftUI
+import HMSSDK
+
+@available(iOS 15.0, *)
+class HMSPipModel: ObservableObject {
+    @Published var track: HMSVideoTrack?
+    @Published var pipViewEnabled = false
+    @Published var scaleType: UIView.ContentMode?
+    @Published var text: String?
+    @Published var color: Color = Color.black
+}

package/ios/PIPMode/HMSPipView.swift

@@ -0,0 +1,36 @@
+//
+//  HMSPipView.swift
+//  react-native-hms
+//
+//  Created by Yogesh Singh on 21/06/24.
+//
+
+import SwiftUI
+import HMSSDK
+
+@available(iOS 15.0, *)
+struct HMSPipView: View {
+
+    @ObservedObject var model: HMSPipModel
+
+    var body: some View {
+        if model.pipViewEnabled {
+            VStack {
+                if let track = model.track, !(track.isMute()) {
+                    GeometryReader { geo in
+                        HMSSampleBufferSwiftUIView(track: track,
+                                                   contentMode: .scaleAspectFill,
+                                                   preferredSize: geo.size,
+                                                   model: model)
+                            .frame(width: geo.size.width, height: geo.size.height)
+                    }
+                } else if let text = model.text {
+                    Text(text)
+                }
+            }
+            .foregroundColor(.white)
+            .frame(maxWidth: .infinity, maxHeight: .infinity)
+            .background(model.color)
+        }
+    }
+}

package/ios/PIPMode/HMSSampleBufferSwiftUIView.swift

@@ -0,0 +1,45 @@
+//
+//  HMSSampleBufferSwiftUIView.swift
+//  react-native-hms
+//
+//  Created by Yogesh Singh on 21/06/24.
+//
+
+import SwiftUI
+import HMSSDK
+
+@available(iOS 15.0, *)
+public struct HMSSampleBufferSwiftUIView: UIViewRepresentable {
+    weak var track: HMSVideoTrack?
+    var contentMode: UIView.ContentMode
+    var preferredSize: CGSize?
+
+    @ObservedObject var model: HMSPipModel
+
+    public func makeUIView(context: UIViewRepresentableContext<HMSSampleBufferSwiftUIView>) -> HMSSampleBufferDisplayView {
+
+        let sampleBufferView = HMSSampleBufferDisplayView(frame: .zero)
+        sampleBufferView.track = track
+
+        if let preferredSize = preferredSize {
+            sampleBufferView.preferredSize = preferredSize
+        }
+        sampleBufferView.contentMode = contentMode
+        sampleBufferView.isEnabled = true
+
+        return sampleBufferView
+    }
+
+    public func updateUIView(_ sampleBufferView: HMSSampleBufferDisplayView, context: UIViewRepresentableContext<HMSSampleBufferSwiftUIView>) {
+
+        if track != sampleBufferView.track {
+            sampleBufferView.track = track
+        }
+        sampleBufferView.isEnabled = model.pipViewEnabled
+    }
+
+    public static func dismantleUIView(_ uiView: HMSSampleBufferDisplayView, coordinator: ()) {
+        uiView.isEnabled = false
+        uiView.track = nil
+    }
+}

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":[]}