@dolbyio/dolbyio-rest-apis-client 5.1.1 → 6.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/dist/index.js +1 -1
- package/dist/media/analyze.d.ts +1 -1
- package/dist/media/analyze.js +1 -1
- package/dist/media/analyzeMusic.d.ts +1 -1
- package/dist/media/analyzeMusic.js +1 -1
- package/dist/media/analyzeSpeech.d.ts +1 -1
- package/dist/media/analyzeSpeech.js +1 -1
- package/dist/media/diagnose.d.ts +1 -1
- package/dist/media/diagnose.js +1 -1
- package/dist/media/enhance.d.ts +1 -1
- package/dist/media/enhance.js +1 -1
- package/dist/media/jobs.js +8 -5
- package/dist/media/mastering.d.ts +2 -2
- package/dist/media/mastering.js +2 -2
- package/dist/media/transcode.d.ts +1 -1
- package/dist/media/transcode.js +1 -1
- package/dist/streaming/account.d.ts +141 -27
- package/dist/streaming/account.js +380 -56
- package/dist/streaming/assets.d.ts +78 -4
- package/dist/streaming/assets.js +193 -24
- package/dist/streaming/director.d.ts +2 -1
- package/dist/streaming/director.js +6 -4
- package/dist/streaming/index.d.ts +26 -7
- package/dist/streaming/index.js +4 -4
- package/dist/streaming/internal/stringHelpers.d.ts +5 -0
- package/dist/streaming/internal/stringHelpers.js +22 -0
- package/dist/streaming/monitoring.d.ts +44 -0
- package/dist/streaming/monitoring.js +191 -0
- package/dist/streaming/publishToken.d.ts +59 -15
- package/dist/streaming/publishToken.js +202 -64
- package/dist/streaming/stream.d.ts +18 -3
- package/dist/streaming/stream.js +49 -3
- package/dist/streaming/subscribeToken.d.ts +27 -13
- package/dist/streaming/subscribeToken.js +86 -38
- package/dist/streaming/transcoders.d.ts +32 -6
- package/dist/streaming/transcoders.js +45 -8
- package/dist/streaming/transcodersSchedules.d.ts +93 -0
- package/dist/streaming/{recordFiles.js → transcodersSchedules.js} +143 -69
- package/dist/streaming/types/account.d.ts +110 -3
- package/dist/streaming/types/asset.d.ts +75 -2
- package/dist/streaming/types/cluster.d.ts +1 -1
- package/dist/streaming/types/core.d.ts +11 -0
- package/dist/streaming/types/index.d.ts +2 -1
- package/dist/streaming/types/index.js +19 -8
- package/dist/streaming/types/monitoring.d.ts +202 -0
- package/dist/streaming/types/publishToken.d.ts +52 -51
- package/dist/streaming/types/stream.d.ts +12 -0
- package/dist/streaming/types/subscribeToken.d.ts +15 -4
- package/dist/streaming/types/transcoders.d.ts +29 -13
- package/dist/streaming/types/transcodersSchedules.d.ts +108 -0
- package/dist/streaming/types/transcodersSchedules.js +5 -0
- package/dist/streaming/types/webhooks.d.ts +33 -8
- package/dist/streaming/webhooks.d.ts +12 -1
- package/dist/streaming/webhooks.js +38 -1
- package/package.json +26 -13
- package/dist/streaming/recordFiles.d.ts +0 -63
- package/dist/streaming/types/recordFiles.d.ts +0 -49
- /package/dist/streaming/types/{recordFiles.js → monitoring.js} +0 -0
package/README.md
CHANGED
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
[](https://github.com/DolbyIO/dolbyio-rest-apis-client-node)
|
|
7
7
|
[](https://api-references.dolby.io/dolbyio-rest-apis-client-node/)
|
|
8
8
|
|
|
9
|
-
Dolby.
|
|
9
|
+
[Dolby OptiView](https://optiview.dolby.com/) REST APIs Client for Node.JS is wrapper for the [Dolby OptiView Real-time Streaming](https://optiview.dolby.com/docs/millicast/api/millicast-api/) and Dolby.io Media REST APIs.
|
|
10
10
|
|
|
11
11
|
# Install this project
|
|
12
12
|
|
package/dist/index.js
CHANGED
package/dist/media/analyze.d.ts
CHANGED
|
@@ -22,7 +22,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
|
|
|
22
22
|
/**
|
|
23
23
|
* Gets Analyze Status.
|
|
24
24
|
*
|
|
25
|
-
* For a given
|
|
25
|
+
* For a given `jobId`, this method will check the job status.
|
|
26
26
|
*
|
|
27
27
|
* 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.
|
|
28
28
|
*
|
package/dist/media/analyze.js
CHANGED
|
@@ -47,7 +47,7 @@ var start = exports.start = /*#__PURE__*/function () {
|
|
|
47
47
|
/**
|
|
48
48
|
* Gets Analyze Status.
|
|
49
49
|
*
|
|
50
|
-
* For a given
|
|
50
|
+
* For a given `jobId`, this method will check the job status.
|
|
51
51
|
*
|
|
52
52
|
* 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.
|
|
53
53
|
*
|
|
@@ -16,7 +16,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
|
|
|
16
16
|
/**
|
|
17
17
|
* Gets Music Analytics Status.
|
|
18
18
|
*
|
|
19
|
-
* For a given
|
|
19
|
+
* For a given `jobId`, this method will check if the processing task has completed.
|
|
20
20
|
*
|
|
21
21
|
* 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.
|
|
22
22
|
*
|
|
@@ -41,7 +41,7 @@ var start = exports.start = /*#__PURE__*/function () {
|
|
|
41
41
|
/**
|
|
42
42
|
* Gets Music Analytics Status.
|
|
43
43
|
*
|
|
44
|
-
* For a given
|
|
44
|
+
* For a given `jobId`, this method will check if the processing task has completed.
|
|
45
45
|
*
|
|
46
46
|
* 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.
|
|
47
47
|
*
|
|
@@ -16,7 +16,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
|
|
|
16
16
|
/**
|
|
17
17
|
* Gets Speech Analytics Status.
|
|
18
18
|
*
|
|
19
|
-
* For a given
|
|
19
|
+
* For a given `jobId`, this method will check if the processing task has completed.
|
|
20
20
|
*
|
|
21
21
|
* 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.
|
|
22
22
|
*
|
|
@@ -41,7 +41,7 @@ var start = exports.start = /*#__PURE__*/function () {
|
|
|
41
41
|
/**
|
|
42
42
|
* Gets Speech Analytics Status.
|
|
43
43
|
*
|
|
44
|
-
* For a given
|
|
44
|
+
* For a given `jobId`, this method will check if the processing task has completed.
|
|
45
45
|
*
|
|
46
46
|
* 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.
|
|
47
47
|
*
|
package/dist/media/diagnose.d.ts
CHANGED
|
@@ -16,7 +16,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
|
|
|
16
16
|
/**
|
|
17
17
|
* Gets Diagnose Results.
|
|
18
18
|
*
|
|
19
|
-
* For a given
|
|
19
|
+
* For a given `jobId`, this method will check if the processing task has completed.
|
|
20
20
|
*
|
|
21
21
|
* The {@link DiagnoseJob.progress} attribute provides a percentage of job progress.
|
|
22
22
|
*
|
package/dist/media/diagnose.js
CHANGED
|
@@ -41,7 +41,7 @@ var start = exports.start = /*#__PURE__*/function () {
|
|
|
41
41
|
/**
|
|
42
42
|
* Gets Diagnose Results.
|
|
43
43
|
*
|
|
44
|
-
* For a given
|
|
44
|
+
* For a given `jobId`, this method will check if the processing task has completed.
|
|
45
45
|
*
|
|
46
46
|
* The {@link DiagnoseJob.progress} attribute provides a percentage of job progress.
|
|
47
47
|
*
|
package/dist/media/enhance.d.ts
CHANGED
|
@@ -18,7 +18,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
|
|
|
18
18
|
/**
|
|
19
19
|
* Gets Enhance Results
|
|
20
20
|
*
|
|
21
|
-
* For a given
|
|
21
|
+
* For a given `jobId`, this method will check if the processing task has completed and return the enhanced results.
|
|
22
22
|
*
|
|
23
23
|
* When the {@link EnhanceJob.status} is Success you'll be able to retrieve your result from the output location you provided in the original POST.
|
|
24
24
|
*
|
package/dist/media/enhance.js
CHANGED
|
@@ -43,7 +43,7 @@ var start = exports.start = /*#__PURE__*/function () {
|
|
|
43
43
|
/**
|
|
44
44
|
* Gets Enhance Results
|
|
45
45
|
*
|
|
46
|
-
* For a given
|
|
46
|
+
* For a given `jobId`, this method will check if the processing task has completed and return the enhanced results.
|
|
47
47
|
*
|
|
48
48
|
* When the {@link EnhanceJob.status} is Success you'll be able to retrieve your result from the output location you provided in the original POST.
|
|
49
49
|
*
|
package/dist/media/jobs.js
CHANGED
|
@@ -8,6 +8,12 @@ exports.listAll = exports.list = exports.cancel = void 0;
|
|
|
8
8
|
var _httpHelpers = require("./internal/httpHelpers");
|
|
9
9
|
var Urls = _interopRequireWildcard(require("../urls"));
|
|
10
10
|
function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, "default": e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
|
|
11
|
+
function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
|
|
12
|
+
function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
|
|
13
|
+
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
|
|
14
|
+
function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
|
|
15
|
+
function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
|
|
16
|
+
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
|
|
11
17
|
function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
|
|
12
18
|
function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); } r ? i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n : (o("next", 0), o("throw", 1), o("return", 2)); }, _regeneratorDefine2(e, r, n, t); }
|
|
13
19
|
function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
|
|
@@ -73,7 +79,7 @@ var list = exports.list = /*#__PURE__*/function () {
|
|
|
73
79
|
*/
|
|
74
80
|
var listAll = exports.listAll = /*#__PURE__*/function () {
|
|
75
81
|
var _ref2 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2(accessToken, options) {
|
|
76
|
-
var params, requestOptions, result, response
|
|
82
|
+
var params, requestOptions, result, response;
|
|
77
83
|
return _regenerator().w(function (_context2) {
|
|
78
84
|
while (1) switch (_context2.n) {
|
|
79
85
|
case 0:
|
|
@@ -100,10 +106,7 @@ var listAll = exports.listAll = /*#__PURE__*/function () {
|
|
|
100
106
|
return (0, _httpHelpers.sendGet)(requestOptions);
|
|
101
107
|
case 2:
|
|
102
108
|
response = _context2.v;
|
|
103
|
-
|
|
104
|
-
object = response.jobs[index];
|
|
105
|
-
result.push(object);
|
|
106
|
-
}
|
|
109
|
+
result.push.apply(result, _toConsumableArray(response.jobs));
|
|
107
110
|
if (!(!response.next_token || response.next_token.length <= 0)) {
|
|
108
111
|
_context2.n = 3;
|
|
109
112
|
break;
|
|
@@ -22,7 +22,7 @@ export declare const startPreview: (accessToken: JwtToken, jobContent: string) =
|
|
|
22
22
|
/**
|
|
23
23
|
* Gets Mastering Preview Results
|
|
24
24
|
*
|
|
25
|
-
* For a given
|
|
25
|
+
* For a given `jobId`, this method will check if the mastering task has completed.
|
|
26
26
|
* When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
|
|
27
27
|
*
|
|
28
28
|
* @param accessToken Access token to use for authentication.
|
|
@@ -51,7 +51,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
|
|
|
51
51
|
/**
|
|
52
52
|
* Gets Mastering Results
|
|
53
53
|
*
|
|
54
|
-
* For a given
|
|
54
|
+
* For a given `jobId`, this method will check if the mastering task has completed.
|
|
55
55
|
* When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
|
|
56
56
|
*
|
|
57
57
|
* @param accessToken Access token to use for authentication.
|
package/dist/media/mastering.js
CHANGED
|
@@ -47,7 +47,7 @@ var startPreview = exports.startPreview = /*#__PURE__*/function () {
|
|
|
47
47
|
/**
|
|
48
48
|
* Gets Mastering Preview Results
|
|
49
49
|
*
|
|
50
|
-
* For a given
|
|
50
|
+
* For a given `jobId`, this method will check if the mastering task has completed.
|
|
51
51
|
* When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
|
|
52
52
|
*
|
|
53
53
|
* @param accessToken Access token to use for authentication.
|
|
@@ -108,7 +108,7 @@ var start = exports.start = /*#__PURE__*/function () {
|
|
|
108
108
|
/**
|
|
109
109
|
* Gets Mastering Results
|
|
110
110
|
*
|
|
111
|
-
* For a given
|
|
111
|
+
* For a given `jobId`, this method will check if the mastering task has completed.
|
|
112
112
|
* When the status is Success you'll be able to retrieve your results from the outputs locations you provided in the original POST.
|
|
113
113
|
*
|
|
114
114
|
* @param accessToken Access token to use for authentication.
|
|
@@ -14,7 +14,7 @@ export declare const start: (accessToken: JwtToken, jobContent: string) => Promi
|
|
|
14
14
|
/**
|
|
15
15
|
* Gets Transcode Results.
|
|
16
16
|
*
|
|
17
|
-
* For a given
|
|
17
|
+
* For a given `jobId`, this method will check if the processing task has completed and return the transcode results.
|
|
18
18
|
*
|
|
19
19
|
* When the {@link TranscodeJob.status} is Success you'll be able to retrieve your result from the output location you provided in the original POST.
|
|
20
20
|
*
|
package/dist/media/transcode.js
CHANGED
|
@@ -39,7 +39,7 @@ var start = exports.start = /*#__PURE__*/function () {
|
|
|
39
39
|
/**
|
|
40
40
|
* Gets Transcode Results.
|
|
41
41
|
*
|
|
42
|
-
* For a given
|
|
42
|
+
* For a given `jobId`, this method will check if the processing task has completed and return the transcode results.
|
|
43
43
|
*
|
|
44
44
|
* When the {@link TranscodeJob.status} is Success you'll be able to retrieve your result from the output location you provided in the original POST.
|
|
45
45
|
*
|
|
@@ -1,56 +1,170 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AccountMediaAssetsExpirationRules, AccountDistributionSettings, AccountSecuritySettings, ListStorageProfilesSortOptions, StorageProfile, StorageProfileValidationRequest, StorageProfileValidationResponse } from './types/account';
|
|
2
2
|
/**
|
|
3
|
-
*
|
|
3
|
+
* ## Get Account Media Assets Expiration Rule
|
|
4
4
|
*
|
|
5
|
-
*
|
|
6
|
-
* If a Publish Token does not define any geo cascade settings, the account wide settings are used.
|
|
5
|
+
* Get account level expiration rule for various media asset types.
|
|
7
6
|
*
|
|
8
|
-
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-get-
|
|
7
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-get-expiration-rules/}
|
|
9
8
|
*
|
|
10
9
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
11
10
|
*
|
|
12
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link
|
|
11
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link AccountMediaAssetsExpirationRules} object.
|
|
13
12
|
*/
|
|
14
|
-
export declare const
|
|
13
|
+
export declare const readAccountMediaAssetsExpirationRules: (apiSecret: string) => Promise<AccountMediaAssetsExpirationRules>;
|
|
15
14
|
/**
|
|
16
|
-
*
|
|
15
|
+
* ## Update Account Media Assets Expiration Rules
|
|
17
16
|
*
|
|
18
|
-
* Update account
|
|
19
|
-
*
|
|
17
|
+
* Update account level expiration rule for various media asset types.
|
|
18
|
+
*
|
|
19
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-update-expiration-rules/}
|
|
20
|
+
*
|
|
21
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
22
|
+
* @param settings The new account media assets expiration rules.
|
|
23
|
+
*
|
|
24
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link AccountMediaAssetsExpirationRules} object.
|
|
25
|
+
*/
|
|
26
|
+
export declare const updateAccountMediaAssetsExpirationRules: (apiSecret: string, settings: AccountMediaAssetsExpirationRules) => Promise<AccountMediaAssetsExpirationRules>;
|
|
27
|
+
/**
|
|
28
|
+
* ## List Storage Profiles
|
|
29
|
+
*
|
|
30
|
+
* List all storage profiles created on your account.
|
|
31
|
+
*
|
|
32
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-list-storage-profiles/}
|
|
33
|
+
*
|
|
34
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
35
|
+
* @param options Options to sort the response.
|
|
36
|
+
*
|
|
37
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link StorageProfile} objects.
|
|
38
|
+
*/
|
|
39
|
+
export declare const listStorageProfiles: (apiSecret: string, options: ListStorageProfilesSortOptions) => Promise<StorageProfile[]>;
|
|
40
|
+
/**
|
|
41
|
+
* ## Create Storage Profile
|
|
42
|
+
*
|
|
43
|
+
* Create a storage profile identifying the configuration for a cloud storage provider that can receive media assets when they are finished processing.
|
|
44
|
+
* Only one storage profile will be set as a default for the entire account,
|
|
45
|
+
* otherwise you may specify a storage location using the `storageProfileId` on any individual media clip request.
|
|
20
46
|
*
|
|
21
|
-
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-
|
|
47
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-create-storage-profile/}
|
|
22
48
|
*
|
|
23
49
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
24
|
-
* @param
|
|
50
|
+
* @param storageProfile Information about the new storage profile.
|
|
25
51
|
*
|
|
26
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link
|
|
52
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link PublishToken} object.
|
|
27
53
|
*/
|
|
28
|
-
export declare const
|
|
54
|
+
export declare const createStorageProfile: (apiSecret: string, storageProfile: StorageProfile) => Promise<StorageProfile>;
|
|
29
55
|
/**
|
|
30
|
-
*
|
|
56
|
+
* ## Delete Storage Profile
|
|
57
|
+
*
|
|
58
|
+
* Specify the id of a storage profile you wish to delete.
|
|
59
|
+
*
|
|
60
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-delete-storage-profile/}
|
|
61
|
+
*
|
|
62
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
63
|
+
* @param storageProfileId Identifier of the storage profile to delete.
|
|
64
|
+
*
|
|
65
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a flag to indicate if the operation succeeded or not.
|
|
66
|
+
*/
|
|
67
|
+
export declare const deleteStorageProfile: (apiSecret: string, storageProfileId: string) => Promise<boolean>;
|
|
68
|
+
/**
|
|
69
|
+
* ## Get Storage Profile
|
|
70
|
+
*
|
|
71
|
+
* Get details of a saved storage profile.
|
|
72
|
+
*
|
|
73
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-get-storage-profile/}
|
|
74
|
+
*
|
|
75
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
76
|
+
* @param storageProfileId Identifier of the storage profile to read.
|
|
77
|
+
*
|
|
78
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StorageProfile} object.
|
|
79
|
+
*/
|
|
80
|
+
export declare const getStorageProfile: (apiSecret: string, storageProfileId: string) => Promise<StorageProfile>;
|
|
81
|
+
/**
|
|
82
|
+
* ## Updates the storage profile
|
|
83
|
+
*
|
|
84
|
+
* Change the details of a storage profile.
|
|
31
85
|
*
|
|
32
|
-
*
|
|
86
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-update-storage-profile/}
|
|
87
|
+
*
|
|
88
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
89
|
+
* @param storageProfileId Identifier of the storage profile to update.
|
|
90
|
+
* @param storageProfile Settings of the torage profile to update.
|
|
91
|
+
*
|
|
92
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StorageProfile} object.
|
|
93
|
+
*/
|
|
94
|
+
export declare const updateStorageProfile: (apiSecret: string, storageProfileId: number, storageProfile: StorageProfile) => Promise<StorageProfile>;
|
|
95
|
+
/**
|
|
96
|
+
* ## Validate Third Party Storage Setup
|
|
97
|
+
*
|
|
98
|
+
* Validates third party storage is configured with permissions for Dolby.io to upload media assets.
|
|
99
|
+
*
|
|
100
|
+
* To track the validation result, keep note of the the `id` returned in the response body.
|
|
101
|
+
* If correctly configured, when calling {@link read | Read Media Asset}, the response should return a successful entry with `id` matching the `id`.
|
|
102
|
+
* Run once to validate write permissions. If successful, optionally run a second time to confirm that overwriting is allowed.
|
|
103
|
+
*
|
|
104
|
+
* Note that validation results are only available for 1 hour.
|
|
105
|
+
*
|
|
106
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-validate-third-party-storage/}
|
|
107
|
+
*
|
|
108
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
109
|
+
* @param storageProfile Information about the new storage profile to validate.
|
|
110
|
+
*
|
|
111
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link PublishToken} object.
|
|
112
|
+
*/
|
|
113
|
+
export declare const validateStorageProfile: (apiSecret: string, storageProfile: StorageProfileValidationRequest) => Promise<StorageProfileValidationResponse>;
|
|
114
|
+
/**
|
|
115
|
+
* ## Read Account Distribution Settings
|
|
116
|
+
*
|
|
117
|
+
* Gets account wide distribution settings.
|
|
118
|
+
* Whenever publish tokens are created, these will be the default settings used for features that impact how streams are distributed.
|
|
119
|
+
*
|
|
120
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-get-account-distribution/}
|
|
121
|
+
*
|
|
122
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
123
|
+
*
|
|
124
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link AccountDistributionSettings} object.
|
|
125
|
+
*/
|
|
126
|
+
export declare const readAccountDistributionSettings: (apiSecret: string) => Promise<AccountDistributionSettings>;
|
|
127
|
+
/**
|
|
128
|
+
* ## Update Account Distribution Settings
|
|
129
|
+
*
|
|
130
|
+
* Update account wide distribution settings to enable/disable the feature or update the account default cluster list.
|
|
131
|
+
* Whenever publish tokens are created, these will be the default settings used for features that impact how streams are distributed.
|
|
132
|
+
* `["all"]` could be used in place of cluster list to cascade stream to all existing and any future clusters available to the account.
|
|
133
|
+
* Empty cluster list is not allowed when enabling account wide distribution settings.
|
|
134
|
+
* Cluster list is translated to `["all"]` clusters if not specified or set to null.
|
|
135
|
+
* Cluster list is ignored when geo cascade is disabled.
|
|
136
|
+
*
|
|
137
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-update-account-distribution/}
|
|
138
|
+
*
|
|
139
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
140
|
+
* @param settings The new account distribution settings.
|
|
141
|
+
*
|
|
142
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link AccountDistributionSettings} object.
|
|
143
|
+
*/
|
|
144
|
+
export declare const updateAccountDistributionSettings: (apiSecret: string, settings: AccountDistributionSettings) => Promise<AccountDistributionSettings>;
|
|
145
|
+
/**
|
|
146
|
+
* ## Read Account Security Settings
|
|
33
147
|
*
|
|
34
|
-
*
|
|
148
|
+
* Gets account wide security settings.
|
|
149
|
+
* If a Token (either Publish or Subscribe) does not define any security settings, the account wide rules are used.
|
|
35
150
|
*
|
|
36
|
-
* @see {@link https://optiview.dolby.com/docs/millicast/api/
|
|
151
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-get-account-security/}
|
|
37
152
|
*
|
|
38
153
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
39
154
|
*
|
|
40
|
-
* @returns A {@link
|
|
155
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link AccountSecuritySettings} object.
|
|
41
156
|
*/
|
|
42
|
-
export declare const
|
|
157
|
+
export declare const readAccountSecuritySettings: (apiSecret: string) => Promise<AccountSecuritySettings>;
|
|
43
158
|
/**
|
|
44
|
-
*
|
|
159
|
+
* ## Update Account Security Settings
|
|
45
160
|
*
|
|
46
|
-
*
|
|
161
|
+
* Update account wide security settings. Updated to an empty array `[]` removes all rules of that type.
|
|
47
162
|
*
|
|
48
|
-
* @see {@link https://optiview.dolby.com/docs/millicast/api/
|
|
163
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/account-update-account-security/}
|
|
49
164
|
*
|
|
50
165
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
51
|
-
* @param
|
|
52
|
-
* @param deniedCountries The list of denied countries. An empty array `[]` removes all rules.
|
|
166
|
+
* @param settings The new account security settings.
|
|
53
167
|
*
|
|
54
|
-
* @returns A {@link
|
|
168
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link AccountSecuritySettings} object.
|
|
55
169
|
*/
|
|
56
|
-
export declare const
|
|
170
|
+
export declare const updateAccountSecuritySettings: (apiSecret: string, settings: AccountSecuritySettings) => Promise<AccountSecuritySettings>;
|