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

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