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

package/lib/module/classes/HMSPeer.js

@@ -4,6 +4,23 @@ function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e =
 import { getHmsPeersCache, getPeerPropertyFromNative } from './HMSPeersCache';
 import { HMSConstants } from './HMSConstants';
 import { HMSPeerType } from './HMSPeerType';
+
+/**
+ * Represents a peer in the HMS ecosystem.
+ *
+ * This class encapsulates the properties and state of a peer within a session, including their ID, name, role, and various status flags.
+ *
+ * @export
+ * @class HMSPeer
+ * @property {string} peerID - The unique identifier for the peer.
+ * @property {string | undefined} _name - The name of the peer. Private access.
+ * @property {boolean | undefined} _isLocal - Flag indicating whether the peer is the local user. Private access.
+ * @property {string | undefined} _customerUserID - An optional custom user ID set by the application. Private access.
+ * @property {string | undefined} _metadata - Optional metadata associated with the peer. Private access.
+ * @property {HMSRole | undefined} _role - The role assigned to the peer within the session. Private access.
+ * @property {boolean} _isHandRaised - Flag indicating whether the peer has raised their hand. Defaults to false. Private access.
+ * @property {HMSPeerType} _type - The type of the peer, e.g., regular, screen share. Defaults to `HMSPeerType.REGULAR`. Private access.
+ */
 export class HMSPeer {
   _updateName(value) {
     // If `_isLocal` is outdated, update it
@@ -59,6 +76,17 @@ export class HMSPeer {
     this.peerID = params.peerID;
     this._name = params.name;
   }
+
+  /**
+   * Gets the name of the peer.
+   *
+   * This getter method retrieves the name of the peer. If the name has already been set locally, it returns that value.
+   * Otherwise, it attempts to retrieve the name from the HMS peers cache. If the cache does not contain the name,
+   * it falls back to fetching the name directly from the native layer using the peer's ID.
+   * Once a value is retrieved, it updates the local `_name` property to ensure consistency.
+   *
+   * @returns {string | undefined} The name of the peer if available, otherwise `undefined`.
+   */
   get name() {
     if (this._name) {
       return this._name;
@@ -70,6 +98,16 @@ export class HMSPeer {
     }
     return value ?? this._name;
   }
+
+  /**
+   * Determines if the peer is the local user.
+   *
+   * This getter method checks if the peer is the local user by first attempting to retrieve the 'isLocal' property value from the HMS peers cache.
+   * If the value is not found in the cache, it falls back to fetching the property directly from the native layer using the peer's ID.
+   * Once a value is retrieved, it updates the local `_isLocal` property to ensure the value is current.
+   *
+   * @returns {boolean | undefined} True if the peer is the local user, false otherwise. Returns `undefined` if the information is not available.
+   */
   get isLocal() {
     const hmsPeersCache = getHmsPeersCache();
     const value = hmsPeersCache ? hmsPeersCache.getProperty(this.peerID, 'isLocal') : getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'isLocal');
@@ -78,6 +116,19 @@ export class HMSPeer {
     }
     return value ?? this._isLocal;
   }
+
+  /**
+   * Checks if the peer has raised their hand.
+   *
+   * This getter method determines whether the peer has their hand raised in the session. It first attempts to retrieve the 'isHandRaised' property value
+   * from the HMS peers cache. If the value is not found in the cache, it falls back to fetching the property directly from the native layer using the peer's ID.
+   * Once a value is retrieved, it updates the local `_isHandRaised` property to ensure the value is current and consistent.
+   *
+   * @returns {boolean} True if the peer has their hand raised, false otherwise. Defaults to false if the information is not available.
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/large-room
+   *
+   */
   get isHandRaised() {
     const hmsPeersCache = getHmsPeersCache();
     const value = hmsPeersCache ? hmsPeersCache.getProperty(this.peerID, 'isHandRaised') : getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'isHandRaised');
@@ -86,6 +137,19 @@ export class HMSPeer {
     }
     return value ?? this._isHandRaised;
   }
+
+  /**
+   * Retrieves the network quality of the peer.
+   *
+   * This getter method attempts to obtain the network quality of the peer, which is an indicator of the current network conditions affecting the peer's connection.
+   * It first tries to get this information from the HMS peers cache. If the information is not available in the cache,
+   * it falls back to fetching the network quality directly from the native layer using the peer's ID.
+   * The network quality is represented by the `HMSNetworkQuality` type, which may include values such as 'good', 'poor', etc., depending on the implementation.
+   *
+   * @returns {HMSNetworkQuality | undefined} The network quality of the peer if available, otherwise `undefined`.
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/measure-network-quality-and-performance/network-quality
+   */
   get networkQuality() {
     const hmsPeersCache = getHmsPeersCache();
     if (hmsPeersCache) {
@@ -93,6 +157,17 @@ export class HMSPeer {
     }
     return getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'networkQuality');
   }
+
+  /**
+   * Retrieves the custom user ID of the peer.
+   *
+   * This getter method attempts to obtain the custom user ID of the peer, which is an optional identifier that can be set by the application.
+   * It first tries to get this information from the HMS peers cache. If the information is not available in the cache,
+   * it falls back to fetching the custom user ID directly from the native layer using the peer's ID.
+   * Once a value is retrieved, it updates the local `_customerUserID` property to ensure the value is current and consistent.
+   *
+   * @returns {string | undefined} The custom user ID of the peer if available, otherwise `undefined`.
+   */
   get customerUserID() {
     const hmsPeersCache = getHmsPeersCache();
     const value = hmsPeersCache ? hmsPeersCache.getProperty(this.peerID, 'customerUserID') : getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'customerUserID');
@@ -101,6 +176,19 @@ export class HMSPeer {
     }
     return value ?? this._customerUserID;
   }
+
+  /**
+   * Retrieves the metadata associated with the peer.
+   *
+   * This getter method attempts to obtain the metadata of the peer, which can include any additional information set by the application.
+   * It first tries to get this information from the HMS peers cache. If the information is not available in the cache,
+   * it falls back to fetching the metadata directly from the native layer using the peer's ID.
+   * Once a value is retrieved, it updates the local `_metadata` property to ensure the value is current and consistent.
+   *
+   * @returns {string | undefined} The metadata of the peer if available, otherwise `undefined`.
+   *
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-metadata
+   */
   get metadata() {
     const hmsPeersCache = getHmsPeersCache();
     const value = hmsPeersCache ? hmsPeersCache.getProperty(this.peerID, 'metadata') : getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'metadata');
@@ -109,6 +197,19 @@ export class HMSPeer {
     }
     return value ?? this._metadata;
   }
+
+  /**
+   * Retrieves the role of the peer.
+   *
+   * This getter method attempts to obtain the role assigned to the peer within the session. The role can define permissions and capabilities
+   * within the session context. It first tries to get this information from the HMS peers cache. If the role information is not available in the cache,
+   * it falls back to fetching the role directly from the native layer using the peer's ID. Once a value is retrieved, it updates the local `_role`
+   * property to ensure the value is current and consistent.
+   *
+   * @returns {HMSRole | undefined} The role of the peer if available, otherwise `undefined`.
+   *
+   * @see https://www.100ms.live/docs/get-started/v2/get-started/concepts/templates-and-roles
+   */
   get role() {
     const hmsPeersCache = getHmsPeersCache();
     const value = hmsPeersCache ? hmsPeersCache.getProperty(this.peerID, 'role') : getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'role');
@@ -117,6 +218,16 @@ export class HMSPeer {
     }
     return value ?? this._role;
   }
+
+  /**
+   * Retrieves the audio track associated with the peer.
+   *
+   * This getter method attempts to obtain the audio track of the peer. It first tries to get this information from the HMS peers cache.
+   * If the audio track information is not available in the cache, it falls back to fetching the audio track directly from the native layer using the peer's ID.
+   * This allows for real-time access to the peer's audio track, which can be used for various audio-related functionalities within the application.
+   *
+   * @returns {HMSAudioTrack | undefined} The audio track of the peer if available, otherwise `undefined`.
+   */
   get audioTrack() {
     const hmsPeersCache = getHmsPeersCache();
     if (hmsPeersCache) {
@@ -124,6 +235,17 @@ export class HMSPeer {
     }
     return getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'audioTrack');
   }
+
+  /**
+   * Retrieves the video track associated with the peer.
+   *
+   * This getter method attempts to obtain the video track of the peer. It first tries to get this information from the HMS peers cache.
+   * If the video track information is not available in the cache, it falls back to fetching the video track directly from the native layer using the peer's ID.
+   * This allows for real-time access to the peer's video track, which can be used for various video-related functionalities within the application.
+   *
+   * @returns {HMSVideoTrack | undefined} The video track of the peer if available, otherwise `undefined`.
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/overview
+   */
   get videoTrack() {
     const hmsPeersCache = getHmsPeersCache();
     if (hmsPeersCache) {
@@ -131,6 +253,19 @@ export class HMSPeer {
     }
     return getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'videoTrack');
   }
+
+  /**
+   * Retrieves the auxiliary tracks associated with the peer.
+   *
+   * This getter method attempts to obtain the auxiliary tracks of the peer, which can include tracks like screen shares or additional media streams.
+   * It first tries to get this information from the HMS peers cache. If the auxiliary track information is not available in the cache,
+   * it falls back to fetching the auxiliary tracks directly from the native layer using the peer's ID.
+   * This allows for real-time access to the peer's auxiliary tracks, which can be used for various functionalities within the application,
+   * such as displaying a screen share or additional video feeds.
+   *
+   * @returns {HMSTrack[] | undefined} The auxiliary tracks of the peer if available, otherwise `undefined`.
+   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/screenshare
+   */
   get auxiliaryTracks() {
     const hmsPeersCache = getHmsPeersCache();
     if (hmsPeersCache) {
@@ -138,6 +273,20 @@ export class HMSPeer {
     }
     return getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'auxiliaryTracks');
   }
+
+  /**
+   * Retrieves the type of the peer.
+   *
+   * This getter method attempts to obtain the type of the peer, which can indicate whether the peer is a regular participant,
+   * a screen share, or another type defined within the `HMSPeerType` enum. It first tries to get this information from the HMS peers cache.
+   * If the type information is not available in the cache, it falls back to fetching the type directly from the native layer using the peer's ID.
+   * This ensures that the application has real-time access to the peer's type, which can be crucial for handling different peer types differently,
+   * such as displaying a screen share in a distinct manner. Once a value is retrieved, it updates the local `_type` property to ensure the value is current.
+   *
+   * @returns {HMSPeerType} The type of the peer, defaulting to the value stored in `_type` if the information is not available.
+   *
+   * @see https://www.100ms.live/docs/server-side/v2/how-to-guides/Session%20Initiation%20Protocol%20(SIP)/SIP-Interconnect
+   */
   get type() {
     const hmsPeersCache = getHmsPeersCache();
     const value = hmsPeersCache ? hmsPeersCache.getProperty(this.peerID, 'type') : getPeerPropertyFromNative(HMSConstants.DEFAULT_SDK_ID, this.peerID, 'type');

package/lib/module/classes/HMSPeer.js.map

@@ -1 +1 @@
-{"version":3,"names":["getHmsPeersCache","getPeerPropertyFromNative","HMSConstants","HMSPeerType","HMSPeer","_updateName","value","_name","_updateIsLocal","_isLocal","_updateIsHandRaised","_isHandRaised","_updateCustomerUserID","_customerUserID","_updateMetadata","_metadata","_updateRole","_role","_updateType","_type","constructor","params","_defineProperty","REGULAR","peerID","name","hmsPeersCache","getProperty","DEFAULT_SDK_ID","isLocal","isHandRaised","networkQuality","customerUserID","metadata","role","audioTrack","videoTrack","auxiliaryTracks","type"],"sources":["HMSPeer.ts"],"sourcesContent":["import type { HMSAudioTrack } from './HMSAudioTrack';\nimport type { HMSNetworkQuality } from './HMSNetworkQuality';\nimport type { HMSRole } from './HMSRole';\nimport type { HMSTrack } from './HMSTrack';\nimport type { HMSVideoTrack } from './HMSVideoTrack';\nimport { getHmsPeersCache, getPeerPropertyFromNative } from './HMSPeersCache';\nimport { HMSConstants } from './HMSConstants';\nimport { HMSPeerType } from './HMSPeerType';\n\nexport class HMSPeer {\n  peerID: string;\n  private _name: string | undefined;\n  private _isLocal: boolean | undefined;\n  private _customerUserID: string | undefined;\n  private _metadata: string | undefined;\n  private _role: HMSRole | undefined;\n  private _isHandRaised: boolean = false;\n  private _type: HMSPeerType = HMSPeerType.REGULAR;\n\n  private _updateName(value: string) {\n    // If `_isLocal` is outdated, update it\n    if (this._name !== value) {\n      this._name = value;\n    }\n  }\n\n  private _updateIsLocal(value: boolean) {\n    // If `_isLocal` is outdated, update it\n    if (this._isLocal !== value) {\n      this._isLocal = value;\n    }\n  }\n\n  private _updateIsHandRaised(value: boolean) {\n    // If `_isHandRaised` is outdated, update it\n    if (this._isHandRaised !== value) {\n      this._isHandRaised = value;\n    }\n  }\n\n  private _updateCustomerUserID(value: string) {\n    // If `_customerUserID` is outdated, update it\n    if (this._customerUserID !== value) {\n      this._customerUserID = value;\n    }\n  }\n\n  private _updateMetadata(value: string) {\n    // If `_metadata` is outdated, update it\n    if (this._metadata !== value) {\n      this._metadata = value;\n    }\n  }\n\n  private _updateRole(value: HMSRole) {\n    // If `_role` is outdated, update it\n    if (this._role !== value) {\n      this._role = value;\n    }\n  }\n\n  private _updateType(value: HMSPeerType) {\n    // If `_type` is outdated, update it\n    if (this._type !== value) {\n      this._type = value;\n    }\n  }\n\n  constructor(params: { peerID: string; name: string }) {\n    this.peerID = params.peerID;\n    this._name = params.name;\n  }\n\n  get name(): string | undefined {\n    if (this._name) {\n      return this._name;\n    }\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'name')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'name'\n        );\n\n    if (typeof value === 'string') {\n      this._updateName(value);\n    }\n    return value ?? this._name;\n  }\n\n  get isLocal(): boolean | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'isLocal')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'isLocal'\n        );\n\n    if (typeof value === 'boolean') {\n      this._updateIsLocal(value);\n    }\n    return value ?? this._isLocal;\n  }\n\n  get isHandRaised(): boolean {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'isHandRaised')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'isHandRaised'\n        );\n\n    if (typeof value === 'boolean') {\n      this._updateIsHandRaised(value);\n    }\n    return value ?? this._isHandRaised;\n  }\n\n  get networkQuality(): HMSNetworkQuality | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'networkQuality');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'networkQuality'\n    );\n  }\n\n  get customerUserID(): string | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'customerUserID')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'customerUserID'\n        );\n\n    if (value) {\n      this._updateCustomerUserID(value);\n    }\n    return value ?? this._customerUserID;\n  }\n\n  get metadata(): string | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'metadata')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'metadata'\n        );\n\n    if (value) {\n      this._updateMetadata(value);\n    }\n    return value ?? this._metadata;\n  }\n\n  get role(): HMSRole | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'role')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'role'\n        );\n\n    if (value) {\n      this._updateRole(value);\n    }\n    return value ?? this._role;\n  }\n\n  get audioTrack(): HMSAudioTrack | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'audioTrack');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'audioTrack'\n    );\n  }\n\n  get videoTrack(): HMSVideoTrack | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'videoTrack');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'videoTrack'\n    );\n  }\n\n  get auxiliaryTracks(): HMSTrack[] | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'auxiliaryTracks');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'auxiliaryTracks'\n    );\n  }\n\n  get type(): HMSPeerType {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'type')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'type'\n        );\n\n    if (value) {\n      this._updateType(value);\n    }\n    return value ?? this._type;\n  }\n}\n"],"mappings":";;;AAKA,SAASA,gBAAgB,EAAEC,yBAAyB,QAAQ,iBAAiB;AAC7E,SAASC,YAAY,QAAQ,gBAAgB;AAC7C,SAASC,WAAW,QAAQ,eAAe;AAE3C,OAAO,MAAMC,OAAO,CAAC;EAUXC,WAAWA,CAACC,KAAa,EAAE;IACjC;IACA,IAAI,IAAI,CAACC,KAAK,KAAKD,KAAK,EAAE;MACxB,IAAI,CAACC,KAAK,GAAGD,KAAK;IACpB;EACF;EAEQE,cAAcA,CAACF,KAAc,EAAE;IACrC;IACA,IAAI,IAAI,CAACG,QAAQ,KAAKH,KAAK,EAAE;MAC3B,IAAI,CAACG,QAAQ,GAAGH,KAAK;IACvB;EACF;EAEQI,mBAAmBA,CAACJ,KAAc,EAAE;IAC1C;IACA,IAAI,IAAI,CAACK,aAAa,KAAKL,KAAK,EAAE;MAChC,IAAI,CAACK,aAAa,GAAGL,KAAK;IAC5B;EACF;EAEQM,qBAAqBA,CAACN,KAAa,EAAE;IAC3C;IACA,IAAI,IAAI,CAACO,eAAe,KAAKP,KAAK,EAAE;MAClC,IAAI,CAACO,eAAe,GAAGP,KAAK;IAC9B;EACF;EAEQQ,eAAeA,CAACR,KAAa,EAAE;IACrC;IACA,IAAI,IAAI,CAACS,SAAS,KAAKT,KAAK,EAAE;MAC5B,IAAI,CAACS,SAAS,GAAGT,KAAK;IACxB;EACF;EAEQU,WAAWA,CAACV,KAAc,EAAE;IAClC;IACA,IAAI,IAAI,CAACW,KAAK,KAAKX,KAAK,EAAE;MACxB,IAAI,CAACW,KAAK,GAAGX,KAAK;IACpB;EACF;EAEQY,WAAWA,CAACZ,KAAkB,EAAE;IACtC;IACA,IAAI,IAAI,CAACa,KAAK,KAAKb,KAAK,EAAE;MACxB,IAAI,CAACa,KAAK,GAAGb,KAAK;IACpB;EACF;EAEAc,WAAWA,CAACC,MAAwC,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA,wBApDrB,KAAK;IAAAA,eAAA,gBACTnB,WAAW,CAACoB,OAAO;IAoD9C,IAAI,CAACC,MAAM,GAAGH,MAAM,CAACG,MAAM;IAC3B,IAAI,CAACjB,KAAK,GAAGc,MAAM,CAACI,IAAI;EAC1B;EAEA,IAAIA,IAAIA,CAAA,EAAuB;IAC7B,IAAI,IAAI,CAAClB,KAAK,EAAE;MACd,OAAO,IAAI,CAACA,KAAK;IACnB;IACA,MAAMmB,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,MAAM,CAAC,GAC9CvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,MACF,CAAC;IAEL,IAAI,OAAOlB,KAAK,KAAK,QAAQ,EAAE;MAC7B,IAAI,CAACD,WAAW,CAACC,KAAK,CAAC;IACzB;IACA,OAAOA,KAAK,IAAI,IAAI,CAACC,KAAK;EAC5B;EAEA,IAAIsB,OAAOA,CAAA,EAAwB;IACjC,MAAMH,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,SAAS,CAAC,GACjDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,SACF,CAAC;IAEL,IAAI,OAAOlB,KAAK,KAAK,SAAS,EAAE;MAC9B,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC;IAC5B;IACA,OAAOA,KAAK,IAAI,IAAI,CAACG,QAAQ;EAC/B;EAEA,IAAIqB,YAAYA,CAAA,EAAY;IAC1B,MAAMJ,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,cAAc,CAAC,GACtDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,cACF,CAAC;IAEL,IAAI,OAAOlB,KAAK,KAAK,SAAS,EAAE;MAC9B,IAAI,CAACI,mBAAmB,CAACJ,KAAK,CAAC;IACjC;IACA,OAAOA,KAAK,IAAI,IAAI,CAACK,aAAa;EACpC;EAEA,IAAIoB,cAAcA,CAAA,EAAkC;IAClD,MAAML,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,gBAAgB,CAAC;IACjE;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,gBACF,CAAC;EACH;EAEA,IAAIQ,cAAcA,CAAA,EAAuB;IACvC,MAAMN,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,gBAAgB,CAAC,GACxDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,gBACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACM,qBAAqB,CAACN,KAAK,CAAC;IACnC;IACA,OAAOA,KAAK,IAAI,IAAI,CAACO,eAAe;EACtC;EAEA,IAAIoB,QAAQA,CAAA,EAAuB;IACjC,MAAMP,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,UAAU,CAAC,GAClDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,UACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACQ,eAAe,CAACR,KAAK,CAAC;IAC7B;IACA,OAAOA,KAAK,IAAI,IAAI,CAACS,SAAS;EAChC;EAEA,IAAImB,IAAIA,CAAA,EAAwB;IAC9B,MAAMR,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,MAAM,CAAC,GAC9CvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,MACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACU,WAAW,CAACV,KAAK,CAAC;IACzB;IACA,OAAOA,KAAK,IAAI,IAAI,CAACW,KAAK;EAC5B;EAEA,IAAIkB,UAAUA,CAAA,EAA8B;IAC1C,MAAMT,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,YAAY,CAAC;IAC7D;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,YACF,CAAC;EACH;EAEA,IAAIY,UAAUA,CAAA,EAA8B;IAC1C,MAAMV,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,YAAY,CAAC;IAC7D;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,YACF,CAAC;EACH;EAEA,IAAIa,eAAeA,CAAA,EAA2B;IAC5C,MAAMX,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,iBAAiB,CAAC;IAClE;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,iBACF,CAAC;EACH;EAEA,IAAIc,IAAIA,CAAA,EAAgB;IACtB,MAAMZ,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,MAAM,CAAC,GAC9CvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,MACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACY,WAAW,CAACZ,KAAK,CAAC;IACzB;IACA,OAAOA,KAAK,IAAI,IAAI,CAACa,KAAK;EAC5B;AACF","ignoreList":[]}
+{"version":3,"names":["getHmsPeersCache","getPeerPropertyFromNative","HMSConstants","HMSPeerType","HMSPeer","_updateName","value","_name","_updateIsLocal","_isLocal","_updateIsHandRaised","_isHandRaised","_updateCustomerUserID","_customerUserID","_updateMetadata","_metadata","_updateRole","_role","_updateType","_type","constructor","params","_defineProperty","REGULAR","peerID","name","hmsPeersCache","getProperty","DEFAULT_SDK_ID","isLocal","isHandRaised","networkQuality","customerUserID","metadata","role","audioTrack","videoTrack","auxiliaryTracks","type"],"sources":["HMSPeer.ts"],"sourcesContent":["import type { HMSAudioTrack } from './HMSAudioTrack';\nimport type { HMSNetworkQuality } from './HMSNetworkQuality';\nimport type { HMSRole } from './HMSRole';\nimport type { HMSTrack } from './HMSTrack';\nimport type { HMSVideoTrack } from './HMSVideoTrack';\nimport { getHmsPeersCache, getPeerPropertyFromNative } from './HMSPeersCache';\nimport { HMSConstants } from './HMSConstants';\nimport { HMSPeerType } from './HMSPeerType';\n\n/**\n * Represents a peer in the HMS ecosystem.\n *\n * This class encapsulates the properties and state of a peer within a session, including their ID, name, role, and various status flags.\n *\n * @export\n * @class HMSPeer\n * @property {string} peerID - The unique identifier for the peer.\n * @property {string | undefined} _name - The name of the peer. Private access.\n * @property {boolean | undefined} _isLocal - Flag indicating whether the peer is the local user. Private access.\n * @property {string | undefined} _customerUserID - An optional custom user ID set by the application. Private access.\n * @property {string | undefined} _metadata - Optional metadata associated with the peer. Private access.\n * @property {HMSRole | undefined} _role - The role assigned to the peer within the session. Private access.\n * @property {boolean} _isHandRaised - Flag indicating whether the peer has raised their hand. Defaults to false. Private access.\n * @property {HMSPeerType} _type - The type of the peer, e.g., regular, screen share. Defaults to `HMSPeerType.REGULAR`. Private access.\n */\nexport class HMSPeer {\n  peerID: string;\n  private _name: string | undefined;\n  private _isLocal: boolean | undefined;\n  private _customerUserID: string | undefined;\n  private _metadata: string | undefined;\n  private _role: HMSRole | undefined;\n  private _isHandRaised: boolean = false;\n  private _type: HMSPeerType = HMSPeerType.REGULAR;\n\n  private _updateName(value: string) {\n    // If `_isLocal` is outdated, update it\n    if (this._name !== value) {\n      this._name = value;\n    }\n  }\n\n  private _updateIsLocal(value: boolean) {\n    // If `_isLocal` is outdated, update it\n    if (this._isLocal !== value) {\n      this._isLocal = value;\n    }\n  }\n\n  private _updateIsHandRaised(value: boolean) {\n    // If `_isHandRaised` is outdated, update it\n    if (this._isHandRaised !== value) {\n      this._isHandRaised = value;\n    }\n  }\n\n  private _updateCustomerUserID(value: string) {\n    // If `_customerUserID` is outdated, update it\n    if (this._customerUserID !== value) {\n      this._customerUserID = value;\n    }\n  }\n\n  private _updateMetadata(value: string) {\n    // If `_metadata` is outdated, update it\n    if (this._metadata !== value) {\n      this._metadata = value;\n    }\n  }\n\n  private _updateRole(value: HMSRole) {\n    // If `_role` is outdated, update it\n    if (this._role !== value) {\n      this._role = value;\n    }\n  }\n\n  private _updateType(value: HMSPeerType) {\n    // If `_type` is outdated, update it\n    if (this._type !== value) {\n      this._type = value;\n    }\n  }\n\n  constructor(params: { peerID: string; name: string }) {\n    this.peerID = params.peerID;\n    this._name = params.name;\n  }\n\n  /**\n   * Gets the name of the peer.\n   *\n   * This getter method retrieves the name of the peer. If the name has already been set locally, it returns that value.\n   * Otherwise, it attempts to retrieve the name from the HMS peers cache. If the cache does not contain the name,\n   * it falls back to fetching the name directly from the native layer using the peer's ID.\n   * Once a value is retrieved, it updates the local `_name` property to ensure consistency.\n   *\n   * @returns {string | undefined} The name of the peer if available, otherwise `undefined`.\n   */\n  get name(): string | undefined {\n    if (this._name) {\n      return this._name;\n    }\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'name')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'name'\n        );\n\n    if (typeof value === 'string') {\n      this._updateName(value);\n    }\n    return value ?? this._name;\n  }\n\n  /**\n   * Determines if the peer is the local user.\n   *\n   * This getter method checks if the peer is the local user by first attempting to retrieve the 'isLocal' property value from the HMS peers cache.\n   * If the value is not found in the cache, it falls back to fetching the property directly from the native layer using the peer's ID.\n   * Once a value is retrieved, it updates the local `_isLocal` property to ensure the value is current.\n   *\n   * @returns {boolean | undefined} True if the peer is the local user, false otherwise. Returns `undefined` if the information is not available.\n   */\n  get isLocal(): boolean | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'isLocal')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'isLocal'\n        );\n\n    if (typeof value === 'boolean') {\n      this._updateIsLocal(value);\n    }\n    return value ?? this._isLocal;\n  }\n\n  /**\n   * Checks if the peer has raised their hand.\n   *\n   * This getter method determines whether the peer has their hand raised in the session. It first attempts to retrieve the 'isHandRaised' property value\n   * from the HMS peers cache. If the value is not found in the cache, it falls back to fetching the property directly from the native layer using the peer's ID.\n   * Once a value is retrieved, it updates the local `_isHandRaised` property to ensure the value is current and consistent.\n   *\n   * @returns {boolean} True if the peer has their hand raised, false otherwise. Defaults to false if the information is not available.\n   *\n   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/large-room\n   *\n   */\n  get isHandRaised(): boolean {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'isHandRaised')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'isHandRaised'\n        );\n\n    if (typeof value === 'boolean') {\n      this._updateIsHandRaised(value);\n    }\n    return value ?? this._isHandRaised;\n  }\n\n  /**\n   * Retrieves the network quality of the peer.\n   *\n   * This getter method attempts to obtain the network quality of the peer, which is an indicator of the current network conditions affecting the peer's connection.\n   * It first tries to get this information from the HMS peers cache. If the information is not available in the cache,\n   * it falls back to fetching the network quality directly from the native layer using the peer's ID.\n   * The network quality is represented by the `HMSNetworkQuality` type, which may include values such as 'good', 'poor', etc., depending on the implementation.\n   *\n   * @returns {HMSNetworkQuality | undefined} The network quality of the peer if available, otherwise `undefined`.\n   *\n   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/measure-network-quality-and-performance/network-quality\n   */\n  get networkQuality(): HMSNetworkQuality | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'networkQuality');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'networkQuality'\n    );\n  }\n\n  /**\n   * Retrieves the custom user ID of the peer.\n   *\n   * This getter method attempts to obtain the custom user ID of the peer, which is an optional identifier that can be set by the application.\n   * It first tries to get this information from the HMS peers cache. If the information is not available in the cache,\n   * it falls back to fetching the custom user ID directly from the native layer using the peer's ID.\n   * Once a value is retrieved, it updates the local `_customerUserID` property to ensure the value is current and consistent.\n   *\n   * @returns {string | undefined} The custom user ID of the peer if available, otherwise `undefined`.\n   */\n  get customerUserID(): string | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'customerUserID')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'customerUserID'\n        );\n\n    if (value) {\n      this._updateCustomerUserID(value);\n    }\n    return value ?? this._customerUserID;\n  }\n\n  /**\n   * Retrieves the metadata associated with the peer.\n   *\n   * This getter method attempts to obtain the metadata of the peer, which can include any additional information set by the application.\n   * It first tries to get this information from the HMS peers cache. If the information is not available in the cache,\n   * it falls back to fetching the metadata directly from the native layer using the peer's ID.\n   * Once a value is retrieved, it updates the local `_metadata` property to ensure the value is current and consistent.\n   *\n   * @returns {string | undefined} The metadata of the peer if available, otherwise `undefined`.\n   *\n   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/interact-with-room/peer/change-metadata\n   */\n  get metadata(): string | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'metadata')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'metadata'\n        );\n\n    if (value) {\n      this._updateMetadata(value);\n    }\n    return value ?? this._metadata;\n  }\n\n  /**\n   * Retrieves the role of the peer.\n   *\n   * This getter method attempts to obtain the role assigned to the peer within the session. The role can define permissions and capabilities\n   * within the session context. It first tries to get this information from the HMS peers cache. If the role information is not available in the cache,\n   * it falls back to fetching the role directly from the native layer using the peer's ID. Once a value is retrieved, it updates the local `_role`\n   * property to ensure the value is current and consistent.\n   *\n   * @returns {HMSRole | undefined} The role of the peer if available, otherwise `undefined`.\n   *\n   * @see https://www.100ms.live/docs/get-started/v2/get-started/concepts/templates-and-roles\n   */\n  get role(): HMSRole | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'role')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'role'\n        );\n\n    if (value) {\n      this._updateRole(value);\n    }\n    return value ?? this._role;\n  }\n\n  /**\n   * Retrieves the audio track associated with the peer.\n   *\n   * This getter method attempts to obtain the audio track of the peer. It first tries to get this information from the HMS peers cache.\n   * If the audio track information is not available in the cache, it falls back to fetching the audio track directly from the native layer using the peer's ID.\n   * This allows for real-time access to the peer's audio track, which can be used for various audio-related functionalities within the application.\n   *\n   * @returns {HMSAudioTrack | undefined} The audio track of the peer if available, otherwise `undefined`.\n   */\n  get audioTrack(): HMSAudioTrack | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'audioTrack');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'audioTrack'\n    );\n  }\n\n  /**\n   * Retrieves the video track associated with the peer.\n   *\n   * This getter method attempts to obtain the video track of the peer. It first tries to get this information from the HMS peers cache.\n   * If the video track information is not available in the cache, it falls back to fetching the video track directly from the native layer using the peer's ID.\n   * This allows for real-time access to the peer's video track, which can be used for various video-related functionalities within the application.\n   *\n   * @returns {HMSVideoTrack | undefined} The video track of the peer if available, otherwise `undefined`.\n   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/render-video/overview\n   */\n  get videoTrack(): HMSVideoTrack | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'videoTrack');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'videoTrack'\n    );\n  }\n\n  /**\n   * Retrieves the auxiliary tracks associated with the peer.\n   *\n   * This getter method attempts to obtain the auxiliary tracks of the peer, which can include tracks like screen shares or additional media streams.\n   * It first tries to get this information from the HMS peers cache. If the auxiliary track information is not available in the cache,\n   * it falls back to fetching the auxiliary tracks directly from the native layer using the peer's ID.\n   * This allows for real-time access to the peer's auxiliary tracks, which can be used for various functionalities within the application,\n   * such as displaying a screen share or additional video feeds.\n   *\n   * @returns {HMSTrack[] | undefined} The auxiliary tracks of the peer if available, otherwise `undefined`.\n   * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/set-up-video-conferencing/screenshare\n   */\n  get auxiliaryTracks(): HMSTrack[] | undefined {\n    const hmsPeersCache = getHmsPeersCache();\n\n    if (hmsPeersCache) {\n      return hmsPeersCache.getProperty(this.peerID, 'auxiliaryTracks');\n    }\n\n    return getPeerPropertyFromNative(\n      HMSConstants.DEFAULT_SDK_ID,\n      this.peerID,\n      'auxiliaryTracks'\n    );\n  }\n\n  /**\n   * Retrieves the type of the peer.\n   *\n   * This getter method attempts to obtain the type of the peer, which can indicate whether the peer is a regular participant,\n   * a screen share, or another type defined within the `HMSPeerType` enum. It first tries to get this information from the HMS peers cache.\n   * If the type information is not available in the cache, it falls back to fetching the type directly from the native layer using the peer's ID.\n   * This ensures that the application has real-time access to the peer's type, which can be crucial for handling different peer types differently,\n   * such as displaying a screen share in a distinct manner. Once a value is retrieved, it updates the local `_type` property to ensure the value is current.\n   *\n   * @returns {HMSPeerType} The type of the peer, defaulting to the value stored in `_type` if the information is not available.\n   *\n   * @see https://www.100ms.live/docs/server-side/v2/how-to-guides/Session%20Initiation%20Protocol%20(SIP)/SIP-Interconnect\n   */\n  get type(): HMSPeerType {\n    const hmsPeersCache = getHmsPeersCache();\n\n    const value = hmsPeersCache\n      ? hmsPeersCache.getProperty(this.peerID, 'type')\n      : getPeerPropertyFromNative(\n          HMSConstants.DEFAULT_SDK_ID,\n          this.peerID,\n          'type'\n        );\n\n    if (value) {\n      this._updateType(value);\n    }\n    return value ?? this._type;\n  }\n}\n"],"mappings":";;;AAKA,SAASA,gBAAgB,EAAEC,yBAAyB,QAAQ,iBAAiB;AAC7E,SAASC,YAAY,QAAQ,gBAAgB;AAC7C,SAASC,WAAW,QAAQ,eAAe;;AAE3C;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMC,OAAO,CAAC;EAUXC,WAAWA,CAACC,KAAa,EAAE;IACjC;IACA,IAAI,IAAI,CAACC,KAAK,KAAKD,KAAK,EAAE;MACxB,IAAI,CAACC,KAAK,GAAGD,KAAK;IACpB;EACF;EAEQE,cAAcA,CAACF,KAAc,EAAE;IACrC;IACA,IAAI,IAAI,CAACG,QAAQ,KAAKH,KAAK,EAAE;MAC3B,IAAI,CAACG,QAAQ,GAAGH,KAAK;IACvB;EACF;EAEQI,mBAAmBA,CAACJ,KAAc,EAAE;IAC1C;IACA,IAAI,IAAI,CAACK,aAAa,KAAKL,KAAK,EAAE;MAChC,IAAI,CAACK,aAAa,GAAGL,KAAK;IAC5B;EACF;EAEQM,qBAAqBA,CAACN,KAAa,EAAE;IAC3C;IACA,IAAI,IAAI,CAACO,eAAe,KAAKP,KAAK,EAAE;MAClC,IAAI,CAACO,eAAe,GAAGP,KAAK;IAC9B;EACF;EAEQQ,eAAeA,CAACR,KAAa,EAAE;IACrC;IACA,IAAI,IAAI,CAACS,SAAS,KAAKT,KAAK,EAAE;MAC5B,IAAI,CAACS,SAAS,GAAGT,KAAK;IACxB;EACF;EAEQU,WAAWA,CAACV,KAAc,EAAE;IAClC;IACA,IAAI,IAAI,CAACW,KAAK,KAAKX,KAAK,EAAE;MACxB,IAAI,CAACW,KAAK,GAAGX,KAAK;IACpB;EACF;EAEQY,WAAWA,CAACZ,KAAkB,EAAE;IACtC;IACA,IAAI,IAAI,CAACa,KAAK,KAAKb,KAAK,EAAE;MACxB,IAAI,CAACa,KAAK,GAAGb,KAAK;IACpB;EACF;EAEAc,WAAWA,CAACC,MAAwC,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA,wBApDrB,KAAK;IAAAA,eAAA,gBACTnB,WAAW,CAACoB,OAAO;IAoD9C,IAAI,CAACC,MAAM,GAAGH,MAAM,CAACG,MAAM;IAC3B,IAAI,CAACjB,KAAK,GAAGc,MAAM,CAACI,IAAI;EAC1B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIA,IAAIA,CAAA,EAAuB;IAC7B,IAAI,IAAI,CAAClB,KAAK,EAAE;MACd,OAAO,IAAI,CAACA,KAAK;IACnB;IACA,MAAMmB,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,MAAM,CAAC,GAC9CvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,MACF,CAAC;IAEL,IAAI,OAAOlB,KAAK,KAAK,QAAQ,EAAE;MAC7B,IAAI,CAACD,WAAW,CAACC,KAAK,CAAC;IACzB;IACA,OAAOA,KAAK,IAAI,IAAI,CAACC,KAAK;EAC5B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIsB,OAAOA,CAAA,EAAwB;IACjC,MAAMH,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,SAAS,CAAC,GACjDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,SACF,CAAC;IAEL,IAAI,OAAOlB,KAAK,KAAK,SAAS,EAAE;MAC9B,IAAI,CAACE,cAAc,CAACF,KAAK,CAAC;IAC5B;IACA,OAAOA,KAAK,IAAI,IAAI,CAACG,QAAQ;EAC/B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIqB,YAAYA,CAAA,EAAY;IAC1B,MAAMJ,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,cAAc,CAAC,GACtDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,cACF,CAAC;IAEL,IAAI,OAAOlB,KAAK,KAAK,SAAS,EAAE;MAC9B,IAAI,CAACI,mBAAmB,CAACJ,KAAK,CAAC;IACjC;IACA,OAAOA,KAAK,IAAI,IAAI,CAACK,aAAa;EACpC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIoB,cAAcA,CAAA,EAAkC;IAClD,MAAML,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,gBAAgB,CAAC;IACjE;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,gBACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIQ,cAAcA,CAAA,EAAuB;IACvC,MAAMN,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,gBAAgB,CAAC,GACxDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,gBACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACM,qBAAqB,CAACN,KAAK,CAAC;IACnC;IACA,OAAOA,KAAK,IAAI,IAAI,CAACO,eAAe;EACtC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIoB,QAAQA,CAAA,EAAuB;IACjC,MAAMP,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,UAAU,CAAC,GAClDvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,UACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACQ,eAAe,CAACR,KAAK,CAAC;IAC7B;IACA,OAAOA,KAAK,IAAI,IAAI,CAACS,SAAS;EAChC;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAImB,IAAIA,CAAA,EAAwB;IAC9B,MAAMR,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,MAAM,CAAC,GAC9CvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,MACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACU,WAAW,CAACV,KAAK,CAAC;IACzB;IACA,OAAOA,KAAK,IAAI,IAAI,CAACW,KAAK;EAC5B;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIkB,UAAUA,CAAA,EAA8B;IAC1C,MAAMT,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,YAAY,CAAC;IAC7D;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,YACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIY,UAAUA,CAAA,EAA8B;IAC1C,MAAMV,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,YAAY,CAAC;IAC7D;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,YACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIa,eAAeA,CAAA,EAA2B;IAC5C,MAAMX,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,IAAI0B,aAAa,EAAE;MACjB,OAAOA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,iBAAiB,CAAC;IAClE;IAEA,OAAOvB,yBAAyB,CAC9BC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,iBACF,CAAC;EACH;;EAEA;AACF;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;EACE,IAAIc,IAAIA,CAAA,EAAgB;IACtB,MAAMZ,aAAa,GAAG1B,gBAAgB,CAAC,CAAC;IAExC,MAAMM,KAAK,GAAGoB,aAAa,GACvBA,aAAa,CAACC,WAAW,CAAC,IAAI,CAACH,MAAM,EAAE,MAAM,CAAC,GAC9CvB,yBAAyB,CACvBC,YAAY,CAAC0B,cAAc,EAC3B,IAAI,CAACJ,MAAM,EACX,MACF,CAAC;IAEL,IAAIlB,KAAK,EAAE;MACT,IAAI,CAACY,WAAW,CAACZ,KAAK,CAAC;IACzB;IACA,OAAOA,KAAK,IAAI,IAAI,CAACa,KAAK;EAC5B;AACF","ignoreList":[]}

package/lib/module/classes/HMSPeerType.js

@@ -1,7 +1,18 @@
+/**
+ * Enum for HMSPeerType.
+ *
+ * Defines the types of peers within the HMS (100ms) system. This enumeration is used to distinguish between different
+ * kinds of peers, such as SIP (Session Initiation Protocol) peers and regular peers. Each peer type has specific
+ * characteristics and roles within the video conferencing or communication context.
+ *
+ * @enum {string}
+ *
+ * @see https://www.100ms.live/docs/server-side/v2/how-to-guides/Session%20Initiation%20Protocol%20(SIP)/SIP-Interconnect
+ */
 export let HMSPeerType = /*#__PURE__*/function (HMSPeerType) {
   HMSPeerType["SIP"] = "SIP";
   HMSPeerType["REGULAR"] = "REGULAR";
   return HMSPeerType;
-}({});
+}({}); // Represents a regular peer, such as a standard user in a video call.
 export const HMSPeerTypeOrdinals = new Map([['0', HMSPeerType.SIP], ['1', HMSPeerType.REGULAR]]);
 //# sourceMappingURL=HMSPeerType.js.map

package/lib/module/classes/HMSPeerType.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSPeerType","HMSPeerTypeOrdinals","Map","SIP","REGULAR"],"sources":["HMSPeerType.ts"],"sourcesContent":["export enum HMSPeerType {\n  SIP = 'SIP',\n  REGULAR = 'REGULAR',\n}\n\nexport const HMSPeerTypeOrdinals = new Map([\n  ['0', HMSPeerType.SIP],\n  ['1', HMSPeerType.REGULAR],\n]);\n"],"mappings":"AAAA,WAAYA,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAKvB,OAAO,MAAMC,mBAAmB,GAAG,IAAIC,GAAG,CAAC,CACzC,CAAC,GAAG,EAAEF,WAAW,CAACG,GAAG,CAAC,EACtB,CAAC,GAAG,EAAEH,WAAW,CAACI,OAAO,CAAC,CAC3B,CAAC","ignoreList":[]}
+{"version":3,"names":["HMSPeerType","HMSPeerTypeOrdinals","Map","SIP","REGULAR"],"sources":["HMSPeerType.ts"],"sourcesContent":["/**\n * Enum for HMSPeerType.\n *\n * Defines the types of peers within the HMS (100ms) system. This enumeration is used to distinguish between different\n * kinds of peers, such as SIP (Session Initiation Protocol) peers and regular peers. Each peer type has specific\n * characteristics and roles within the video conferencing or communication context.\n *\n * @enum {string}\n *\n * @see https://www.100ms.live/docs/server-side/v2/how-to-guides/Session%20Initiation%20Protocol%20(SIP)/SIP-Interconnect\n */\nexport enum HMSPeerType {\n  SIP = 'SIP', // Represents a SIP peer, typically used for integrating with traditional telephony systems.\n  REGULAR = 'REGULAR', // Represents a regular peer, such as a standard user in a video call.\n}\n\nexport const HMSPeerTypeOrdinals = new Map([\n  ['0', HMSPeerType.SIP],\n  ['1', HMSPeerType.REGULAR],\n]);\n"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,WAAYA,WAAW,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA,OAEA;AAGvB,OAAO,MAAMC,mBAAmB,GAAG,IAAIC,GAAG,CAAC,CACzC,CAAC,GAAG,EAAEF,WAAW,CAACG,GAAG,CAAC,EACtB,CAAC,GAAG,EAAEH,WAAW,CAACI,OAAO,CAAC,CAC3B,CAAC","ignoreList":[]}

package/lib/module/classes/HMSRTMPConfig.js

@@ -1,6 +1,20 @@
 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); }
+/**
+ * Configuration class for RTMP streaming in the HMS (100ms) system.
+ *
+ * This class encapsulates the settings required to configure RTMP (Real-Time Messaging Protocol) streaming for a meeting.
+ * It includes options for the meeting URL, RTMP URLs for streaming, whether recording should be enabled, and the video resolution for the stream.
+ *
+ * @param {Object} params - The constructor parameters.
+ * @param {string} [params.meetingURL] - The URL of the meeting to be streamed. Optional.
+ * @param {Array<string>} [params.rtmpURLs] - An array of RTMP URLs to which the meeting will be streamed. Optional.
+ * @param {boolean} params.record - Flag indicating whether the stream should be recorded.
+ * @param {HMSRtmpVideoResolution} [params.resolution] - The resolution of the video to be streamed. Optional.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/recording
+ */
 export class HMSRTMPConfig {
   constructor(params) {
     _defineProperty(this, "meetingURL", void 0);

package/lib/module/classes/HMSRTMPConfig.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSRTMPConfig","constructor","params","_defineProperty","meetingURL","rtmpURLs","record","resolution"],"sources":["HMSRTMPConfig.ts"],"sourcesContent":["import type { HMSRtmpVideoResolution } from './HMSRtmpVideoResolution';\n\nexport class HMSRTMPConfig {\n  meetingURL?: string;\n  rtmpURLs?: Array<string>;\n  record: boolean;\n  resolution?: HMSRtmpVideoResolution;\n\n  constructor(params: {\n    meetingURL?: string;\n    rtmpURLs?: Array<string>;\n    record: boolean;\n    resolution?: HMSRtmpVideoResolution;\n  }) {\n    this.meetingURL = params.meetingURL;\n    this.rtmpURLs = params.rtmpURLs;\n    this.record = params.record;\n    this.resolution = params.resolution;\n  }\n}\n"],"mappings":";;;AAEA,OAAO,MAAMA,aAAa,CAAC;EAMzBC,WAAWA,CAACC,MAKX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAI,CAACC,UAAU,GAAGF,MAAM,CAACE,UAAU;IACnC,IAAI,CAACC,QAAQ,GAAGH,MAAM,CAACG,QAAQ;IAC/B,IAAI,CAACC,MAAM,GAAGJ,MAAM,CAACI,MAAM;IAC3B,IAAI,CAACC,UAAU,GAAGL,MAAM,CAACK,UAAU;EACrC;AACF","ignoreList":[]}
+{"version":3,"names":["HMSRTMPConfig","constructor","params","_defineProperty","meetingURL","rtmpURLs","record","resolution"],"sources":["HMSRTMPConfig.ts"],"sourcesContent":["import type { HMSRtmpVideoResolution } from './HMSRtmpVideoResolution';\n\n/**\n * Configuration class for RTMP streaming in the HMS (100ms) system.\n *\n * This class encapsulates the settings required to configure RTMP (Real-Time Messaging Protocol) streaming for a meeting.\n * It includes options for the meeting URL, RTMP URLs for streaming, whether recording should be enabled, and the video resolution for the stream.\n *\n * @param {Object} params - The constructor parameters.\n * @param {string} [params.meetingURL] - The URL of the meeting to be streamed. Optional.\n * @param {Array<string>} [params.rtmpURLs] - An array of RTMP URLs to which the meeting will be streamed. Optional.\n * @param {boolean} params.record - Flag indicating whether the stream should be recorded.\n * @param {HMSRtmpVideoResolution} [params.resolution] - The resolution of the video to be streamed. Optional.\n *\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/recording\n */\nexport class HMSRTMPConfig {\n  meetingURL?: string;\n  rtmpURLs?: Array<string>;\n  record: boolean;\n  resolution?: HMSRtmpVideoResolution;\n\n  constructor(params: {\n    meetingURL?: string;\n    rtmpURLs?: Array<string>;\n    record: boolean;\n    resolution?: HMSRtmpVideoResolution;\n  }) {\n    this.meetingURL = params.meetingURL;\n    this.rtmpURLs = params.rtmpURLs;\n    this.record = params.record;\n    this.resolution = params.resolution;\n  }\n}\n"],"mappings":";;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,aAAa,CAAC;EAMzBC,WAAWA,CAACC,MAKX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAI,CAACC,UAAU,GAAGF,MAAM,CAACE,UAAU;IACnC,IAAI,CAACC,QAAQ,GAAGH,MAAM,CAACG,QAAQ;IAC/B,IAAI,CAACC,MAAM,GAAGJ,MAAM,CAACI,MAAM;IAC3B,IAAI,CAACC,UAAU,GAAGL,MAAM,CAACK,UAAU;EACrC;AACF","ignoreList":[]}

package/lib/module/classes/HMSRole.js

@@ -1,6 +1,23 @@
 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 a role within the HMS ecosystem.
+ *
+ * A role defines the capabilities and permissions a user has in a session, such as publishing or subscribing to streams,
+ * and the priority of the user in the session. This class encapsulates the properties of a role, including its name,
+ * publishing settings, subscribing settings, permissions, and priority.
+ *
+ * @class HMSRole
+ * @property {string} [name] - The name of the role.
+ * @property {HMSPublishSettings} [publishSettings] - Settings related to publishing streams for this role.
+ * @property {HMSSubscribeSettings} [subscribeSettings] - Settings related to subscribing to streams for this role.
+ * @property {HMSPermissions} [permissions] - Permissions granted to this role.
+ * @property {number} [priority] - The priority of the role, determining its precedence in the session.
+ *
+ * @see https://www.100ms.live/docs/get-started/v2/get-started/concepts/templates-and-roles
+ *
+ */
 export class HMSRole {
   constructor(params) {
     _defineProperty(this, "name", void 0);

package/lib/module/classes/HMSRole.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSRole","constructor","params","_defineProperty","name","priority","permissions","publishSettings","subscribeSettings"],"sources":["HMSRole.ts"],"sourcesContent":["import type { HMSPermissions } from './HMSPermissions';\nimport type { HMSPublishSettings } from './HMSPublishSettings';\nimport type { HMSSubscribeSettings } from './HMSSubscribeSettings';\n\nexport class HMSRole {\n  name?: string;\n  publishSettings?: HMSPublishSettings;\n  subscribeSettings?: HMSSubscribeSettings;\n  permissions?: HMSPermissions;\n  priority?: number;\n\n  constructor(params?: {\n    name?: string;\n    priority?: number;\n    permissions?: HMSPermissions;\n    publishSettings?: HMSPublishSettings;\n    subscribeSettings?: HMSSubscribeSettings;\n  }) {\n    if (params) {\n      this.name = params.name;\n      this.priority = params.priority;\n      this.permissions = params.permissions;\n      this.publishSettings = params.publishSettings;\n      this.subscribeSettings = params.subscribeSettings;\n    }\n  }\n}\n"],"mappings":";;;AAIA,OAAO,MAAMA,OAAO,CAAC;EAOnBC,WAAWA,CAACC,MAMX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAID,MAAM,EAAE;MACV,IAAI,CAACE,IAAI,GAAGF,MAAM,CAACE,IAAI;MACvB,IAAI,CAACC,QAAQ,GAAGH,MAAM,CAACG,QAAQ;MAC/B,IAAI,CAACC,WAAW,GAAGJ,MAAM,CAACI,WAAW;MACrC,IAAI,CAACC,eAAe,GAAGL,MAAM,CAACK,eAAe;MAC7C,IAAI,CAACC,iBAAiB,GAAGN,MAAM,CAACM,iBAAiB;IACnD;EACF;AACF","ignoreList":[]}
+{"version":3,"names":["HMSRole","constructor","params","_defineProperty","name","priority","permissions","publishSettings","subscribeSettings"],"sources":["HMSRole.ts"],"sourcesContent":["import type { HMSPermissions } from './HMSPermissions';\nimport type { HMSPublishSettings } from './HMSPublishSettings';\nimport type { HMSSubscribeSettings } from './HMSSubscribeSettings';\n\n/**\n * Represents a role within the HMS ecosystem.\n *\n * A role defines the capabilities and permissions a user has in a session, such as publishing or subscribing to streams,\n * and the priority of the user in the session. This class encapsulates the properties of a role, including its name,\n * publishing settings, subscribing settings, permissions, and priority.\n *\n * @class HMSRole\n * @property {string} [name] - The name of the role.\n * @property {HMSPublishSettings} [publishSettings] - Settings related to publishing streams for this role.\n * @property {HMSSubscribeSettings} [subscribeSettings] - Settings related to subscribing to streams for this role.\n * @property {HMSPermissions} [permissions] - Permissions granted to this role.\n * @property {number} [priority] - The priority of the role, determining its precedence in the session.\n *\n * @see https://www.100ms.live/docs/get-started/v2/get-started/concepts/templates-and-roles\n *\n */\nexport class HMSRole {\n  name?: string;\n  publishSettings?: HMSPublishSettings;\n  subscribeSettings?: HMSSubscribeSettings;\n  permissions?: HMSPermissions;\n  priority?: number;\n\n  constructor(params?: {\n    name?: string;\n    priority?: number;\n    permissions?: HMSPermissions;\n    publishSettings?: HMSPublishSettings;\n    subscribeSettings?: HMSSubscribeSettings;\n  }) {\n    if (params) {\n      this.name = params.name;\n      this.priority = params.priority;\n      this.permissions = params.permissions;\n      this.publishSettings = params.publishSettings;\n      this.subscribeSettings = params.subscribeSettings;\n    }\n  }\n}\n"],"mappings":";;;AAIA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,OAAO,CAAC;EAOnBC,WAAWA,CAACC,MAMX,EAAE;IAAAC,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IAAAA,eAAA;IACD,IAAID,MAAM,EAAE;MACV,IAAI,CAACE,IAAI,GAAGF,MAAM,CAACE,IAAI;MACvB,IAAI,CAACC,QAAQ,GAAGH,MAAM,CAACG,QAAQ;MAC/B,IAAI,CAACC,WAAW,GAAGJ,MAAM,CAACI,WAAW;MACrC,IAAI,CAACC,eAAe,GAAGL,MAAM,CAACK,eAAe;MAC7C,IAAI,CAACC,iBAAiB,GAAGN,MAAM,CAACM,iBAAiB;IACnD;EACF;AACF","ignoreList":[]}

package/lib/module/classes/HMSRtmpVideoResolution.js

@@ -1,6 +1,19 @@
 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 video resolution for RTMP streaming in the HMS (100ms) system.
+ *
+ * This class encapsulates the dimensions (height and width) of the video resolution to be used for RTMP streaming.
+ * It allows for specifying the video quality by defining the resolution, which is crucial for optimizing the streaming experience
+ * based on the bandwidth available and the requirements of the streaming platform.
+ *
+ * @param {Object} params - The constructor parameters.
+ * @param {number} params.height - The height of the video resolution.
+ * @param {number} params.width - The width of the video resolution.
+ *
+ * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/recording
+ */
 export class HMSRtmpVideoResolution {
   constructor(params) {
     _defineProperty(this, "height", void 0);

package/lib/module/classes/HMSRtmpVideoResolution.js.map

@@ -1 +1 @@
-{"version":3,"names":["HMSRtmpVideoResolution","constructor","params","_defineProperty","height","width"],"sources":["HMSRtmpVideoResolution.ts"],"sourcesContent":["export class HMSRtmpVideoResolution {\n  height: number;\n  width: number;\n\n  constructor(params: { height: number; width: number }) {\n    this.height = params.height;\n    this.width = params.width;\n  }\n}\n"],"mappings":";;;AAAA,OAAO,MAAMA,sBAAsB,CAAC;EAIlCC,WAAWA,CAACC,MAAyC,EAAE;IAAAC,eAAA;IAAAA,eAAA;IACrD,IAAI,CAACC,MAAM,GAAGF,MAAM,CAACE,MAAM;IAC3B,IAAI,CAACC,KAAK,GAAGH,MAAM,CAACG,KAAK;EAC3B;AACF","ignoreList":[]}
+{"version":3,"names":["HMSRtmpVideoResolution","constructor","params","_defineProperty","height","width"],"sources":["HMSRtmpVideoResolution.ts"],"sourcesContent":["/**\n * Represents the video resolution for RTMP streaming in the HMS (100ms) system.\n *\n * This class encapsulates the dimensions (height and width) of the video resolution to be used for RTMP streaming.\n * It allows for specifying the video quality by defining the resolution, which is crucial for optimizing the streaming experience\n * based on the bandwidth available and the requirements of the streaming platform.\n *\n * @param {Object} params - The constructor parameters.\n * @param {number} params.height - The height of the video resolution.\n * @param {number} params.width - The width of the video resolution.\n *\n * @see https://www.100ms.live/docs/react-native/v2/how-to-guides/record-and-live-stream/recording\n */\nexport class HMSRtmpVideoResolution {\n  height: number;\n  width: number;\n\n  constructor(params: { height: number; width: number }) {\n    this.height = params.height;\n    this.width = params.width;\n  }\n}\n"],"mappings":";;;AAAA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA,OAAO,MAAMA,sBAAsB,CAAC;EAIlCC,WAAWA,CAACC,MAAyC,EAAE;IAAAC,eAAA;IAAAA,eAAA;IACrD,IAAI,CAACC,MAAM,GAAGF,MAAM,CAACE,MAAM;IAC3B,IAAI,CAACC,KAAK,GAAGH,MAAM,CAACG,KAAK;EAC3B;AACF","ignoreList":[]}