@dolbyio/dolbyio-rest-apis-client 2.0.0 → 2.1.1

package/dist/media/index.d.ts

@@ -4,7 +4,8 @@ import * as diagnose from './diagnose';
 import * as enhance from './enhance';
 import * as io from './io';
 import * as jobs from './jobs';
+import * as mastering from './mastering';
 import * as transcode from './transcode';
 import * as platform from './platform';
 import * as webhooks from './webhooks';
-export { analyze, analyzeSpeech, diagnose, enhance, io, jobs, transcode, platform, webhooks };
+export { analyze, analyzeSpeech, diagnose, enhance, io, jobs, mastering, transcode, platform, webhooks };

package/dist/media/index.js

@@ -23,7 +23,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.webhooks = exports.platform = exports.transcode = exports.jobs = exports.io = exports.enhance = exports.diagnose = exports.analyzeSpeech = exports.analyze = void 0;
+exports.webhooks = exports.platform = exports.transcode = exports.mastering = exports.jobs = exports.io = exports.enhance = exports.diagnose = exports.analyzeSpeech = exports.analyze = void 0;
 const analyze = __importStar(require("./analyze"));
 exports.analyze = analyze;
 const analyzeSpeech = __importStar(require("./analyzeSpeech"));
@@ -36,6 +36,8 @@ const io = __importStar(require("./io"));
 exports.io = io;
 const jobs = __importStar(require("./jobs"));
 exports.jobs = jobs;
+const mastering = __importStar(require("./mastering"));
+exports.mastering = mastering;
 const transcode = __importStar(require("./transcode"));
 exports.transcode = transcode;
 const platform = __importStar(require("./platform"));

package/dist/media/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/media/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAqC;AAU5B,0BAAO;AAThB,+DAAiD;AAS/B,sCAAa;AAR/B,qDAAuC;AAQN,4BAAQ;AAPzC,mDAAqC;AAOM,0BAAO;AANlD,yCAA2B;AAMyB,gBAAE;AALtD,6CAA+B;AAKyB,oBAAI;AAJ5D,uDAAyC;AAIqB,8BAAS;AAHvE,qDAAuC;AAGkC,4BAAQ;AAFjF,qDAAuC;AAE4C,4BAAQ"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/media/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,mDAAqC;AAW5B,0BAAO;AAVhB,+DAAiD;AAU/B,sCAAa;AAT/B,qDAAuC;AASN,4BAAQ;AARzC,mDAAqC;AAQM,0BAAO;AAPlD,yCAA2B;AAOyB,gBAAE;AANtD,6CAA+B;AAMyB,oBAAI;AAL5D,uDAAyC;AAKqB,8BAAS;AAJvE,uDAAyC;AAIgC,8BAAS;AAHlF,qDAAuC;AAG6C,4BAAQ;AAF5F,qDAAuC;AAEuD,4BAAQ"}

package/dist/media/mastering.d.ts

@@ -0,0 +1,70 @@
+import JwtToken from './types/jwtToken';
+import { MasteringPreviewJob, MasteringJob } from './types/mastering';
+/**
+ * Starts mastering preview to improve your music.
+ *
+ * The `inputs` location for your source media file as well as the `outputs` location for the processed media file are required.
+ *
+ * A `preset` applies dynamic EQ processing to shape your music to match a desired sound. There are also additional optional parameters that can be provided to control the mastering output.
+ *
+ * A `segment` object specifying preview `start` may optionally be provided.
+ *
+ * This is an asynchronous operation. You receive a `job_id` that you use to retrieve the results when the mastering is complete.
+ *
+ * To learn more, see the example requests and responses.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+export declare const startPreview: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Mastering Preview Results
+ *
+ * For a given job_id, this method will check if the mastering task has completed.
+ * When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-preview-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `MasteringPreviewJob` object through a `Promise`.
+ */
+export declare const getPreviewResults: (auth: string | JwtToken, jobId: string) => Promise<MasteringPreviewJob>;
+/**
+ * Starts mastering to improve your music.
+ *
+ * The `inputs` location for your source media file as well as the `outputs` location for the processed media file are required.
+ *
+ * A `preset` applies dynamic EQ processing to shape your music to match a desired sound. There are also additional optional parameters that can be provided to control the mastering output.
+ *
+ * This is an asynchronous operation. You receive a `job_id` that you use to retrieve the results when the mastering is complete.
+ *
+ * To learn more, see the example requests and responses.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+export declare const start: (auth: string | JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Mastering Results
+ *
+ * For a given job_id, this method will check if the mastering task has completed.
+ * When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `MasteringJob` object through a `Promise`.
+ */
+export declare const getResults: (auth: string | JwtToken, jobId: string) => Promise<MasteringJob>;

package/dist/media/mastering.js

@@ -0,0 +1,136 @@
+"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.getResults = exports.start = exports.getPreviewResults = exports.startPreview = void 0;
+const httpHelpers_1 = require("./internal/httpHelpers");
+/**
+ * Starts mastering preview to improve your music.
+ *
+ * The `inputs` location for your source media file as well as the `outputs` location for the processed media file are required.
+ *
+ * A `preset` applies dynamic EQ processing to shape your music to match a desired sound. There are also additional optional parameters that can be provided to control the mastering output.
+ *
+ * A `segment` object specifying preview `start` may optionally be provided.
+ *
+ * This is an asynchronous operation. You receive a `job_id` that you use to retrieve the results when the mastering is complete.
+ *
+ * To learn more, see the example requests and responses.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+const startPreview = (auth, jobContent) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/master/preview',
+        headers: {},
+        auth,
+        body: jobContent,
+    };
+    const response = yield (0, httpHelpers_1.sendPost)(requestOptions);
+    if (response.hasOwnProperty('job_id')) {
+        return response['job_id'];
+    }
+    return null;
+});
+exports.startPreview = startPreview;
+/**
+ * Gets Mastering Preview Results
+ *
+ * For a given job_id, this method will check if the mastering task has completed.
+ * When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-preview-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `MasteringPreviewJob` object through a `Promise`.
+ */
+const getPreviewResults = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/master/preview',
+        params: {
+            job_id: jobId,
+        },
+        headers: {},
+        auth,
+    };
+    const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
+    return response;
+});
+exports.getPreviewResults = getPreviewResults;
+/**
+ * Starts mastering to improve your music.
+ *
+ * The `inputs` location for your source media file as well as the `outputs` location for the processed media file are required.
+ *
+ * A `preset` applies dynamic EQ processing to shape your music to match a desired sound. There are also additional optional parameters that can be provided to control the mastering output.
+ *
+ * This is an asynchronous operation. You receive a `job_id` that you use to retrieve the results when the mastering is complete.
+ *
+ * To learn more, see the example requests and responses.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobContent Content of the job description as a JSON payload. You can find the definition at this URL: https://docs.dolby.io/media-apis/reference/media-music-mastering-post
+ *
+ * @returns The job identifier through a `Promise`.
+ */
+const start = (auth, jobContent) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/master',
+        headers: {},
+        auth,
+        body: jobContent,
+    };
+    const response = yield (0, httpHelpers_1.sendPost)(requestOptions);
+    if (response.hasOwnProperty('job_id')) {
+        return response['job_id'];
+    }
+    return null;
+});
+exports.start = start;
+/**
+ * Gets Mastering Results
+ *
+ * For a given job_id, this method will check if the mastering task has completed.
+ * When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-music-mastering-get
+ *
+ * @param auth Your Dolby.io Media API Key or a JWT Token.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The `MasteringJob` object through a `Promise`.
+ */
+const getResults = (auth, jobId) => __awaiter(void 0, void 0, void 0, function* () {
+    const requestOptions = {
+        hostname: 'api.dolby.com',
+        path: '/media/master',
+        params: {
+            job_id: jobId,
+        },
+        headers: {},
+        auth,
+    };
+    const response = yield (0, httpHelpers_1.sendGet)(requestOptions);
+    return response;
+});
+exports.getResults = getResults;
+//# sourceMappingURL=mastering.js.map

package/dist/media/mastering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mastering.js","sourceRoot":"","sources":["../../src/media/mastering.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,wDAA+E;AAI/E;;;;;;;;;;;;;;;;;;;GAmBG;AACI,MAAM,YAAY,GAAG,CAAO,IAAuB,EAAE,UAAkB,EAA0B,EAAE;IACtG,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,uBAAuB;QAC7B,OAAO,EAAE,EAAE;QACX,IAAI;QACJ,IAAI,EAAE,UAAU;KACnB,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,cAAc,CAAC,CAAC;IAChD,IAAI,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACnC,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAC7B;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAA,CAAC;AAfW,QAAA,YAAY,gBAevB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,iBAAiB,GAAG,CAAO,IAAuB,EAAE,KAAa,EAAgC,EAAE;IAC5G,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE;YACJ,MAAM,EAAE,KAAK;SAChB;QACD,OAAO,EAAE,EAAE;QACX,IAAI;KACP,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,qBAAO,EAAC,cAAc,CAAC,CAAC;IAC/C,OAAO,QAA+B,CAAC;AAC3C,CAAC,CAAA,CAAC;AAbW,QAAA,iBAAiB,qBAa5B;AAEF;;;;;;;;;;;;;;;;;GAiBG;AACI,MAAM,KAAK,GAAG,CAAO,IAAuB,EAAE,UAAkB,EAA0B,EAAE;IAC/F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,eAAe;QACrB,OAAO,EAAE,EAAE;QACX,IAAI;QACJ,IAAI,EAAE,UAAU;KACnB,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,sBAAQ,EAAC,cAAc,CAAC,CAAC;IAChD,IAAI,QAAQ,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE;QACnC,OAAO,QAAQ,CAAC,QAAQ,CAAC,CAAC;KAC7B;IAED,OAAO,IAAI,CAAC;AAChB,CAAC,CAAA,CAAC;AAfW,QAAA,KAAK,SAehB;AAEF;;;;;;;;;;;;GAYG;AACI,MAAM,UAAU,GAAG,CAAO,IAAuB,EAAE,KAAa,EAAyB,EAAE;IAC9F,MAAM,cAAc,GAAuB;QACvC,QAAQ,EAAE,eAAe;QACzB,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE;YACJ,MAAM,EAAE,KAAK;SAChB;QACD,OAAO,EAAE,EAAE;QACX,IAAI;KACP,CAAC;IAEF,MAAM,QAAQ,GAAG,MAAM,IAAA,qBAAO,EAAC,cAAc,CAAC,CAAC;IAC/C,OAAO,QAAwB,CAAC;AACpC,CAAC,CAAA,CAAC;AAbW,QAAA,UAAU,cAarB"}

package/dist/media/types/mastering.d.ts

@@ -0,0 +1,13 @@
+import { JobResult } from './jobResults';
+export interface MasteringPreviewJobResult {
+    /** Level of the media prior to mastering. Measured in loudness units relative to full scale (LUFS). */
+    initial_level: string;
+}
+export interface MasteringPreviewJob extends JobResult<MasteringPreviewJobResult> {
+}
+export interface MasteringJobResult extends MasteringPreviewJobResult {
+    /** Level of the media after mastering. Measured in loudness units relative to full scale (LUFS). */
+    final_level: string;
+}
+export interface MasteringJob extends JobResult<MasteringJobResult> {
+}

package/dist/media/types/mastering.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=mastering.js.map

package/dist/media/types/mastering.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"mastering.js","sourceRoot":"","sources":["../../../src/media/types/mastering.ts"],"names":[],"mappings":""}

package/package.json

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