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

package/lib/commonjs/classes/HMSPeerType.js

@@ -4,10 +4,21 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.HMSPeerTypeOrdinals = exports.HMSPeerType = void 0;
+/**
+ * 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
+ */
 let HMSPeerType = exports.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.
 const HMSPeerTypeOrdinals = exports.HMSPeerTypeOrdinals = new Map([['0', HMSPeerType.SIP], ['1', HMSPeerType.REGULAR]]);
 //# sourceMappingURL=HMSPeerType.js.map

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

@@ -1 +1 @@
-{"version":3,"names":["HMSPeerType","exports","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":";;;;;;IAAYA,WAAW,GAAAC,OAAA,CAAAD,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA;AAKhB,MAAME,mBAAmB,GAAAD,OAAA,CAAAC,mBAAA,GAAG,IAAIC,GAAG,CAAC,CACzC,CAAC,GAAG,EAAEH,WAAW,CAACI,GAAG,CAAC,EACtB,CAAC,GAAG,EAAEJ,WAAW,CAACK,OAAO,CAAC,CAC3B,CAAC","ignoreList":[]}
+{"version":3,"names":["HMSPeerType","exports","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;AAVA,IAWYA,WAAW,GAAAC,OAAA,CAAAD,WAAA,0BAAXA,WAAW;EAAXA,WAAW;EAAXA,WAAW;EAAA,OAAXA,WAAW;AAAA,OAEA;AAGhB,MAAME,mBAAmB,GAAAD,OAAA,CAAAC,mBAAA,GAAG,IAAIC,GAAG,CAAC,CACzC,CAAC,GAAG,EAAEH,WAAW,CAACI,GAAG,CAAC,EACtB,CAAC,GAAG,EAAEJ,WAAW,CAACK,OAAO,CAAC,CAC3B,CAAC","ignoreList":[]}

package/lib/commonjs/classes/HMSRTMPConfig.js

@@ -7,6 +7,20 @@ exports.HMSRTMPConfig = 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); }
+/**
+ * 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
+ */
 class HMSRTMPConfig {
   constructor(params) {
     _defineProperty(this, "meetingURL", void 0);

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

@@ -1 +1 @@
-{"version":3,"names":["HMSRTMPConfig","constructor","params","_defineProperty","meetingURL","rtmpURLs","record","resolution","exports"],"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":";;;;;;;;;AAEO,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;AAACC,OAAA,CAAAR,aAAA,GAAAA,aAAA","ignoreList":[]}
+{"version":3,"names":["HMSRTMPConfig","constructor","params","_defineProperty","meetingURL","rtmpURLs","record","resolution","exports"],"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;AACO,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;AAACC,OAAA,CAAAR,aAAA,GAAAA,aAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSRole.js

@@ -7,6 +7,23 @@ exports.HMSRole = 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 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
+ *
+ */
 class HMSRole {
   constructor(params) {
     _defineProperty(this, "name", void 0);

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

@@ -1 +1 @@
-{"version":3,"names":["HMSRole","constructor","params","_defineProperty","name","priority","permissions","publishSettings","subscribeSettings","exports"],"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":";;;;;;;;;AAIO,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;AAACC,OAAA,CAAAT,OAAA,GAAAA,OAAA","ignoreList":[]}
+{"version":3,"names":["HMSRole","constructor","params","_defineProperty","name","priority","permissions","publishSettings","subscribeSettings","exports"],"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;AACO,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;AAACC,OAAA,CAAAT,OAAA,GAAAA,OAAA","ignoreList":[]}

package/lib/commonjs/classes/HMSRtmpVideoResolution.js

@@ -7,6 +7,19 @@ exports.HMSRtmpVideoResolution = 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 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
+ */
 class HMSRtmpVideoResolution {
   constructor(params) {
     _defineProperty(this, "height", void 0);

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

@@ -1 +1 @@
-{"version":3,"names":["HMSRtmpVideoResolution","constructor","params","_defineProperty","height","width","exports"],"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":";;;;;;;;;AAAO,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;AAACC,OAAA,CAAAN,sBAAA,GAAAA,sBAAA","ignoreList":[]}
+{"version":3,"names":["HMSRtmpVideoResolution","constructor","params","_defineProperty","height","width","exports"],"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;AACO,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;AAACC,OAAA,CAAAN,sBAAA,GAAAA,sBAAA","ignoreList":[]}