@dolbyio/dolbyio-rest-apis-client 3.4.4 → 3.4.5

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022 Dolby Laboratories
+Copyright (c) 2023 Dolby Laboratories
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/communications/remix.js

@@ -23,11 +23,12 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
  *      - `null`: uses the layout URL configured in the dashboard (if no URL is set in the dashboard, then uses the Dolby.io default);
  *      - `default`: uses the Dolby.io default layout;
  *      - URL string: uses this layout URL
+ * @param layoutName Defines a name for the given layout URL, which makes layout identification easier for customers especially when the layout URL is not explicit.
  *
  * @returns A `RemixStatus` object through a `Promise`.
  */
 var start = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(accessToken, conferenceId, layoutUrl) {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(accessToken, conferenceId, layoutUrl, layoutName) {
     var body, options, response;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) {
@@ -35,6 +36,7 @@ var start = /*#__PURE__*/function () {
           case 0:
             body = {};
             if (layoutUrl) body['layoutUrl'] = layoutUrl;
+            if (layoutName) body['layoutName'] = layoutName;
             options = {
               hostname: _urls.COMMS_HOSTNAME,
               path: "/v2/conferences/mix/".concat(conferenceId, "/remix/start"),
@@ -45,19 +47,19 @@ var start = /*#__PURE__*/function () {
               },
               body: JSON.stringify(body)
             };
-            _context.next = 5;
+            _context.next = 6;
             return (0, _httpHelpers.sendPost)(options);
-          case 5:
+          case 6:
             response = _context.sent;
             return _context.abrupt("return", response);
-          case 7:
+          case 8:
           case "end":
             return _context.stop();
         }
       }
     }, _callee);
   }));
-  return function start(_x, _x2, _x3) {
+  return function start(_x, _x2, _x3, _x4) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -100,7 +102,7 @@ var getStatus = /*#__PURE__*/function () {
       }
     }, _callee2);
   }));
-  return function getStatus(_x4, _x5) {
+  return function getStatus(_x5, _x6) {
     return _ref2.apply(this, arguments);
   };
 }();

package/dist/communications/streaming.d.ts

@@ -13,8 +13,9 @@ import JwtToken from '../types/jwtToken';
  *      - `null`: uses the layout URL configured in the dashboard (if no URL is set in the dashboard, then uses the Dolby.io default);
  *      - `default`: uses the Dolby.io default layout;
  *      - URL string: uses this layout URL
+ * @param layoutName Defines a name for the given layout URL, which makes layout identification easier for customers especially when the layout URL is not explicit.
  */
-export declare const startRtmp: (accessToken: JwtToken, conferenceId: string, rtmpUrl: string, layoutUrl?: string) => Promise<void>;
+export declare const startRtmp: (accessToken: JwtToken, conferenceId: string, rtmpUrl: string, layoutUrl?: string, layoutName?: string) => Promise<void>;
 /**
  * Stops the RTMP stream of the specified conference.
  *
@@ -37,8 +38,9 @@ export declare const stopRtmp: (accessToken: JwtToken, conferenceId: string) =>
  *      - `null`: uses the layout URL configured in the dashboard (if no URL is set in the dashboard, then uses the Dolby.io default);
  *      - `default`: uses the Dolby.io default layout;
  *      - URL string: uses this layout URL
+ * @param layoutName Defines a name for the given layout URL, which makes layout identification easier for customers especially when the layout URL is not explicit.
  */
-export declare const startRts: (accessToken: JwtToken, conferenceId: string, streamName: string, publishingToken: string, layoutUrl?: string) => Promise<void>;
+export declare const startRts: (accessToken: JwtToken, conferenceId: string, streamName: string, publishingToken: string, layoutUrl?: string, layoutName?: string) => Promise<void>;
 /**
  * Stops real-time streaming to Dolby.io Real-time Streaming services.
  *

package/dist/communications/streaming.js

@@ -24,9 +24,10 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
  *      - `null`: uses the layout URL configured in the dashboard (if no URL is set in the dashboard, then uses the Dolby.io default);
  *      - `default`: uses the Dolby.io default layout;
  *      - URL string: uses this layout URL
+ * @param layoutName Defines a name for the given layout URL, which makes layout identification easier for customers especially when the layout URL is not explicit.
  */
 var startRtmp = /*#__PURE__*/function () {
-  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(accessToken, conferenceId, rtmpUrl, layoutUrl) {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(accessToken, conferenceId, rtmpUrl, layoutUrl, layoutName) {
     var body, options;
     return _regeneratorRuntime().wrap(function _callee$(_context) {
       while (1) {
@@ -36,6 +37,7 @@ var startRtmp = /*#__PURE__*/function () {
               uri: rtmpUrl
             };
             if (layoutUrl) body['layoutUrl'] = layoutUrl;
+            if (layoutName) body['layoutName'] = layoutName;
             options = {
               hostname: _urls.COMMS_HOSTNAME,
               path: "/v2/conferences/mix/".concat(conferenceId, "/rtmp/start"),
@@ -46,16 +48,16 @@ var startRtmp = /*#__PURE__*/function () {
               },
               body: JSON.stringify(body)
             };
-            _context.next = 5;
+            _context.next = 6;
             return (0, _httpHelpers.sendPost)(options);
-          case 5:
+          case 6:
           case "end":
             return _context.stop();
         }
       }
     }, _callee);
   }));
-  return function startRtmp(_x, _x2, _x3, _x4) {
+  return function startRtmp(_x, _x2, _x3, _x4, _x5) {
     return _ref.apply(this, arguments);
   };
 }();
@@ -94,7 +96,7 @@ var stopRtmp = /*#__PURE__*/function () {
       }
     }, _callee2);
   }));
-  return function stopRtmp(_x5, _x6) {
+  return function stopRtmp(_x6, _x7) {
     return _ref2.apply(this, arguments);
   };
 }();
@@ -112,10 +114,11 @@ var stopRtmp = /*#__PURE__*/function () {
  *      - `null`: uses the layout URL configured in the dashboard (if no URL is set in the dashboard, then uses the Dolby.io default);
  *      - `default`: uses the Dolby.io default layout;
  *      - URL string: uses this layout URL
+ * @param layoutName Defines a name for the given layout URL, which makes layout identification easier for customers especially when the layout URL is not explicit.
  */
 exports.stopRtmp = stopRtmp;
 var startRts = /*#__PURE__*/function () {
-  var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(accessToken, conferenceId, streamName, publishingToken, layoutUrl) {
+  var _ref3 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee3(accessToken, conferenceId, streamName, publishingToken, layoutUrl, layoutName) {
     var body, options;
     return _regeneratorRuntime().wrap(function _callee3$(_context3) {
       while (1) {
@@ -126,6 +129,7 @@ var startRts = /*#__PURE__*/function () {
               publishingToken: publishingToken
             };
             if (layoutUrl) body['layoutUrl'] = layoutUrl;
+            if (layoutName) body['layoutName'] = layoutName;
             options = {
               hostname: _urls.COMMS_HOSTNAME,
               path: "/v2/conferences/mix/".concat(conferenceId, "/rts/start"),
@@ -136,16 +140,16 @@ var startRts = /*#__PURE__*/function () {
               },
               body: JSON.stringify(body)
             };
-            _context3.next = 5;
+            _context3.next = 6;
             return (0, _httpHelpers.sendPost)(options);
-          case 5:
+          case 6:
           case "end":
             return _context3.stop();
         }
       }
     }, _callee3);
   }));
-  return function startRts(_x7, _x8, _x9, _x10, _x11) {
+  return function startRts(_x8, _x9, _x10, _x11, _x12, _x13) {
     return _ref3.apply(this, arguments);
   };
 }();
@@ -184,7 +188,7 @@ var stopRts = /*#__PURE__*/function () {
       }
     }, _callee4);
   }));
-  return function stopRts(_x12, _x13) {
+  return function stopRts(_x14, _x15) {
     return _ref4.apply(this, arguments);
   };
 }();

package/dist/index.js

@@ -13,5 +13,5 @@ var media = _interopRequireWildcard(require("./media"));
 exports.media = media;
 function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function _getRequireWildcardCache(nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
 function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || _typeof(obj) !== "object" && typeof obj !== "function") { return { "default": obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj["default"] = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
-var version = "3.4.4";
+var version = "3.4.5";
 exports.version = version;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dolbyio/dolbyio-rest-apis-client",
-    "version": "3.4.4",
+    "version": "3.4.5",
     "description": "Node.JS wrapper for the dolby.io REST APIs",
     "main": "dist/index.js",
     "scripts": {