@dolbyio/dolbyio-rest-apis-client 3.4.0 → 3.4.1

package/dist/communications/index.d.ts

@@ -1,5 +1,6 @@
 import * as authentication from './authentication';
 import * as conference from './conference';
 import * as monitor from './monitor';
+import * as recording from './recording';
 import * as streaming from './streaming';
-export { authentication, conference, monitor, streaming };
+export { authentication, conference, monitor, recording, streaming };

package/dist/communications/index.js

@@ -23,13 +23,15 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.streaming = exports.monitor = exports.conference = exports.authentication = void 0;
+exports.streaming = exports.recording = exports.monitor = exports.conference = exports.authentication = void 0;
 const authentication = __importStar(require("./authentication"));
 exports.authentication = authentication;
 const conference = __importStar(require("./conference"));
 exports.conference = conference;
 const monitor = __importStar(require("./monitor"));
 exports.monitor = monitor;
+const recording = __importStar(require("./recording"));
+exports.recording = recording;
 const streaming = __importStar(require("./streaming"));
 exports.streaming = streaming;
 //# sourceMappingURL=index.js.map

package/dist/communications/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/communications/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAK1C,wCAAc;AAJvB,yDAA2C;AAIlB,gCAAU;AAHnC,mDAAqC;AAGA,0BAAO;AAF5C,uDAAyC;AAEK,8BAAS"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/communications/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAAmD;AAM1C,wCAAc;AALvB,yDAA2C;AAKlB,gCAAU;AAJnC,mDAAqC;AAIA,0BAAO;AAH5C,uDAAyC;AAGK,8BAAS;AAFvD,uDAAyC;AAEgB,8BAAS"}

package/dist/communications/recording.d.ts

@@ -0,0 +1,27 @@
+import JwtToken from '../types/jwtToken';
+/**
+ * Starts recording for the specified conference.
+ * You can specify a custom layout URL per recording request.
+ * The `layoutURL` parameter overrides the layout URL configured in the dashboard.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/api-recording-start
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param conferenceId Identifier of the conference.
+ * @param layoutUrl Overwrites the layout URL configuration.
+ *      This field is ignored if it is not relevant regarding recording configuration,
+ *      for example if live_recording set to false or if the recording is MP3 only.
+ *      - `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
+ */
+export declare const start: (accessToken: JwtToken, conferenceId: string, layoutUrl?: string) => Promise<void>;
+/**
+ * Stops the recording of the specified conference.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/api-recording-stop
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param conferenceId Identifier of the conference.
+ */
+export declare const stop: (accessToken: JwtToken, conferenceId: string) => Promise<void>;

package/dist/communications/recording.js

@@ -0,0 +1,69 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stop = exports.start = void 0;
+const httpHelpers_1 = require("../internal/httpHelpers");
+const urls_1 = require("./internal/urls");
+/**
+ * Starts recording for the specified conference.
+ * You can specify a custom layout URL per recording request.
+ * The `layoutURL` parameter overrides the layout URL configured in the dashboard.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/api-recording-start
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param conferenceId Identifier of the conference.
+ * @param layoutUrl Overwrites the layout URL configuration.
+ *      This field is ignored if it is not relevant regarding recording configuration,
+ *      for example if live_recording set to false or if the recording is MP3 only.
+ *      - `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
+ */
+const start = (accessToken, conferenceId, layoutUrl) => __awaiter(void 0, void 0, void 0, function* () {
+    const body = {};
+    if (layoutUrl)
+        body['layoutUrl'] = layoutUrl;
+    const options = {
+        hostname: urls_1.COMMS_HOSTNAME,
+        path: `/v2/conferences/mix/${conferenceId}/recording/start`,
+        headers: {
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+            Authorization: `${accessToken.token_type} ${accessToken.access_token}`,
+        },
+        body: JSON.stringify(body),
+    };
+    yield (0, httpHelpers_1.sendPost)(options);
+});
+exports.start = start;
+/**
+ * Stops the recording of the specified conference.
+ *
+ * @link https://docs.dolby.io/communications-apis/reference/api-recording-stop
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param conferenceId Identifier of the conference.
+ */
+const stop = (accessToken, conferenceId) => __awaiter(void 0, void 0, void 0, function* () {
+    const options = {
+        hostname: urls_1.COMMS_HOSTNAME,
+        path: `/v2/conferences/mix/${conferenceId}/recording/stop`,
+        headers: {
+            Accept: 'application/json',
+            'Content-Type': 'application/json',
+            Authorization: `${accessToken.token_type} ${accessToken.access_token}`,
+        },
+    };
+    yield (0, httpHelpers_1.sendPost)(options);
+});
+exports.stop = stop;
+//# sourceMappingURL=recording.js.map

package/dist/communications/recording.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"recording.js","sourceRoot":"","sources":["../../src/communications/recording.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,yDAAmD;AACnD,0CAAiD;AAGjD;;;;;;;;;;;;;;;GAeG;AACI,MAAM,KAAK,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAE,SAAkB,EAAiB,EAAE;IAC1G,MAAM,IAAI,GAAG,EAAE,CAAC;IAChB,IAAI,SAAS;QAAE,IAAI,CAAC,WAAW,CAAC,GAAG,SAAS,CAAC;IAE7C,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,qBAAc;QACxB,IAAI,EAAE,uBAAuB,YAAY,kBAAkB;QAC3D,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;QACD,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC;KAC7B,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAhBW,QAAA,KAAK,SAgBhB;AAEF;;;;;;;GAOG;AACI,MAAM,IAAI,GAAG,CAAO,WAAqB,EAAE,YAAoB,EAAiB,EAAE;IACrF,MAAM,OAAO,GAAG;QACZ,QAAQ,EAAE,qBAAc;QACxB,IAAI,EAAE,uBAAuB,YAAY,iBAAiB;QAC1D,OAAO,EAAE;YACL,MAAM,EAAE,kBAAkB;YAC1B,cAAc,EAAE,kBAAkB;YAClC,aAAa,EAAE,GAAG,WAAW,CAAC,UAAU,IAAI,WAAW,CAAC,YAAY,EAAE;SACzE;KACJ,CAAC;IAEF,MAAM,IAAA,sBAAQ,EAAC,OAAO,CAAC,CAAC;AAC5B,CAAC,CAAA,CAAC;AAZW,QAAA,IAAI,QAYf"}

package/package.json

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