@bitmovin/api-sdk 1.160.0 → 1.162.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/bitmovin-api-sdk.browser.js +601 -9
- package/dist/bitmovin-api-sdk.browser.min.js +1 -1
- package/dist/common/RestClient.js +1 -1
- package/dist/encoding/EncodingApi.d.ts +2 -0
- package/dist/encoding/EncodingApi.js +2 -0
- package/dist/encoding/encodings/EncodingListQueryParams.d.ts +11 -0
- package/dist/encoding/encodings/EncodingListQueryParams.js +8 -0
- package/dist/encoding/history/HistoryApi.d.ts +13 -0
- package/dist/encoding/history/HistoryApi.js +35 -0
- package/dist/encoding/history/encodings/EncodingListQueryParams.d.ts +206 -0
- package/dist/encoding/history/encodings/EncodingListQueryParams.js +157 -0
- package/dist/encoding/history/encodings/EncodingsApi.d.ts +29 -0
- package/dist/encoding/history/encodings/EncodingsApi.js +69 -0
- package/dist/models/Av1VideoConfiguration.d.ts +1 -1
- package/dist/models/H264VideoConfiguration.d.ts +1 -1
- package/dist/models/H265VideoConfiguration.d.ts +1 -1
- package/dist/models/HistoryEncoding.d.ts +85 -0
- package/dist/models/HistoryEncoding.js +42 -0
- package/dist/models/HistoryMuxing.d.ts +69 -0
- package/dist/models/HistoryMuxing.js +38 -0
- package/dist/models/HistoryStream.d.ts +85 -0
- package/dist/models/HistoryStream.js +40 -0
- package/dist/models/LiveHlsManifest.d.ts +7 -0
- package/dist/models/LiveHlsManifest.js +2 -0
- package/dist/models/ProgramDateTimeSettings.d.ts +14 -0
- package/dist/models/ProgramDateTimeSettings.js +19 -0
- package/dist/models/ProgramDateTimeSource.d.ts +10 -0
- package/dist/models/ProgramDateTimeSource.js +14 -0
- package/dist/models/StreamsAdConfigAd.d.ts +23 -0
- package/dist/models/StreamsAdConfigAd.js +21 -0
- package/dist/models/StreamsAdConfigResponse.d.ts +20 -0
- package/dist/models/StreamsAdConfigResponse.js +21 -0
- package/dist/models/StreamsLiveCreateRequest.d.ts +6 -0
- package/dist/models/StreamsLiveCreateRequest.js +1 -0
- package/dist/models/StreamsLiveResponse.d.ts +6 -0
- package/dist/models/StreamsLiveResponse.js +2 -0
- package/dist/models/StreamsLiveUpdateRequest.d.ts +6 -0
- package/dist/models/StreamsLiveUpdateRequest.js +1 -0
- package/dist/models/StreamsVideoCreateRequest.d.ts +6 -0
- package/dist/models/StreamsVideoCreateRequest.js +1 -0
- package/dist/models/StreamsVideoResponse.d.ts +6 -0
- package/dist/models/StreamsVideoResponse.js +2 -0
- package/dist/models/StreamsVideoUpdateRequest.d.ts +6 -0
- package/dist/models/StreamsVideoUpdateRequest.js +1 -0
- package/dist/models/Vp9VideoConfiguration.d.ts +1 -1
- package/dist/models/index.d.ts +7 -0
- package/dist/models/index.js +7 -0
- package/dist/streams/live/LiveApi.d.ts +2 -2
- package/dist/streams/live/LiveApi.js +2 -3
- package/package.json +1 -1
|
@@ -240,7 +240,7 @@ var HeaderHandler = /** @class */ (function (_super) {
|
|
|
240
240
|
var headers = {
|
|
241
241
|
'X-Api-Key': apiKey,
|
|
242
242
|
'X-Api-Client': 'bitmovin-api-sdk-javascript',
|
|
243
|
-
'X-Api-Client-Version': '1.
|
|
243
|
+
'X-Api-Client-Version': '1.162.0',
|
|
244
244
|
'Content-Type': 'application/json'
|
|
245
245
|
};
|
|
246
246
|
if (tenantOrgId) {
|
|
@@ -10,6 +10,7 @@ import InfrastructureApi from './infrastructure/InfrastructureApi';
|
|
|
10
10
|
import StatisticsApi from './statistics/StatisticsApi';
|
|
11
11
|
import WatchFoldersApi from './watchFolders/WatchFoldersApi';
|
|
12
12
|
import SimpleApi from './simple/SimpleApi';
|
|
13
|
+
import HistoryApi from './history/HistoryApi';
|
|
13
14
|
import ErrorDefinitionsApi from './errorDefinitions/ErrorDefinitionsApi';
|
|
14
15
|
/**
|
|
15
16
|
* EncodingApi - object-oriented interface
|
|
@@ -28,6 +29,7 @@ export default class EncodingApi extends BaseAPI {
|
|
|
28
29
|
statistics: StatisticsApi;
|
|
29
30
|
watchFolders: WatchFoldersApi;
|
|
30
31
|
simple: SimpleApi;
|
|
32
|
+
history: HistoryApi;
|
|
31
33
|
errorDefinitions: ErrorDefinitionsApi;
|
|
32
34
|
constructor(configuration: Configuration);
|
|
33
35
|
}
|
|
@@ -26,6 +26,7 @@ var InfrastructureApi_1 = require("./infrastructure/InfrastructureApi");
|
|
|
26
26
|
var StatisticsApi_1 = require("./statistics/StatisticsApi");
|
|
27
27
|
var WatchFoldersApi_1 = require("./watchFolders/WatchFoldersApi");
|
|
28
28
|
var SimpleApi_1 = require("./simple/SimpleApi");
|
|
29
|
+
var HistoryApi_1 = require("./history/HistoryApi");
|
|
29
30
|
var ErrorDefinitionsApi_1 = require("./errorDefinitions/ErrorDefinitionsApi");
|
|
30
31
|
/**
|
|
31
32
|
* EncodingApi - object-oriented interface
|
|
@@ -47,6 +48,7 @@ var EncodingApi = /** @class */ (function (_super) {
|
|
|
47
48
|
_this.statistics = new StatisticsApi_1.default(configuration);
|
|
48
49
|
_this.watchFolders = new WatchFoldersApi_1.default(configuration);
|
|
49
50
|
_this.simple = new SimpleApi_1.default(configuration);
|
|
51
|
+
_this.history = new HistoryApi_1.default(configuration);
|
|
50
52
|
_this.errorDefinitions = new ErrorDefinitionsApi_1.default(configuration);
|
|
51
53
|
return _this;
|
|
52
54
|
}
|
|
@@ -13,6 +13,12 @@ export interface EncodingListQueryParams {
|
|
|
13
13
|
* @memberof EncodingListQueryParams
|
|
14
14
|
*/
|
|
15
15
|
limit?: number | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* A boolean indicating whether the total count should be returned as well. Default is true
|
|
18
|
+
* @type {boolean}
|
|
19
|
+
* @memberof EncodingListQueryParams
|
|
20
|
+
*/
|
|
21
|
+
includeTotalCount?: boolean | undefined;
|
|
16
22
|
/**
|
|
17
23
|
* Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
|
|
18
24
|
* @type {string}
|
|
@@ -122,6 +128,11 @@ export declare class EncodingListQueryParamsBuilder {
|
|
|
122
128
|
* @param limit Maximum number of items to return. Default is 25, maximum is 100
|
|
123
129
|
*/
|
|
124
130
|
limit(limit: number): this;
|
|
131
|
+
/**
|
|
132
|
+
*
|
|
133
|
+
* @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is true
|
|
134
|
+
*/
|
|
135
|
+
includeTotalCount(includeTotalCount: boolean): this;
|
|
125
136
|
/**
|
|
126
137
|
*
|
|
127
138
|
* @param sort Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
|
|
@@ -21,6 +21,14 @@ var EncodingListQueryParamsBuilder = /** @class */ (function () {
|
|
|
21
21
|
this.internalParams.limit = limit;
|
|
22
22
|
return this;
|
|
23
23
|
};
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is true
|
|
27
|
+
*/
|
|
28
|
+
EncodingListQueryParamsBuilder.prototype.includeTotalCount = function (includeTotalCount) {
|
|
29
|
+
this.internalParams.includeTotalCount = includeTotalCount;
|
|
30
|
+
return this;
|
|
31
|
+
};
|
|
24
32
|
/**
|
|
25
33
|
*
|
|
26
34
|
* @param sort Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { BaseAPI } from '../../common/BaseAPI';
|
|
2
|
+
import Configuration from '../../common/Configuration';
|
|
3
|
+
import EncodingsApi from './encodings/EncodingsApi';
|
|
4
|
+
/**
|
|
5
|
+
* HistoryApi - object-oriented interface
|
|
6
|
+
* @export
|
|
7
|
+
* @class HistoryApi
|
|
8
|
+
* @extends {BaseAPI}
|
|
9
|
+
*/
|
|
10
|
+
export default class HistoryApi extends BaseAPI {
|
|
11
|
+
encodings: EncodingsApi;
|
|
12
|
+
constructor(configuration: Configuration);
|
|
13
|
+
}
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __extends = (this && this.__extends) || (function () {
|
|
3
|
+
var extendStatics = function (d, b) {
|
|
4
|
+
extendStatics = Object.setPrototypeOf ||
|
|
5
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
6
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
7
|
+
return extendStatics(d, b);
|
|
8
|
+
};
|
|
9
|
+
return function (d, b) {
|
|
10
|
+
if (typeof b !== "function" && b !== null)
|
|
11
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
12
|
+
extendStatics(d, b);
|
|
13
|
+
function __() { this.constructor = d; }
|
|
14
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
15
|
+
};
|
|
16
|
+
})();
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
var BaseAPI_1 = require("../../common/BaseAPI");
|
|
19
|
+
var EncodingsApi_1 = require("./encodings/EncodingsApi");
|
|
20
|
+
/**
|
|
21
|
+
* HistoryApi - object-oriented interface
|
|
22
|
+
* @export
|
|
23
|
+
* @class HistoryApi
|
|
24
|
+
* @extends {BaseAPI}
|
|
25
|
+
*/
|
|
26
|
+
var HistoryApi = /** @class */ (function (_super) {
|
|
27
|
+
__extends(HistoryApi, _super);
|
|
28
|
+
function HistoryApi(configuration) {
|
|
29
|
+
var _this = _super.call(this, configuration) || this;
|
|
30
|
+
_this.encodings = new EncodingsApi_1.default(configuration);
|
|
31
|
+
return _this;
|
|
32
|
+
}
|
|
33
|
+
return HistoryApi;
|
|
34
|
+
}(BaseAPI_1.BaseAPI));
|
|
35
|
+
exports.default = HistoryApi;
|
|
@@ -0,0 +1,206 @@
|
|
|
1
|
+
import CloudRegion from '../../../models/CloudRegion';
|
|
2
|
+
import EncodingMode from '../../../models/EncodingMode';
|
|
3
|
+
export interface EncodingListQueryParams {
|
|
4
|
+
/**
|
|
5
|
+
* Index of the first item to return, starting at 0. Default is 0
|
|
6
|
+
* @type {number}
|
|
7
|
+
* @memberof EncodingListQueryParams
|
|
8
|
+
*/
|
|
9
|
+
offset?: number | undefined;
|
|
10
|
+
/**
|
|
11
|
+
* Maximum number of items to return. Default is 25, maximum is 100
|
|
12
|
+
* @type {number}
|
|
13
|
+
* @memberof EncodingListQueryParams
|
|
14
|
+
*/
|
|
15
|
+
limit?: number | undefined;
|
|
16
|
+
/**
|
|
17
|
+
* Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
|
|
18
|
+
* @type {string}
|
|
19
|
+
* @memberof EncodingListQueryParams
|
|
20
|
+
*/
|
|
21
|
+
sort?: string | undefined;
|
|
22
|
+
/**
|
|
23
|
+
* Filter encodings to only show the ones with the type specified.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof EncodingListQueryParams
|
|
26
|
+
*/
|
|
27
|
+
type?: string | undefined;
|
|
28
|
+
/**
|
|
29
|
+
* Filter encodings to only show the ones with the status specified.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof EncodingListQueryParams
|
|
32
|
+
*/
|
|
33
|
+
status?: string | undefined;
|
|
34
|
+
/**
|
|
35
|
+
* Filter encodings to only show the ones with the cloudRegion specified.
|
|
36
|
+
* @type {CloudRegion}
|
|
37
|
+
* @memberof EncodingListQueryParams
|
|
38
|
+
*/
|
|
39
|
+
cloudRegion?: CloudRegion | undefined;
|
|
40
|
+
/**
|
|
41
|
+
* Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
|
|
42
|
+
* @type {CloudRegion}
|
|
43
|
+
* @memberof EncodingListQueryParams
|
|
44
|
+
*/
|
|
45
|
+
selectedCloudRegion?: CloudRegion | undefined;
|
|
46
|
+
/**
|
|
47
|
+
* Filter encodings to only show the ones with the encoderVersion specified.
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof EncodingListQueryParams
|
|
50
|
+
*/
|
|
51
|
+
encoderVersion?: string | undefined;
|
|
52
|
+
/**
|
|
53
|
+
* Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
|
|
54
|
+
* @type {string}
|
|
55
|
+
* @memberof EncodingListQueryParams
|
|
56
|
+
*/
|
|
57
|
+
selectedEncoderVersion?: string | undefined;
|
|
58
|
+
/**
|
|
59
|
+
* Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
|
|
60
|
+
* @type {EncodingMode}
|
|
61
|
+
* @memberof EncodingListQueryParams
|
|
62
|
+
*/
|
|
63
|
+
selectedEncodingMode?: EncodingMode | undefined;
|
|
64
|
+
/**
|
|
65
|
+
* Filter encodings to only show the ones with this exact name.
|
|
66
|
+
* @type {string}
|
|
67
|
+
* @memberof EncodingListQueryParams
|
|
68
|
+
*/
|
|
69
|
+
name?: string | undefined;
|
|
70
|
+
/**
|
|
71
|
+
* The search query string for advanced filtering. We are using the [Apache Lucene](https://lucene.apache.org/) query syntax here. Only lucene queries equivalent to exact matching and startsWith are supported. Also only AND conjunctions supported at the moment. Please be aware that our filters are **case-insensitive** Examples of supported lucene queries: + `name:MyEncoding1` - This searches for encodings with names that are equal to `myencoding1` + `name:\"My Encoding\"` - This searches for encodings with names that are equal to `my encoding` + `name:MyEncoding\\*` - This searches for encodings with names that are equal to `myencoding*` Please have a look at the [Lucene Documentation - Escaping Special Characters](https://lucene.apache.org/core/8_1_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters) section to see what characters have to be escaped. + `name:test*` - This searches for encodings with names that start with `test` + `name:test* AND labels:Customer1` - This searches for encodings with names starting with `test` and labels containing an entry that is equal to `customer1` Available search fields: + `name` + `labels` Please be aware to send these queries url encoded. If you provide fields or lucene queries that are not supported, it will result in an error response.
|
|
72
|
+
* @type {string}
|
|
73
|
+
* @memberof EncodingListQueryParams
|
|
74
|
+
*/
|
|
75
|
+
search?: string | undefined;
|
|
76
|
+
/**
|
|
77
|
+
* Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
78
|
+
* @type {Date}
|
|
79
|
+
* @memberof EncodingListQueryParams
|
|
80
|
+
*/
|
|
81
|
+
createdAtNewerThan?: Date | undefined;
|
|
82
|
+
/**
|
|
83
|
+
* Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
84
|
+
* @type {Date}
|
|
85
|
+
* @memberof EncodingListQueryParams
|
|
86
|
+
*/
|
|
87
|
+
createdAtOlderThan?: Date | undefined;
|
|
88
|
+
/**
|
|
89
|
+
* Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
90
|
+
* @type {Date}
|
|
91
|
+
* @memberof EncodingListQueryParams
|
|
92
|
+
*/
|
|
93
|
+
startedAtNewerThan?: Date | undefined;
|
|
94
|
+
/**
|
|
95
|
+
* Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
96
|
+
* @type {Date}
|
|
97
|
+
* @memberof EncodingListQueryParams
|
|
98
|
+
*/
|
|
99
|
+
startedAtOlderThan?: Date | undefined;
|
|
100
|
+
/**
|
|
101
|
+
* Filter encodings to only return those finished at newer than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
|
|
102
|
+
* @type {Date}
|
|
103
|
+
* @memberof EncodingListQueryParams
|
|
104
|
+
*/
|
|
105
|
+
finishedAtNewerThan?: Date | undefined;
|
|
106
|
+
/**
|
|
107
|
+
* Filter encodings to only return those finished at older than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
|
|
108
|
+
* @type {Date}
|
|
109
|
+
* @memberof EncodingListQueryParams
|
|
110
|
+
*/
|
|
111
|
+
finishedAtOlderThan?: Date | undefined;
|
|
112
|
+
}
|
|
113
|
+
export declare class EncodingListQueryParamsBuilder {
|
|
114
|
+
private internalParams;
|
|
115
|
+
/**
|
|
116
|
+
*
|
|
117
|
+
* @param offset Index of the first item to return, starting at 0. Default is 0
|
|
118
|
+
*/
|
|
119
|
+
offset(offset: number): this;
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @param limit Maximum number of items to return. Default is 25, maximum is 100
|
|
123
|
+
*/
|
|
124
|
+
limit(limit: number): this;
|
|
125
|
+
/**
|
|
126
|
+
*
|
|
127
|
+
* @param sort Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
|
|
128
|
+
*/
|
|
129
|
+
sort(sort: string): this;
|
|
130
|
+
/**
|
|
131
|
+
*
|
|
132
|
+
* @param type Filter encodings to only show the ones with the type specified.
|
|
133
|
+
*/
|
|
134
|
+
type(type: string): this;
|
|
135
|
+
/**
|
|
136
|
+
*
|
|
137
|
+
* @param status Filter encodings to only show the ones with the status specified.
|
|
138
|
+
*/
|
|
139
|
+
status(status: string): this;
|
|
140
|
+
/**
|
|
141
|
+
*
|
|
142
|
+
* @param cloudRegion Filter encodings to only show the ones with the cloudRegion specified.
|
|
143
|
+
*/
|
|
144
|
+
cloudRegion(cloudRegion: CloudRegion): this;
|
|
145
|
+
/**
|
|
146
|
+
*
|
|
147
|
+
* @param selectedCloudRegion Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
|
|
148
|
+
*/
|
|
149
|
+
selectedCloudRegion(selectedCloudRegion: CloudRegion): this;
|
|
150
|
+
/**
|
|
151
|
+
*
|
|
152
|
+
* @param encoderVersion Filter encodings to only show the ones with the encoderVersion specified.
|
|
153
|
+
*/
|
|
154
|
+
encoderVersion(encoderVersion: string): this;
|
|
155
|
+
/**
|
|
156
|
+
*
|
|
157
|
+
* @param selectedEncoderVersion Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
|
|
158
|
+
*/
|
|
159
|
+
selectedEncoderVersion(selectedEncoderVersion: string): this;
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @param selectedEncodingMode Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
|
|
163
|
+
*/
|
|
164
|
+
selectedEncodingMode(selectedEncodingMode: EncodingMode): this;
|
|
165
|
+
/**
|
|
166
|
+
*
|
|
167
|
+
* @param name Filter encodings to only show the ones with this exact name.
|
|
168
|
+
*/
|
|
169
|
+
name(name: string): this;
|
|
170
|
+
/**
|
|
171
|
+
*
|
|
172
|
+
* @param search The search query string for advanced filtering. We are using the [Apache Lucene](https://lucene.apache.org/) query syntax here. Only lucene queries equivalent to exact matching and startsWith are supported. Also only AND conjunctions supported at the moment. Please be aware that our filters are **case-insensitive** Examples of supported lucene queries: + `name:MyEncoding1` - This searches for encodings with names that are equal to `myencoding1` + `name:\"My Encoding\"` - This searches for encodings with names that are equal to `my encoding` + `name:MyEncoding\\*` - This searches for encodings with names that are equal to `myencoding*` Please have a look at the [Lucene Documentation - Escaping Special Characters](https://lucene.apache.org/core/8_1_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters) section to see what characters have to be escaped. + `name:test*` - This searches for encodings with names that start with `test` + `name:test* AND labels:Customer1` - This searches for encodings with names starting with `test` and labels containing an entry that is equal to `customer1` Available search fields: + `name` + `labels` Please be aware to send these queries url encoded. If you provide fields or lucene queries that are not supported, it will result in an error response.
|
|
173
|
+
*/
|
|
174
|
+
search(search: string): this;
|
|
175
|
+
/**
|
|
176
|
+
*
|
|
177
|
+
* @param createdAtNewerThan Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
178
|
+
*/
|
|
179
|
+
createdAtNewerThan(createdAtNewerThan: Date): this;
|
|
180
|
+
/**
|
|
181
|
+
*
|
|
182
|
+
* @param createdAtOlderThan Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
183
|
+
*/
|
|
184
|
+
createdAtOlderThan(createdAtOlderThan: Date): this;
|
|
185
|
+
/**
|
|
186
|
+
*
|
|
187
|
+
* @param startedAtNewerThan Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
188
|
+
*/
|
|
189
|
+
startedAtNewerThan(startedAtNewerThan: Date): this;
|
|
190
|
+
/**
|
|
191
|
+
*
|
|
192
|
+
* @param startedAtOlderThan Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
193
|
+
*/
|
|
194
|
+
startedAtOlderThan(startedAtOlderThan: Date): this;
|
|
195
|
+
/**
|
|
196
|
+
*
|
|
197
|
+
* @param finishedAtNewerThan Filter encodings to only return those finished at newer than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
|
|
198
|
+
*/
|
|
199
|
+
finishedAtNewerThan(finishedAtNewerThan: Date): this;
|
|
200
|
+
/**
|
|
201
|
+
*
|
|
202
|
+
* @param finishedAtOlderThan Filter encodings to only return those finished at older than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
|
|
203
|
+
*/
|
|
204
|
+
finishedAtOlderThan(finishedAtOlderThan: Date): this;
|
|
205
|
+
buildQueryParams(): EncodingListQueryParams;
|
|
206
|
+
}
|
|
@@ -0,0 +1,157 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.EncodingListQueryParamsBuilder = void 0;
|
|
4
|
+
var EncodingListQueryParamsBuilder = /** @class */ (function () {
|
|
5
|
+
function EncodingListQueryParamsBuilder() {
|
|
6
|
+
this.internalParams = {};
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
*
|
|
10
|
+
* @param offset Index of the first item to return, starting at 0. Default is 0
|
|
11
|
+
*/
|
|
12
|
+
EncodingListQueryParamsBuilder.prototype.offset = function (offset) {
|
|
13
|
+
this.internalParams.offset = offset;
|
|
14
|
+
return this;
|
|
15
|
+
};
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @param limit Maximum number of items to return. Default is 25, maximum is 100
|
|
19
|
+
*/
|
|
20
|
+
EncodingListQueryParamsBuilder.prototype.limit = function (limit) {
|
|
21
|
+
this.internalParams.limit = limit;
|
|
22
|
+
return this;
|
|
23
|
+
};
|
|
24
|
+
/**
|
|
25
|
+
*
|
|
26
|
+
* @param sort Order list result according an encoding resource attribute. The fields that can be used for sorting are: + `id` + `startedAt` + `createdAt` + `modifiedAt` + `finishedAt` + `type` + `name` + `status` + `cloudRegion` + `encoderVersion`
|
|
27
|
+
*/
|
|
28
|
+
EncodingListQueryParamsBuilder.prototype.sort = function (sort) {
|
|
29
|
+
this.internalParams.sort = sort;
|
|
30
|
+
return this;
|
|
31
|
+
};
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @param type Filter encodings to only show the ones with the type specified.
|
|
35
|
+
*/
|
|
36
|
+
EncodingListQueryParamsBuilder.prototype.type = function (type) {
|
|
37
|
+
this.internalParams.type = type;
|
|
38
|
+
return this;
|
|
39
|
+
};
|
|
40
|
+
/**
|
|
41
|
+
*
|
|
42
|
+
* @param status Filter encodings to only show the ones with the status specified.
|
|
43
|
+
*/
|
|
44
|
+
EncodingListQueryParamsBuilder.prototype.status = function (status) {
|
|
45
|
+
this.internalParams.status = status;
|
|
46
|
+
return this;
|
|
47
|
+
};
|
|
48
|
+
/**
|
|
49
|
+
*
|
|
50
|
+
* @param cloudRegion Filter encodings to only show the ones with the cloudRegion specified.
|
|
51
|
+
*/
|
|
52
|
+
EncodingListQueryParamsBuilder.prototype.cloudRegion = function (cloudRegion) {
|
|
53
|
+
this.internalParams.cloudRegion = cloudRegion;
|
|
54
|
+
return this;
|
|
55
|
+
};
|
|
56
|
+
/**
|
|
57
|
+
*
|
|
58
|
+
* @param selectedCloudRegion Filter encodings to only show the ones with the selectedCloudRegion specified which was selected when cloudregion:AUTO was set
|
|
59
|
+
*/
|
|
60
|
+
EncodingListQueryParamsBuilder.prototype.selectedCloudRegion = function (selectedCloudRegion) {
|
|
61
|
+
this.internalParams.selectedCloudRegion = selectedCloudRegion;
|
|
62
|
+
return this;
|
|
63
|
+
};
|
|
64
|
+
/**
|
|
65
|
+
*
|
|
66
|
+
* @param encoderVersion Filter encodings to only show the ones with the encoderVersion specified.
|
|
67
|
+
*/
|
|
68
|
+
EncodingListQueryParamsBuilder.prototype.encoderVersion = function (encoderVersion) {
|
|
69
|
+
this.internalParams.encoderVersion = encoderVersion;
|
|
70
|
+
return this;
|
|
71
|
+
};
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @param selectedEncoderVersion Filter encodings to only show the ones with the encoderVersion specified that was actually used for the encoding.
|
|
75
|
+
*/
|
|
76
|
+
EncodingListQueryParamsBuilder.prototype.selectedEncoderVersion = function (selectedEncoderVersion) {
|
|
77
|
+
this.internalParams.selectedEncoderVersion = selectedEncoderVersion;
|
|
78
|
+
return this;
|
|
79
|
+
};
|
|
80
|
+
/**
|
|
81
|
+
*
|
|
82
|
+
* @param selectedEncodingMode Filter encodings to only show the ones with the encodingMode specified that was actually used for the encoding.
|
|
83
|
+
*/
|
|
84
|
+
EncodingListQueryParamsBuilder.prototype.selectedEncodingMode = function (selectedEncodingMode) {
|
|
85
|
+
this.internalParams.selectedEncodingMode = selectedEncodingMode;
|
|
86
|
+
return this;
|
|
87
|
+
};
|
|
88
|
+
/**
|
|
89
|
+
*
|
|
90
|
+
* @param name Filter encodings to only show the ones with this exact name.
|
|
91
|
+
*/
|
|
92
|
+
EncodingListQueryParamsBuilder.prototype.name = function (name) {
|
|
93
|
+
this.internalParams.name = name;
|
|
94
|
+
return this;
|
|
95
|
+
};
|
|
96
|
+
/**
|
|
97
|
+
*
|
|
98
|
+
* @param search The search query string for advanced filtering. We are using the [Apache Lucene](https://lucene.apache.org/) query syntax here. Only lucene queries equivalent to exact matching and startsWith are supported. Also only AND conjunctions supported at the moment. Please be aware that our filters are **case-insensitive** Examples of supported lucene queries: + `name:MyEncoding1` - This searches for encodings with names that are equal to `myencoding1` + `name:\"My Encoding\"` - This searches for encodings with names that are equal to `my encoding` + `name:MyEncoding\\*` - This searches for encodings with names that are equal to `myencoding*` Please have a look at the [Lucene Documentation - Escaping Special Characters](https://lucene.apache.org/core/8_1_1/queryparser/org/apache/lucene/queryparser/classic/package-summary.html#Escaping_Special_Characters) section to see what characters have to be escaped. + `name:test*` - This searches for encodings with names that start with `test` + `name:test* AND labels:Customer1` - This searches for encodings with names starting with `test` and labels containing an entry that is equal to `customer1` Available search fields: + `name` + `labels` Please be aware to send these queries url encoded. If you provide fields or lucene queries that are not supported, it will result in an error response.
|
|
99
|
+
*/
|
|
100
|
+
EncodingListQueryParamsBuilder.prototype.search = function (search) {
|
|
101
|
+
this.internalParams.search = search;
|
|
102
|
+
return this;
|
|
103
|
+
};
|
|
104
|
+
/**
|
|
105
|
+
*
|
|
106
|
+
* @param createdAtNewerThan Filter encodings to only return those created after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
107
|
+
*/
|
|
108
|
+
EncodingListQueryParamsBuilder.prototype.createdAtNewerThan = function (createdAtNewerThan) {
|
|
109
|
+
this.internalParams.createdAtNewerThan = createdAtNewerThan;
|
|
110
|
+
return this;
|
|
111
|
+
};
|
|
112
|
+
/**
|
|
113
|
+
*
|
|
114
|
+
* @param createdAtOlderThan Filter encodings to only return those created before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
115
|
+
*/
|
|
116
|
+
EncodingListQueryParamsBuilder.prototype.createdAtOlderThan = function (createdAtOlderThan) {
|
|
117
|
+
this.internalParams.createdAtOlderThan = createdAtOlderThan;
|
|
118
|
+
return this;
|
|
119
|
+
};
|
|
120
|
+
/**
|
|
121
|
+
*
|
|
122
|
+
* @param startedAtNewerThan Filter encodings to only return those started after this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
123
|
+
*/
|
|
124
|
+
EncodingListQueryParamsBuilder.prototype.startedAtNewerThan = function (startedAtNewerThan) {
|
|
125
|
+
this.internalParams.startedAtNewerThan = startedAtNewerThan;
|
|
126
|
+
return this;
|
|
127
|
+
};
|
|
128
|
+
/**
|
|
129
|
+
*
|
|
130
|
+
* @param startedAtOlderThan Filter encodings to only return those started before this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
|
|
131
|
+
*/
|
|
132
|
+
EncodingListQueryParamsBuilder.prototype.startedAtOlderThan = function (startedAtOlderThan) {
|
|
133
|
+
this.internalParams.startedAtOlderThan = startedAtOlderThan;
|
|
134
|
+
return this;
|
|
135
|
+
};
|
|
136
|
+
/**
|
|
137
|
+
*
|
|
138
|
+
* @param finishedAtNewerThan Filter encodings to only return those finished at newer than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
|
|
139
|
+
*/
|
|
140
|
+
EncodingListQueryParamsBuilder.prototype.finishedAtNewerThan = function (finishedAtNewerThan) {
|
|
141
|
+
this.internalParams.finishedAtNewerThan = finishedAtNewerThan;
|
|
142
|
+
return this;
|
|
143
|
+
};
|
|
144
|
+
/**
|
|
145
|
+
*
|
|
146
|
+
* @param finishedAtOlderThan Filter encodings to only return those finished at older than this exact time, provided in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ Available for all encodings started after REST API Service release v1.50.0 (Changelogs for more information https://bitmovin.com/docs/encoding/changelogs/rest)
|
|
147
|
+
*/
|
|
148
|
+
EncodingListQueryParamsBuilder.prototype.finishedAtOlderThan = function (finishedAtOlderThan) {
|
|
149
|
+
this.internalParams.finishedAtOlderThan = finishedAtOlderThan;
|
|
150
|
+
return this;
|
|
151
|
+
};
|
|
152
|
+
EncodingListQueryParamsBuilder.prototype.buildQueryParams = function () {
|
|
153
|
+
return this.internalParams;
|
|
154
|
+
};
|
|
155
|
+
return EncodingListQueryParamsBuilder;
|
|
156
|
+
}());
|
|
157
|
+
exports.EncodingListQueryParamsBuilder = EncodingListQueryParamsBuilder;
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { BaseAPI } from '../../../common/BaseAPI';
|
|
2
|
+
import Configuration from '../../../common/Configuration';
|
|
3
|
+
import Encoding from '../../../models/Encoding';
|
|
4
|
+
import HistoryEncoding from '../../../models/HistoryEncoding';
|
|
5
|
+
import PaginationResponse from '../../../models/PaginationResponse';
|
|
6
|
+
import { EncodingListQueryParams, EncodingListQueryParamsBuilder } from './EncodingListQueryParams';
|
|
7
|
+
/**
|
|
8
|
+
* EncodingsApi - object-oriented interface
|
|
9
|
+
* @export
|
|
10
|
+
* @class EncodingsApi
|
|
11
|
+
* @extends {BaseAPI}
|
|
12
|
+
*/
|
|
13
|
+
export default class EncodingsApi extends BaseAPI {
|
|
14
|
+
constructor(configuration: Configuration);
|
|
15
|
+
/**
|
|
16
|
+
* @summary (Experimental) History Encoding Details
|
|
17
|
+
* @param {string} encodingId Id of the encoding.
|
|
18
|
+
* @throws {BitmovinError}
|
|
19
|
+
* @memberof EncodingsApi
|
|
20
|
+
*/
|
|
21
|
+
get(encodingId: string): Promise<HistoryEncoding>;
|
|
22
|
+
/**
|
|
23
|
+
* @summary (Experimental) List all History Encodings
|
|
24
|
+
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
|
|
25
|
+
* @throws {BitmovinError}
|
|
26
|
+
* @memberof EncodingsApi
|
|
27
|
+
*/
|
|
28
|
+
list(queryParameters?: EncodingListQueryParams | ((q: EncodingListQueryParamsBuilder) => EncodingListQueryParamsBuilder)): Promise<PaginationResponse<Encoding>>;
|
|
29
|
+
}
|
|
@@ -0,0 +1,69 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
var __extends = (this && this.__extends) || (function () {
|
|
3
|
+
var extendStatics = function (d, b) {
|
|
4
|
+
extendStatics = Object.setPrototypeOf ||
|
|
5
|
+
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
|
|
6
|
+
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
|
|
7
|
+
return extendStatics(d, b);
|
|
8
|
+
};
|
|
9
|
+
return function (d, b) {
|
|
10
|
+
if (typeof b !== "function" && b !== null)
|
|
11
|
+
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
|
|
12
|
+
extendStatics(d, b);
|
|
13
|
+
function __() { this.constructor = d; }
|
|
14
|
+
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
|
|
15
|
+
};
|
|
16
|
+
})();
|
|
17
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
18
|
+
var BaseAPI_1 = require("../../../common/BaseAPI");
|
|
19
|
+
var Mapper_1 = require("../../../common/Mapper");
|
|
20
|
+
var Encoding_1 = require("../../../models/Encoding");
|
|
21
|
+
var HistoryEncoding_1 = require("../../../models/HistoryEncoding");
|
|
22
|
+
var PaginationResponse_1 = require("../../../models/PaginationResponse");
|
|
23
|
+
var EncodingListQueryParams_1 = require("./EncodingListQueryParams");
|
|
24
|
+
/**
|
|
25
|
+
* EncodingsApi - object-oriented interface
|
|
26
|
+
* @export
|
|
27
|
+
* @class EncodingsApi
|
|
28
|
+
* @extends {BaseAPI}
|
|
29
|
+
*/
|
|
30
|
+
var EncodingsApi = /** @class */ (function (_super) {
|
|
31
|
+
__extends(EncodingsApi, _super);
|
|
32
|
+
function EncodingsApi(configuration) {
|
|
33
|
+
return _super.call(this, configuration) || this;
|
|
34
|
+
}
|
|
35
|
+
/**
|
|
36
|
+
* @summary (Experimental) History Encoding Details
|
|
37
|
+
* @param {string} encodingId Id of the encoding.
|
|
38
|
+
* @throws {BitmovinError}
|
|
39
|
+
* @memberof EncodingsApi
|
|
40
|
+
*/
|
|
41
|
+
EncodingsApi.prototype.get = function (encodingId) {
|
|
42
|
+
var pathParamMap = {
|
|
43
|
+
encoding_id: encodingId
|
|
44
|
+
};
|
|
45
|
+
return this.restClient.get('/encoding/history/encodings/{encoding_id}', pathParamMap).then(function (response) {
|
|
46
|
+
return (0, Mapper_1.map)(response, HistoryEncoding_1.default);
|
|
47
|
+
});
|
|
48
|
+
};
|
|
49
|
+
/**
|
|
50
|
+
* @summary (Experimental) List all History Encodings
|
|
51
|
+
* @param {*} [queryParameters] query parameters for filtering, sorting and pagination
|
|
52
|
+
* @throws {BitmovinError}
|
|
53
|
+
* @memberof EncodingsApi
|
|
54
|
+
*/
|
|
55
|
+
EncodingsApi.prototype.list = function (queryParameters) {
|
|
56
|
+
var queryParams = {};
|
|
57
|
+
if (typeof queryParameters === 'function') {
|
|
58
|
+
queryParams = queryParameters(new EncodingListQueryParams_1.EncodingListQueryParamsBuilder()).buildQueryParams();
|
|
59
|
+
}
|
|
60
|
+
else if (queryParameters) {
|
|
61
|
+
queryParams = queryParameters;
|
|
62
|
+
}
|
|
63
|
+
return this.restClient.get('/encoding/history/encodings', {}, queryParams).then(function (response) {
|
|
64
|
+
return new PaginationResponse_1.default(response, Encoding_1.default);
|
|
65
|
+
});
|
|
66
|
+
};
|
|
67
|
+
return EncodingsApi;
|
|
68
|
+
}(BaseAPI_1.BaseAPI));
|
|
69
|
+
exports.default = EncodingsApi;
|
|
@@ -20,7 +20,7 @@ export declare class Av1VideoConfiguration extends VideoConfiguration {
|
|
|
20
20
|
*/
|
|
21
21
|
presetConfiguration?: Av1PresetConfiguration;
|
|
22
22
|
/**
|
|
23
|
-
* Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate.
|
|
23
|
+
* Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.
|
|
24
24
|
* @type {AutoLevelSetup}
|
|
25
25
|
* @memberof Av1VideoConfiguration
|
|
26
26
|
*/
|
|
@@ -296,7 +296,7 @@ export declare class H264VideoConfiguration extends VideoConfiguration {
|
|
|
296
296
|
*/
|
|
297
297
|
psyTrellis?: number;
|
|
298
298
|
/**
|
|
299
|
-
* Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate.
|
|
299
|
+
* Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.
|
|
300
300
|
* @type {AutoLevelSetup}
|
|
301
301
|
* @memberof H264VideoConfiguration
|
|
302
302
|
*/
|
|
@@ -604,7 +604,7 @@ export declare class H265VideoConfiguration extends VideoConfiguration {
|
|
|
604
604
|
*/
|
|
605
605
|
cea608708SubtitleConfig?: Cea608708SubtitleConfiguration;
|
|
606
606
|
/**
|
|
607
|
-
* Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate.
|
|
607
|
+
* Enable/disable automatic calculation of level, maxBitrate, and bufsize based on the least level that satisfies maximum property values for picture resolution, frame rate, and bit rate. In the case the target level is set explicitly, the maximum bitrate and buffer size are calculated based on the defined level. Explicitly setting maxBitrate, or bufsize properties will disable the automatic calculation.
|
|
608
608
|
* @type {AutoLevelSetup}
|
|
609
609
|
* @memberof H265VideoConfiguration
|
|
610
610
|
*/
|