@dolbyio/dolbyio-rest-apis-client 3.5.1 → 3.5.3

package/README.md

@@ -116,9 +116,11 @@ console.log(subscribeToken);
 
 ## Media Examples
 
-### Start an enhance job
+Here is an example on how to upload a file to the Dolby.io temporary cloud storage, enhance that file and download the result.
+
+### Get an API token
 
-To start an enhance job, use the following code:
+Get the App Key and Secret from the Dolby.io dashboard and use the following code in your python script.
 
 ```javascript
 const dolbyio = require('@dolbyio/dolbyio-rest-apis-client');
@@ -128,18 +130,72 @@ const APP_SECRET = 'YOUR_APP_SECRET';
 
 // Request an Access Token
 const jwt = await dolbyio.authentication.getApiAccessToken(APP_KEY, APP_SECRET);
+console.log('Access token', jwt);
+```
+
+### Upload a file for processing
+
+Upload a media file to the Dolby.io temporary cloud storage for processing:
+
+```javascript
+// Temporary storage URL that will be used as reference for the job processing
+const inputUrl = 'dlb://in/file.mp4';
+// Local path of the file to upload
+const originalFilePath = '/path/to/original_file.mp4';
+
+await dolbyio.io.uploadFile(jwt, inputUrl, originalFilePath);
+```
+
+### Start an enhance job
+
+Generate a job description and send it to Dolby.io.
+
+```javascript
+// Temporary storage URL that will be used as reference for the job processing
+const outputUrl = 'dlb://out/file.mp4';
 
 const jobDescription = JSON.stringify({
     content: { type: 'podcast' },
-    input: 'dlb://in/file.mp4',
-    output: 'dlb://out/file.mp4',
+    input: inputUrl,
+    output: outputUrl,
 });
 
 const jobId = await dolbyio.media.enhance.start(jwt, jobDescription);
-
 console.log(`Job ID: ${jobId}`);
 ```
 
+### Wait for the job to complete
+
+Get the job status and wait until it is completed.
+
+```javascript
+const sleep = (delay) => new Promise((r) => setTimeout(r, delay));
+
+let result = await dolbyio.media.enhance.getResults(jwt, jobId);
+while (result.status === 'Pending' || result.status === 'Running') {
+    console.log(`Job status is ${result.status}, taking a 5 second break...`);
+    await sleep(5000);
+
+    result = await dolbyio.media.enhance.getResults(jwt, jobId);
+}
+
+if (result.status !== 'Success') {
+    console.error('There was a problem with processing the file', result);
+    return;
+}
+```
+
+### Download a processed file
+
+At this stage, the file has been processed and written to the temporary storage so we can download it.
+
+```javascript
+// Local path where to download the file to
+const enhancedFilePath = '/path/to/enhanced_file.mp4';
+
+await dolbyio.io.downloadFile(jwt, outputUrl, enhancedFilePath);
+```
+
 ## Build this project
 
 To build the `dist` folder, run the command:

package/dist/index.js

@@ -15,5 +15,5 @@ var streaming = _interopRequireWildcard(require("./streaming"));
 exports.streaming = streaming;
 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.5.1";
+var version = "3.5.3";
 exports.version = version;

package/dist/internal/httpHelpers.d.ts

@@ -55,3 +55,10 @@ export declare const sendPatch: (options: RequestOptions) => Promise<any>;
  * @param options Request options.
  */
 export declare const download: (filepath: string, options: RequestOptions) => Promise<void>;
+/**
+ * Upload a file.
+ *
+ * @param filepath The local path of the file to upload.
+ * @param uploadUrl Where to upload the file to.
+ */
+export declare const upload: (filepath: string, uploadUrl: string) => Promise<void>;

package/dist/internal/httpHelpers.js

@@ -3,9 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.sendPut = exports.sendPost = exports.sendPatch = exports.sendGet = exports.sendDelete = exports.download = void 0;
+exports.upload = exports.sendPut = exports.sendPost = exports.sendPatch = exports.sendGet = exports.sendDelete = exports.download = void 0;
 var _fs = _interopRequireDefault(require("fs"));
 var _followRedirects = require("follow-redirects");
+var _https = _interopRequireDefault(require("https"));
 var _url = require("url");
 var _index = require("../index");
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { "default": obj }; }
@@ -250,4 +251,39 @@ var download = function download(filepath, options) {
     req.end();
   });
 };
-exports.download = download;
+
+/**
+ * Upload a file.
+ *
+ * @param filepath The local path of the file to upload.
+ * @param uploadUrl Where to upload the file to.
+ */
+exports.download = download;
+var upload = function upload(filepath, uploadUrl) {
+  // Get the size of the file to upload
+  var fileSize = _fs["default"].statSync(filepath).size;
+  return new Promise(function (resolve, reject) {
+    var opts = {
+      method: 'PUT',
+      headers: {
+        "Content-Length": fileSize
+      }
+    };
+    var req = _https["default"].request(uploadUrl, opts, function (res) {
+      console.log("[".concat(opts.method, "] ").concat(res.statusCode, " - ").concat(uploadUrl));
+      if (res.statusCode < 200 || res.statusCode >= 400) {
+        reject('This request has been rejected with the response code ' + res.statusCode);
+      } else {
+        resolve();
+      }
+    });
+    req.on('error', function (error) {
+      console.error(error);
+      reject(error);
+    });
+
+    // Start the upload of the file
+    _fs["default"].createReadStream(filepath).pipe(req);
+  });
+};
+exports.upload = upload;

package/dist/media/analyze.d.ts

@@ -31,7 +31,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
  *
  * For a given job_id, this method will check the job status.
  *
- * When `status==Success` you'll be able to retrieve your result from the output location you provided in the original POST.
+ * When {@link AnalyzeJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original {@link start} request.
  *
  * @link https://docs.dolby.io/media-apis/reference/media-analyze-get
  *

package/dist/media/analyze.js

@@ -61,7 +61,7 @@ var start = /*#__PURE__*/function () {
  *
  * For a given job_id, this method will check the job status.
  *
- * When `status==Success` you'll be able to retrieve your result from the output location you provided in the original POST.
+ * When {@link AnalyzeJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original {@link start} request.
  *
  * @link https://docs.dolby.io/media-apis/reference/media-analyze-get
  *

package/dist/media/analyzeMusic.d.ts

@@ -0,0 +1,37 @@
+import JwtToken from '../types/jwtToken';
+import { AnalyzeMusicJob } from './types/analyzeMusic';
+/**
+ * Start analyzing to learn about music in your media.
+ *
+ * The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-music-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * @param accessToken Access token to use for authentication.
+ * @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-analyze-music-post
+ *
+ * @returns The job identifier through a {@link Promise}.
+ */
+export declare const start: (accessToken: JwtToken, jobContent: string) => Promise<string | null>;
+/**
+ * Gets Music Analytics Status.
+ *
+ * For a given {@link jobId}, this method will check if the processing task has completed.
+ *
+ * When {@link AnalyzeMusicJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original {@link start} request.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-music-get
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The {@link AnalyzeMusicJob} object through a {@link Promise}.
+ */
+export declare const getResults: (accessToken: JwtToken, jobId: string) => Promise<AnalyzeMusicJob>;

package/dist/media/analyzeMusic.js

@@ -0,0 +1,89 @@
+"use strict";
+
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.start = exports.getResults = void 0;
+var _jobsHelpers = require("./internal/jobsHelpers");
+function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
+function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
+/**
+ * Start analyzing to learn about music in your media.
+ *
+ * The `input` location of your source media file and `output` location of your Analyze JSON results file are required.
+ *
+ * This is an asynchronous operation so you will receive a `job_id` to be used to get the job status and result.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-music-post
+ *
+ * Beta API
+ * This API is being made available as an early preview.
+ * If you have feedback on how you'd like to use the API please reach out to share your feedback with our team.
+ * https://dolby.io/contact
+ *
+ * @param accessToken Access token to use for authentication.
+ * @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-analyze-music-post
+ *
+ * @returns The job identifier through a {@link Promise}.
+ */
+var start = /*#__PURE__*/function () {
+  var _ref = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(accessToken, jobContent) {
+    return _regeneratorRuntime().wrap(function _callee$(_context) {
+      while (1) {
+        switch (_context.prev = _context.next) {
+          case 0:
+            _context.next = 2;
+            return (0, _jobsHelpers.startJob)(accessToken, '/media/analyze/music', jobContent);
+          case 2:
+            return _context.abrupt("return", _context.sent);
+          case 3:
+          case "end":
+            return _context.stop();
+        }
+      }
+    }, _callee);
+  }));
+  return function start(_x, _x2) {
+    return _ref.apply(this, arguments);
+  };
+}();
+
+/**
+ * Gets Music Analytics Status.
+ *
+ * For a given {@link jobId}, this method will check if the processing task has completed.
+ *
+ * When {@link AnalyzeMusicJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original {@link start} request.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-analyze-music-get
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param jobId Identifier of the job to retrieve.
+ *
+ * @returns The {@link AnalyzeMusicJob} object through a {@link Promise}.
+ */
+exports.start = start;
+var getResults = /*#__PURE__*/function () {
+  var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee2(accessToken, jobId) {
+    return _regeneratorRuntime().wrap(function _callee2$(_context2) {
+      while (1) {
+        switch (_context2.prev = _context2.next) {
+          case 0:
+            _context2.next = 2;
+            return (0, _jobsHelpers.getJobResults)(accessToken, '/media/analyze/music', jobId);
+          case 2:
+            return _context2.abrupt("return", _context2.sent);
+          case 3:
+          case "end":
+            return _context2.stop();
+        }
+      }
+    }, _callee2);
+  }));
+  return function getResults(_x3, _x4) {
+    return _ref2.apply(this, arguments);
+  };
+}();
+exports.getResults = getResults;

package/dist/media/analyzeSpeech.d.ts

@@ -25,7 +25,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
  *
  * For a given {@link jobId}, this method will check if the processing task has completed.
  *
- * When {@link AnalyzeSpeechJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original `POST`.
+ * When {@link AnalyzeSpeechJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original {@link start} request.
  *
  * @link https://docs.dolby.io/media-apis/reference/media-analyze-speech-get
  *

package/dist/media/analyzeSpeech.js

@@ -55,7 +55,7 @@ var start = /*#__PURE__*/function () {
  *
  * For a given {@link jobId}, this method will check if the processing task has completed.
  *
- * When {@link AnalyzeSpeechJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original `POST`.
+ * When {@link AnalyzeSpeechJob.status} is `Success`, you'll be able to retrieve your result from the `output` location you provided in the original {@link start} request.
  *
  * @link https://docs.dolby.io/media-apis/reference/media-analyze-speech-get
  *

package/dist/media/index.d.ts

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

package/dist/media/index.js

@@ -4,11 +4,13 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.webhooks = exports.transcode = exports.mastering = exports.jobs = exports.io = exports.enhance = exports.diagnose = exports.analyzeSpeech = exports.analyze = void 0;
+exports.webhooks = exports.transcode = exports.mastering = exports.jobs = exports.io = exports.enhance = exports.diagnose = exports.analyzeSpeech = exports.analyzeMusic = exports.analyze = void 0;
 var analyze = _interopRequireWildcard(require("./analyze"));
 exports.analyze = analyze;
 var analyzeSpeech = _interopRequireWildcard(require("./analyzeSpeech"));
 exports.analyzeSpeech = analyzeSpeech;
+var analyzeMusic = _interopRequireWildcard(require("./analyzeMusic"));
+exports.analyzeMusic = analyzeMusic;
 var diagnose = _interopRequireWildcard(require("./diagnose"));
 exports.diagnose = diagnose;
 var enhance = _interopRequireWildcard(require("./enhance"));

package/dist/media/io.d.ts

@@ -31,6 +31,18 @@ export declare const getUploadUrl: (accessToken: JwtToken, dlbUrl: string) => Pr
  * @returns The download URL through a {@link Promise}.
  */
 export declare const getDownloadUrl: (accessToken: JwtToken, dlbUrl: string) => Promise<string | null>;
+/**
+ * Upload a media file to the Dolby.io temporary storage.
+ *
+ * The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-input-post
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ * @param filePath Local path of the file you want to upload.
+ */
+export declare const uploadFile: (accessToken: JwtToken, dlbUrl: string, filePath: string) => Promise<void>;
 /**
  * Download a media file.
  *

package/dist/media/io.js

@@ -4,7 +4,7 @@ function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" =
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getUploadUrl = exports.getDownloadUrl = exports.downloadFile = void 0;
+exports.uploadFile = exports.getUploadUrl = exports.getDownloadUrl = exports.downloadFile = void 0;
 var _httpHelpers = require("./internal/httpHelpers");
 var _httpHelpers2 = require("../internal/httpHelpers");
 var _urls = require("./internal/urls");
@@ -129,6 +129,42 @@ var getDownloadUrl = /*#__PURE__*/function () {
   };
 }();
 
+/**
+ * Upload a media file to the Dolby.io temporary storage.
+ *
+ * The temporary storage should allow you to read and write to the dlb:// locations for a period of at least 24 hours before it is removed.
+ *
+ * @link https://docs.dolby.io/media-apis/reference/media-input-post
+ *
+ * @param accessToken Access token to use for authentication.
+ * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
+ * @param filePath Local path of the file you want to upload.
+ */
+exports.getDownloadUrl = getDownloadUrl;
+var uploadFile = /*#__PURE__*/function () {
+  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(accessToken, dlbUrl, filePath) {
+    var uploadUrl;
+    return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+      while (1) {
+        switch (_context4.prev = _context4.next) {
+          case 0:
+            _context4.next = 2;
+            return getUploadUrl(accessToken, dlbUrl);
+          case 2:
+            uploadUrl = _context4.sent;
+            return _context4.abrupt("return", (0, _httpHelpers2.upload)(filePath, uploadUrl));
+          case 4:
+          case "end":
+            return _context4.stop();
+        }
+      }
+    }, _callee4);
+  }));
+  return function uploadFile(_x8, _x9, _x10) {
+    return _ref4.apply(this, arguments);
+  };
+}();
+
 /**
  * Download a media file.
  *
@@ -142,18 +178,18 @@ var getDownloadUrl = /*#__PURE__*/function () {
  * @param dlbUrl The `url` should be in the form `dlb://object-key` where the object-key can be any alpha-numeric string. The object-key is unique to your account API Key so there is no risk of collision with other users.
  * @param filePath Local file path where to download the file to.
  */
-exports.getDownloadUrl = getDownloadUrl;
+exports.uploadFile = uploadFile;
 var downloadFile = /*#__PURE__*/function () {
-  var _ref4 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee4(accessToken, dlbUrl, filePath) {
+  var _ref5 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime().mark(function _callee5(accessToken, dlbUrl, filePath) {
     var downloadUrl, idx, requestOptions;
-    return _regeneratorRuntime().wrap(function _callee4$(_context4) {
+    return _regeneratorRuntime().wrap(function _callee5$(_context5) {
       while (1) {
-        switch (_context4.prev = _context4.next) {
+        switch (_context5.prev = _context5.next) {
           case 0:
-            _context4.next = 2;
+            _context5.next = 2;
             return getDownloadUrl(accessToken, dlbUrl);
           case 2:
-            downloadUrl = _context4.sent;
+            downloadUrl = _context5.sent;
             downloadUrl = downloadUrl.replace('https://', '');
             idx = downloadUrl.indexOf('/');
             requestOptions = {
@@ -161,16 +197,16 @@ var downloadFile = /*#__PURE__*/function () {
               path: downloadUrl.substring(idx + 1),
               headers: {}
             };
-            return _context4.abrupt("return", (0, _httpHelpers2.download)(filePath, requestOptions));
+            return _context5.abrupt("return", (0, _httpHelpers2.download)(filePath, requestOptions));
           case 7:
           case "end":
-            return _context4.stop();
+            return _context5.stop();
         }
       }
-    }, _callee4);
+    }, _callee5);
   }));
-  return function downloadFile(_x8, _x9, _x10) {
-    return _ref4.apply(this, arguments);
+  return function downloadFile(_x11, _x12, _x13) {
+    return _ref5.apply(this, arguments);
   };
 }();
 exports.downloadFile = downloadFile;

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

@@ -0,0 +1,6 @@
+import { JobResult } from './jobResults';
+export interface AnalyzeMusicJobResult {
+    version: string;
+}
+export interface AnalyzeMusicJob extends JobResult<AnalyzeMusicJobResult> {
+}

package/dist/media/types/analyzeMusic.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@dolbyio/dolbyio-rest-apis-client",
-    "version": "3.5.1",
+    "version": "3.5.3",
     "description": "Node.JS wrapper for the dolby.io REST APIs",
     "main": "dist/index.js",
     "scripts": {
@@ -13,6 +13,15 @@
     },
     "author": "Fabien Lavocat <fabien.lavocat@dolby.com>",
     "license": "MIT",
+    "keywords": [
+        "nodejs",
+        "api",
+        "sdk",
+        "rest",
+        "rest-api",
+        "webrtc",
+        "dolbyio"
+    ],
     "files": [
         "dist/*",
         "README.md"