@dolbyio/dolbyio-rest-apis-client 6.2.0 → 6.2.2
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/dist/index.js +1 -1
- package/dist/internal/httpHelpers.js +2 -0
- package/dist/streaming/assets.d.ts +2 -2
- package/dist/streaming/mediaDistributions.d.ts +5 -5
- package/dist/streaming/mediaDistributions.js +3 -3
- package/dist/streaming/monitoring.d.ts +47 -2
- package/dist/streaming/monitoring.js +165 -2
- package/dist/streaming/types/asset.d.ts +5 -1
- package/dist/streaming/types/index.d.ts +1 -0
- package/dist/streaming/types/index.js +11 -0
- package/dist/streaming/types/monitoring.d.ts +30 -8
- package/dist/streaming/types/webhooks.d.ts +19 -0
- package/package.json +6 -6
package/dist/index.js
CHANGED
|
@@ -44,6 +44,7 @@ var sendRequest = function sendRequest(options) {
|
|
|
44
44
|
};
|
|
45
45
|
|
|
46
46
|
// Override the User Agent
|
|
47
|
+
// @ts-ignore
|
|
47
48
|
opts.headers['User-Agent'] = "DolbyIoRestApiSdk/".concat(_index.version, "; Node/").concat(process.versions.node);
|
|
48
49
|
var req = _followRedirects.https.request(opts, function (res) {
|
|
49
50
|
_jsLogger["default"].info("[".concat(opts.method, "] ").concat(res.statusCode, " - https://").concat(opts.hostname).concat(opts.path));
|
|
@@ -202,6 +203,7 @@ var download = exports.download = function download(filepath, options) {
|
|
|
202
203
|
};
|
|
203
204
|
|
|
204
205
|
// Override the User Agent
|
|
206
|
+
// @ts-ignore
|
|
205
207
|
opts.headers['User-Agent'] = "DolbyIoRestApiSdk/".concat(_index.version, "; Node/").concat(process.versions.node);
|
|
206
208
|
var req = _followRedirects.https.request(opts, function (res) {
|
|
207
209
|
_jsLogger["default"].info("[".concat(opts.method, "] ").concat(res.statusCode, " - https://").concat(opts.hostname).concat(opts.path));
|
|
@@ -59,7 +59,7 @@ export declare const list: (apiSecret: string, params: ListMediaAssetsQueryParam
|
|
|
59
59
|
export declare const deleteAssets: (apiSecret: string, assetIds: string[]) => Promise<{
|
|
60
60
|
id?: string;
|
|
61
61
|
error?: string;
|
|
62
|
-
}[]>;
|
|
62
|
+
}[] | null>;
|
|
63
63
|
/**
|
|
64
64
|
* ## Read Media Asset
|
|
65
65
|
*
|
|
@@ -88,7 +88,7 @@ export declare const read: (apiSecret: string, assetId: string) => Promise<Asset
|
|
|
88
88
|
export declare const deleteAllAssets: (apiSecret: string, mediaAssetType: "recording" | "clip" | "storageValidation" | "timeline") => Promise<{
|
|
89
89
|
id?: string;
|
|
90
90
|
error?: string;
|
|
91
|
-
}[]>;
|
|
91
|
+
}[] | null>;
|
|
92
92
|
/**
|
|
93
93
|
* ## Generate Upload Credentials
|
|
94
94
|
*
|
|
@@ -53,7 +53,7 @@ export declare const read: (apiSecret: string, mediaDistributionId: string) => P
|
|
|
53
53
|
export declare const deleteMediaDistribution: (apiSecret: string, mediaDistributionId: string) => Promise<{
|
|
54
54
|
id?: string;
|
|
55
55
|
error?: string;
|
|
56
|
-
}[]>;
|
|
56
|
+
}[] | null>;
|
|
57
57
|
/**
|
|
58
58
|
* ## Updates Media Asset
|
|
59
59
|
*
|
|
@@ -64,7 +64,7 @@ export declare const deleteMediaDistribution: (apiSecret: string, mediaDistribut
|
|
|
64
64
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
65
65
|
* @param updateRequest The request body for creating a new media asset.
|
|
66
66
|
*
|
|
67
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
67
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link MediaDistribution} object.
|
|
68
68
|
*/
|
|
69
69
|
export declare const updateMediaDistribution: (apiSecret: string, updateRequest: UpdateMediaDistributionRequest) => Promise<MediaDistribution>;
|
|
70
70
|
/**
|
|
@@ -77,7 +77,7 @@ export declare const updateMediaDistribution: (apiSecret: string, updateRequest:
|
|
|
77
77
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
78
78
|
* @param mediaDistributionId The ID of the media distribution to get the security keys from.
|
|
79
79
|
*
|
|
80
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
80
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
|
|
81
81
|
*/
|
|
82
82
|
export declare const getSecurityKey: (apiSecret: string, mediaDistributionId: string) => Promise<SecurityKey[]>;
|
|
83
83
|
/**
|
|
@@ -90,7 +90,7 @@ export declare const getSecurityKey: (apiSecret: string, mediaDistributionId: st
|
|
|
90
90
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
91
91
|
* @param createRequest The request body for creating a new security key.
|
|
92
92
|
*
|
|
93
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
93
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
|
|
94
94
|
*/
|
|
95
95
|
export declare const createSecurityKey: (apiSecret: string, createRequest: CreaseSecurityKeyRequest) => Promise<SecurityKey>;
|
|
96
96
|
/**
|
|
@@ -109,4 +109,4 @@ export declare const createSecurityKey: (apiSecret: string, createRequest: Creas
|
|
|
109
109
|
export declare const deleteSecurityKey: (apiSecret: string, mediaDistributionId: string, securityKeyId: string) => Promise<{
|
|
110
110
|
status?: string;
|
|
111
111
|
message?: string;
|
|
112
|
-
}[]>;
|
|
112
|
+
}[] | null>;
|
|
@@ -180,7 +180,7 @@ var deleteMediaDistribution = exports.deleteMediaDistribution = /*#__PURE__*/fun
|
|
|
180
180
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
181
181
|
* @param updateRequest The request body for creating a new media asset.
|
|
182
182
|
*
|
|
183
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
183
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link MediaDistribution} object.
|
|
184
184
|
*/
|
|
185
185
|
var updateMediaDistribution = exports.updateMediaDistribution = /*#__PURE__*/function () {
|
|
186
186
|
var _ref5 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(apiSecret, updateRequest) {
|
|
@@ -224,7 +224,7 @@ var updateMediaDistribution = exports.updateMediaDistribution = /*#__PURE__*/fun
|
|
|
224
224
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
225
225
|
* @param mediaDistributionId The ID of the media distribution to get the security keys from.
|
|
226
226
|
*
|
|
227
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
227
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
|
|
228
228
|
*/
|
|
229
229
|
var getSecurityKey = exports.getSecurityKey = /*#__PURE__*/function () {
|
|
230
230
|
var _ref6 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(apiSecret, mediaDistributionId) {
|
|
@@ -262,7 +262,7 @@ var getSecurityKey = exports.getSecurityKey = /*#__PURE__*/function () {
|
|
|
262
262
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
263
263
|
* @param createRequest The request body for creating a new security key.
|
|
264
264
|
*
|
|
265
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
265
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link SecurityKey} object.
|
|
266
266
|
*/
|
|
267
267
|
var createSecurityKey = exports.createSecurityKey = /*#__PURE__*/function () {
|
|
268
268
|
var _ref7 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee7(apiSecret, createRequest) {
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import { GetStreamDetailsOptions, ListAllStreamsSortOptions, ListStreamsResponse, ListStreamsSortOptions, StreamDetails } from './types/monitoring';
|
|
1
|
+
import { GetStreamDetailsOptions, ListAllStreamsSortOptions, ListStreamsResponse, ListStreamsSortOptions, ListStreamSummariesResponse, ListStreamSummariesSortOptions, StreamDetails, StreamSummary } from './types/monitoring';
|
|
2
2
|
/**
|
|
3
3
|
* ## List Streams
|
|
4
4
|
*
|
|
@@ -39,6 +39,51 @@ export declare const listAllStreams: (apiSecret: string, options: ListAllStreams
|
|
|
39
39
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
40
40
|
* @param options Options to sort the response.
|
|
41
41
|
*
|
|
42
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
42
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamDetails} object.
|
|
43
43
|
*/
|
|
44
44
|
export declare const streamDetails: (apiSecret: string, options: GetStreamDetailsOptions) => Promise<StreamDetails>;
|
|
45
|
+
/**
|
|
46
|
+
* ## List Stream Summaries
|
|
47
|
+
*
|
|
48
|
+
* List a summary of all streams created within last hour with specific sorting and pagination.
|
|
49
|
+
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
|
|
50
|
+
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
|
|
51
|
+
* This is a lite version of {@link listStreams} which does not include feed details.
|
|
52
|
+
*
|
|
53
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
|
|
54
|
+
*
|
|
55
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
56
|
+
* @param options Options to sort the response.
|
|
57
|
+
*
|
|
58
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link ListStreamSummariesResponse} object.
|
|
59
|
+
*/
|
|
60
|
+
export declare const listStreamSummaries: (apiSecret: string, options: ListStreamSummariesSortOptions) => Promise<ListStreamSummariesResponse>;
|
|
61
|
+
/**
|
|
62
|
+
* ## List all Stream Summaries
|
|
63
|
+
*
|
|
64
|
+
* List a summary of all streams created within last hour with specific sorting and pagination.
|
|
65
|
+
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
|
|
66
|
+
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
|
|
67
|
+
* This is a lite version of {@link listAllStreams} which does not include feed details.
|
|
68
|
+
*
|
|
69
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
|
|
70
|
+
*
|
|
71
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
72
|
+
* @param options Options to sort the response.
|
|
73
|
+
*
|
|
74
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link StreamSummary} object.
|
|
75
|
+
*/
|
|
76
|
+
export declare const listAllStreamSummaries: (apiSecret: string, options: ListAllStreamsSortOptions) => Promise<StreamSummary[]>;
|
|
77
|
+
/**
|
|
78
|
+
* ## Stream Summary
|
|
79
|
+
*
|
|
80
|
+
* Get stream summary by stream name.
|
|
81
|
+
*
|
|
82
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-get-stream-summary/}
|
|
83
|
+
*
|
|
84
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
85
|
+
* @param options Options to sort the response.
|
|
86
|
+
*
|
|
87
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamSummary} object.
|
|
88
|
+
*/
|
|
89
|
+
export declare const streamSummary: (apiSecret: string, options: GetStreamDetailsOptions) => Promise<StreamSummary>;
|
|
@@ -4,7 +4,7 @@ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" ==
|
|
|
4
4
|
Object.defineProperty(exports, "__esModule", {
|
|
5
5
|
value: true
|
|
6
6
|
});
|
|
7
|
-
exports.streamDetails = exports.listStreams = exports.listAllStreams = void 0;
|
|
7
|
+
exports.streamSummary = exports.streamDetails = exports.listStreams = exports.listStreamSummaries = exports.listAllStreams = exports.listAllStreamSummaries = 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); }
|
|
@@ -162,7 +162,7 @@ var listAllStreams = exports.listAllStreams = /*#__PURE__*/function () {
|
|
|
162
162
|
* @param apiSecret The API Secret used to authenticate this request.
|
|
163
163
|
* @param options Options to sort the response.
|
|
164
164
|
*
|
|
165
|
-
* @returns A {@link !Promise Promise} whose fulfillment handler receives
|
|
165
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamDetails} object.
|
|
166
166
|
*/
|
|
167
167
|
var streamDetails = exports.streamDetails = /*#__PURE__*/function () {
|
|
168
168
|
var _ref3 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3(apiSecret, options) {
|
|
@@ -188,4 +188,167 @@ var streamDetails = exports.streamDetails = /*#__PURE__*/function () {
|
|
|
188
188
|
return function streamDetails(_x5, _x6) {
|
|
189
189
|
return _ref3.apply(this, arguments);
|
|
190
190
|
};
|
|
191
|
+
}();
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* ## List Stream Summaries
|
|
195
|
+
*
|
|
196
|
+
* List a summary of all streams created within last hour with specific sorting and pagination.
|
|
197
|
+
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
|
|
198
|
+
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
|
|
199
|
+
* This is a lite version of {@link listStreams} which does not include feed details.
|
|
200
|
+
*
|
|
201
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
|
|
202
|
+
*
|
|
203
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
204
|
+
* @param options Options to sort the response.
|
|
205
|
+
*
|
|
206
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives an {@link ListStreamSummariesResponse} object.
|
|
207
|
+
*/
|
|
208
|
+
var listStreamSummaries = exports.listStreamSummaries = /*#__PURE__*/function () {
|
|
209
|
+
var _ref4 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4(apiSecret, options) {
|
|
210
|
+
var _options$sortBy2, _options$page2, _options$itemsOnPage2, _options$isDescending2;
|
|
211
|
+
var params, queryOptions;
|
|
212
|
+
return _regenerator().w(function (_context4) {
|
|
213
|
+
while (1) switch (_context4.n) {
|
|
214
|
+
case 0:
|
|
215
|
+
params = {
|
|
216
|
+
sortBy: (_options$sortBy2 = options.sortBy) !== null && _options$sortBy2 !== void 0 ? _options$sortBy2 : 'Live',
|
|
217
|
+
page: ((_options$page2 = options.page) !== null && _options$page2 !== void 0 ? _options$page2 : 1).toString(),
|
|
218
|
+
itemsOnPage: ((_options$itemsOnPage2 = options.itemsOnPage) !== null && _options$itemsOnPage2 !== void 0 ? _options$itemsOnPage2 : 10).toString(),
|
|
219
|
+
isDescending: ((_options$isDescending2 = options.isDescending) !== null && _options$isDescending2 !== void 0 ? _options$isDescending2 : false).toString()
|
|
220
|
+
};
|
|
221
|
+
if (options.isActive) {
|
|
222
|
+
params['isActive'] = options.isActive;
|
|
223
|
+
}
|
|
224
|
+
if (options.cluster) {
|
|
225
|
+
params['cluster'] = options.cluster.join(',');
|
|
226
|
+
}
|
|
227
|
+
if (options.isSecure) {
|
|
228
|
+
params['isSecure'] = options.isSecure;
|
|
229
|
+
}
|
|
230
|
+
if (options.isMultisource) {
|
|
231
|
+
params['isMultisource'] = options.isMultisource;
|
|
232
|
+
}
|
|
233
|
+
if (options.searchSubstring) {
|
|
234
|
+
params['searchSubstring'] = options.searchSubstring;
|
|
235
|
+
}
|
|
236
|
+
if (options.isRecordingAllowed) {
|
|
237
|
+
params['isRecordingAllowed'] = options.isRecordingAllowed;
|
|
238
|
+
}
|
|
239
|
+
if (options.transcoderId) {
|
|
240
|
+
params['transcoderId'] = options.transcoderId;
|
|
241
|
+
}
|
|
242
|
+
queryOptions = {
|
|
243
|
+
hostname: Urls.getRtsHostname(),
|
|
244
|
+
path: '/api/monitoring/summary',
|
|
245
|
+
params: params,
|
|
246
|
+
headers: {
|
|
247
|
+
Accept: 'application/json',
|
|
248
|
+
Authorization: "Bearer ".concat(apiSecret)
|
|
249
|
+
}
|
|
250
|
+
};
|
|
251
|
+
_context4.n = 1;
|
|
252
|
+
return (0, _httpHelpers.sendGet)(queryOptions);
|
|
253
|
+
case 1:
|
|
254
|
+
return _context4.a(2, _context4.v);
|
|
255
|
+
}
|
|
256
|
+
}, _callee4);
|
|
257
|
+
}));
|
|
258
|
+
return function listStreamSummaries(_x7, _x8) {
|
|
259
|
+
return _ref4.apply(this, arguments);
|
|
260
|
+
};
|
|
261
|
+
}();
|
|
262
|
+
|
|
263
|
+
/**
|
|
264
|
+
* ## List all Stream Summaries
|
|
265
|
+
*
|
|
266
|
+
* List a summary of all streams created within last hour with specific sorting and pagination.
|
|
267
|
+
* If the transcoderId is provided, all streams associated with the current or last active instance will be returned,
|
|
268
|
+
* regardless of the stream creation time. If response array is empty, you have reached the end of the list ordering.
|
|
269
|
+
* This is a lite version of {@link listAllStreams} which does not include feed details.
|
|
270
|
+
*
|
|
271
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-list-stream-summary/}
|
|
272
|
+
*
|
|
273
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
274
|
+
* @param options Options to sort the response.
|
|
275
|
+
*
|
|
276
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives an array of {@link StreamSummary} object.
|
|
277
|
+
*/
|
|
278
|
+
var listAllStreamSummaries = exports.listAllStreamSummaries = /*#__PURE__*/function () {
|
|
279
|
+
var _ref5 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee5(apiSecret, options) {
|
|
280
|
+
var result, page, listOptions, response;
|
|
281
|
+
return _regenerator().w(function (_context5) {
|
|
282
|
+
while (1) switch (_context5.n) {
|
|
283
|
+
case 0:
|
|
284
|
+
result = [];
|
|
285
|
+
page = 1;
|
|
286
|
+
case 1:
|
|
287
|
+
listOptions = _objectSpread(_objectSpread({}, options), {}, {
|
|
288
|
+
page: page,
|
|
289
|
+
itemsOnPage: 25
|
|
290
|
+
});
|
|
291
|
+
_context5.n = 2;
|
|
292
|
+
return listStreamSummaries(apiSecret, listOptions);
|
|
293
|
+
case 2:
|
|
294
|
+
response = _context5.v;
|
|
295
|
+
if (!(response.data.length === 0)) {
|
|
296
|
+
_context5.n = 3;
|
|
297
|
+
break;
|
|
298
|
+
}
|
|
299
|
+
return _context5.a(3, 5);
|
|
300
|
+
case 3:
|
|
301
|
+
result.push.apply(result, _toConsumableArray(response.data));
|
|
302
|
+
page++;
|
|
303
|
+
case 4:
|
|
304
|
+
if (true) {
|
|
305
|
+
_context5.n = 1;
|
|
306
|
+
break;
|
|
307
|
+
}
|
|
308
|
+
case 5:
|
|
309
|
+
return _context5.a(2, result);
|
|
310
|
+
}
|
|
311
|
+
}, _callee5);
|
|
312
|
+
}));
|
|
313
|
+
return function listAllStreamSummaries(_x9, _x0) {
|
|
314
|
+
return _ref5.apply(this, arguments);
|
|
315
|
+
};
|
|
316
|
+
}();
|
|
317
|
+
|
|
318
|
+
/**
|
|
319
|
+
* ## Stream Summary
|
|
320
|
+
*
|
|
321
|
+
* Get stream summary by stream name.
|
|
322
|
+
*
|
|
323
|
+
* @see {@link https://optiview.dolby.com/docs/millicast/api/monitoring-get-stream-summary/}
|
|
324
|
+
*
|
|
325
|
+
* @param apiSecret The API Secret used to authenticate this request.
|
|
326
|
+
* @param options Options to sort the response.
|
|
327
|
+
*
|
|
328
|
+
* @returns A {@link !Promise Promise} whose fulfillment handler receives a {@link StreamSummary} object.
|
|
329
|
+
*/
|
|
330
|
+
var streamSummary = exports.streamSummary = /*#__PURE__*/function () {
|
|
331
|
+
var _ref6 = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee6(apiSecret, options) {
|
|
332
|
+
var queryOptions;
|
|
333
|
+
return _regenerator().w(function (_context6) {
|
|
334
|
+
while (1) switch (_context6.n) {
|
|
335
|
+
case 0:
|
|
336
|
+
queryOptions = {
|
|
337
|
+
hostname: Urls.getRtsHostname(),
|
|
338
|
+
path: "/api/monitoring/summary/".concat(options.streamName),
|
|
339
|
+
headers: {
|
|
340
|
+
Accept: 'application/json',
|
|
341
|
+
Authorization: "Bearer ".concat(apiSecret)
|
|
342
|
+
}
|
|
343
|
+
};
|
|
344
|
+
_context6.n = 1;
|
|
345
|
+
return (0, _httpHelpers.sendGet)(queryOptions);
|
|
346
|
+
case 1:
|
|
347
|
+
return _context6.a(2, _context6.v);
|
|
348
|
+
}
|
|
349
|
+
}, _callee6);
|
|
350
|
+
}));
|
|
351
|
+
return function streamSummary(_x1, _x10) {
|
|
352
|
+
return _ref6.apply(this, arguments);
|
|
353
|
+
};
|
|
191
354
|
}();
|
|
@@ -123,7 +123,7 @@ export interface AssetResponseData {
|
|
|
123
123
|
/** Optional, ID of the object. */
|
|
124
124
|
id?: string | null;
|
|
125
125
|
/** Required, type of the object. */
|
|
126
|
-
type: 'recording' | 'clip' | 'storageValidation' | 'timeline' | '
|
|
126
|
+
type: 'recording' | 'clip' | 'storageValidation' | 'timeline' | 'vod';
|
|
127
127
|
/** Optional, information about the asset. */
|
|
128
128
|
feed?: MediaAssetFeedSelectionModel;
|
|
129
129
|
/** Required, ISO 8601 date string, Start time of clip. */
|
|
@@ -148,6 +148,10 @@ export interface AssetResponseData {
|
|
|
148
148
|
metadata?: RecordMetadata;
|
|
149
149
|
/** Optional, asset download URL. */
|
|
150
150
|
download?: RecordDownloadUrl;
|
|
151
|
+
/** Optional, Media distribution ID. */
|
|
152
|
+
mediaDistributionId?: string | null;
|
|
153
|
+
/** Optional, custom path for VOD content. */
|
|
154
|
+
customPath?: string | null;
|
|
151
155
|
}
|
|
152
156
|
/**
|
|
153
157
|
* The allowable sort options for listing media assets.
|
|
@@ -47,6 +47,17 @@ Object.keys(_director).forEach(function (key) {
|
|
|
47
47
|
}
|
|
48
48
|
});
|
|
49
49
|
});
|
|
50
|
+
var _mediaDistributions = require("./mediaDistributions");
|
|
51
|
+
Object.keys(_mediaDistributions).forEach(function (key) {
|
|
52
|
+
if (key === "default" || key === "__esModule") return;
|
|
53
|
+
if (key in exports && exports[key] === _mediaDistributions[key]) return;
|
|
54
|
+
Object.defineProperty(exports, key, {
|
|
55
|
+
enumerable: true,
|
|
56
|
+
get: function get() {
|
|
57
|
+
return _mediaDistributions[key];
|
|
58
|
+
}
|
|
59
|
+
});
|
|
60
|
+
});
|
|
50
61
|
var _monitoring = require("./monitoring");
|
|
51
62
|
Object.keys(_monitoring).forEach(function (key) {
|
|
52
63
|
if (key === "default" || key === "__esModule") return;
|
|
@@ -12,8 +12,21 @@ export interface ListStreamsResponse {
|
|
|
12
12
|
/** Array of stream details. */
|
|
13
13
|
data: StreamDetails[];
|
|
14
14
|
}
|
|
15
|
-
|
|
16
|
-
|
|
15
|
+
export interface ListStreamSummariesResponse {
|
|
16
|
+
/** Pagination object. */
|
|
17
|
+
pagination?: {
|
|
18
|
+
/** Total number of items. */
|
|
19
|
+
totalItems: number;
|
|
20
|
+
/** Total number of pages. */
|
|
21
|
+
totalPages: number;
|
|
22
|
+
/** Number of items in that page. */
|
|
23
|
+
itemsOnPage: number;
|
|
24
|
+
};
|
|
25
|
+
/** Array of stream details. */
|
|
26
|
+
data: StreamSummary[];
|
|
27
|
+
}
|
|
28
|
+
/** Represents a stream summary. */
|
|
29
|
+
export interface StreamSummary {
|
|
17
30
|
/** Identifier of the stream. */
|
|
18
31
|
streamId: string;
|
|
19
32
|
/** Name of the stream. */
|
|
@@ -36,6 +49,9 @@ export interface StreamDetails {
|
|
|
36
49
|
endTime: string;
|
|
37
50
|
/** Viewer count. */
|
|
38
51
|
viewerCount: number;
|
|
52
|
+
}
|
|
53
|
+
/** Represents a stream details. */
|
|
54
|
+
export interface StreamDetails extends StreamSummary {
|
|
39
55
|
/** Has redundant stream. */
|
|
40
56
|
hasRedundant: boolean;
|
|
41
57
|
/** Restreaming enabled. */
|
|
@@ -170,7 +186,7 @@ export interface FeedStats {
|
|
|
170
186
|
packetLoss: number;
|
|
171
187
|
}
|
|
172
188
|
/** Represents the options to sort the response for listing all the streams. */
|
|
173
|
-
export interface
|
|
189
|
+
export interface ListAllStreamSummariesSortOptions {
|
|
174
190
|
/** How to sort the response. */
|
|
175
191
|
sortBy: 'Live';
|
|
176
192
|
/** Active streams. */
|
|
@@ -181,19 +197,25 @@ export interface ListAllStreamsSortOptions {
|
|
|
181
197
|
isSecure?: boolean;
|
|
182
198
|
/** Multi source streams. */
|
|
183
199
|
isMultisource?: boolean;
|
|
184
|
-
/** Redundant streams. */
|
|
185
|
-
hasRedundant?: boolean;
|
|
186
200
|
/** Filter the stream names. */
|
|
187
201
|
searchSubstring?: string;
|
|
188
202
|
/** Recorded allowed. */
|
|
189
203
|
isRecordingAllowed?: boolean;
|
|
190
|
-
/** Restreaming streams. */
|
|
191
|
-
isRestreaming?: boolean;
|
|
192
204
|
/** Identifier of the transcoder. */
|
|
193
205
|
transcoderId?: string;
|
|
194
206
|
}
|
|
207
|
+
/** Represents the options to sort the response for listing all the streams. */
|
|
208
|
+
export interface ListAllStreamsSortOptions extends ListAllStreamSummariesSortOptions {
|
|
209
|
+
/** Redundant streams. */
|
|
210
|
+
hasRedundant?: boolean;
|
|
211
|
+
/** Restreaming streams. */
|
|
212
|
+
isRestreaming?: boolean;
|
|
213
|
+
}
|
|
214
|
+
/** Represents the options to sort the response for listing streams. */
|
|
215
|
+
export interface ListStreamSummariesSortOptions extends ListAllStreamsSortOptions, ListSortOptions<'Live'> {
|
|
216
|
+
}
|
|
195
217
|
/** Represents the options to sort the response for listing streams. */
|
|
196
|
-
export interface ListStreamsSortOptions extends
|
|
218
|
+
export interface ListStreamsSortOptions extends ListStreamSummariesSortOptions {
|
|
197
219
|
}
|
|
198
220
|
/** Represents the options to query the stream details. */
|
|
199
221
|
export interface GetStreamDetailsOptions {
|
|
@@ -31,6 +31,12 @@ export interface Webhook {
|
|
|
31
31
|
/** Reason why the webhook was disabled. */
|
|
32
32
|
reason: string;
|
|
33
33
|
};
|
|
34
|
+
/**
|
|
35
|
+
* A regular expression used to filter the events sent to this webhook based on StreamName or TranscoderName.
|
|
36
|
+
* For event types `feeds`, `media`, `recording`, `thumbnail` and `viewerConnection` the filter applies to the `StreamName` field.
|
|
37
|
+
* For event type `transcoder` the filter applies to the `TranscoderName` field.
|
|
38
|
+
*/
|
|
39
|
+
filter?: string;
|
|
34
40
|
}
|
|
35
41
|
/** Represents a webhook update request. */
|
|
36
42
|
export interface UpdateWebhookRequest {
|
|
@@ -52,6 +58,13 @@ export interface UpdateWebhookRequest {
|
|
|
52
58
|
isViewerConnectionHooks?: boolean;
|
|
53
59
|
/** Set to `true` to immediately re-enable the webhook if it has been temporarily disabled. */
|
|
54
60
|
reEnable?: boolean;
|
|
61
|
+
/**
|
|
62
|
+
* A regular expression used to filter the events sent to this webhook based on StreamName or TranscoderName.
|
|
63
|
+
* For event types `feeds`, `media`, `recording`, `thumbnail` and `viewerConnection` the filter applies to the `StreamName` field.
|
|
64
|
+
* For event type `transcoder` the filter applies to the `TranscoderName` field.
|
|
65
|
+
* Set to `null` to clear value.
|
|
66
|
+
*/
|
|
67
|
+
filter?: string;
|
|
55
68
|
}
|
|
56
69
|
/** Represents a webhook listing request. */
|
|
57
70
|
export interface ListWebhooksRequest {
|
|
@@ -89,6 +102,12 @@ export interface AddWebhookRequest {
|
|
|
89
102
|
* @defaultValue `false`.
|
|
90
103
|
*/
|
|
91
104
|
isViewerConnectionHooks?: boolean;
|
|
105
|
+
/**
|
|
106
|
+
* A regular expression used to filter the events sent to this webhook based on StreamName or TranscoderName.
|
|
107
|
+
* For event types `feeds`, `media`, `recording`, `thumbnail` and `viewerConnection` the filter applies to the `StreamName` field.
|
|
108
|
+
* For event type `transcoder` the filter applies to the `TranscoderName` field.
|
|
109
|
+
*/
|
|
110
|
+
filter?: string;
|
|
92
111
|
}
|
|
93
112
|
/** Types of webhook events. */
|
|
94
113
|
export type WebhookType = 'Recordings' | 'Thumbnail' | 'Transcoder' | 'Media' | 'Feeds' | 'ViewerConnection';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dolbyio/dolbyio-rest-apis-client",
|
|
3
|
-
"version": "6.2.
|
|
3
|
+
"version": "6.2.2",
|
|
4
4
|
"description": "Node.JS wrapper for the Dolby OptiView REST APIs",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -45,16 +45,16 @@
|
|
|
45
45
|
"@babel/preset-env": "^7.29.0",
|
|
46
46
|
"@babel/preset-typescript": "^7.28.5",
|
|
47
47
|
"@types/follow-redirects": "^1.14.4",
|
|
48
|
-
"@types/node": "^25.
|
|
48
|
+
"@types/node": "^25.6.2",
|
|
49
49
|
"babel-plugin-inline-replace-variables": "^1.3.1",
|
|
50
50
|
"npm-watch": "^0.13.0",
|
|
51
|
-
"prettier": "^3.8.
|
|
52
|
-
"typedoc": "^0.28.
|
|
51
|
+
"prettier": "^3.8.3",
|
|
52
|
+
"typedoc": "^0.28.19",
|
|
53
53
|
"typedoc-plugin-mdn-links": "^5.1.1",
|
|
54
|
-
"typescript": "^
|
|
54
|
+
"typescript": "^6.0.3"
|
|
55
55
|
},
|
|
56
56
|
"dependencies": {
|
|
57
|
-
"follow-redirects": "^1.
|
|
57
|
+
"follow-redirects": "^1.16.0",
|
|
58
58
|
"js-logger": "^1.6.1"
|
|
59
59
|
}
|
|
60
60
|
}
|