@bitmovin/api-sdk 1.206.0 → 1.208.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.
Files changed (37) hide show
  1. package/README.md +1 -1
  2. package/dist/bitmovin-api-sdk.browser.js +408 -8
  3. package/dist/bitmovin-api-sdk.browser.min.js +1 -1
  4. package/dist/common/RestClient.js +1 -1
  5. package/dist/encoding/EncodingApi.d.ts +2 -0
  6. package/dist/encoding/EncodingApi.js +2 -0
  7. package/dist/encoding/encodings/streams/captions/cea/CeaApi.d.ts +2 -0
  8. package/dist/encoding/encodings/streams/captions/cea/CeaApi.js +2 -0
  9. package/dist/encoding/encodings/streams/captions/cea/srt/SrtApi.d.ts +53 -0
  10. package/dist/encoding/encodings/streams/captions/cea/srt/SrtApi.js +117 -0
  11. package/dist/encoding/encodings/streams/captions/cea/srt/SrtToCea608708CaptionListQueryParams.d.ts +28 -0
  12. package/dist/encoding/encodings/streams/captions/cea/srt/SrtToCea608708CaptionListQueryParams.js +29 -0
  13. package/dist/encoding/encodings/streams/captions/cea/srt/customdata/CustomdataApi.d.ts +21 -0
  14. package/dist/encoding/encodings/streams/captions/cea/srt/customdata/CustomdataApi.js +52 -0
  15. package/dist/encoding/templates/TemplatesApi.d.ts +19 -0
  16. package/dist/encoding/templates/TemplatesApi.js +45 -0
  17. package/dist/models/Av1PerTitleConfiguration.d.ts +0 -6
  18. package/dist/models/Av1PerTitleConfiguration.js +0 -2
  19. package/dist/models/DolbyVisionProfile.d.ts +0 -1
  20. package/dist/models/DolbyVisionProfile.js +0 -1
  21. package/dist/models/EncodingTemplateRequest.d.ts +9 -0
  22. package/dist/models/EncodingTemplateRequest.js +18 -0
  23. package/dist/models/EncodingTemplateStartResponse.d.ts +14 -0
  24. package/dist/models/EncodingTemplateStartResponse.js +19 -0
  25. package/dist/models/H264PerTitleConfiguration.d.ts +0 -6
  26. package/dist/models/H264PerTitleConfiguration.js +0 -1
  27. package/dist/models/H265PerTitleConfiguration.d.ts +0 -6
  28. package/dist/models/H265PerTitleConfiguration.js +0 -1
  29. package/dist/models/PerTitleConfiguration.d.ts +12 -0
  30. package/dist/models/PerTitleConfiguration.js +2 -0
  31. package/dist/models/SrtToCea608708Caption.d.ts +30 -0
  32. package/dist/models/SrtToCea608708Caption.js +41 -0
  33. package/dist/models/Vp9PerTitleConfiguration.d.ts +0 -6
  34. package/dist/models/Vp9PerTitleConfiguration.js +0 -2
  35. package/dist/models/index.d.ts +3 -0
  36. package/dist/models/index.js +3 -0
  37. 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.206.0',
243
+ 'X-Api-Client-Version': '1.208.0',
244
244
  'Content-Type': 'application/json'
245
245
  };
246
246
  if (tenantOrgId) {
@@ -12,6 +12,7 @@ import StatisticsApi from './statistics/StatisticsApi';
12
12
  import WatchFoldersApi from './watchFolders/WatchFoldersApi';
13
13
  import SimpleApi from './simple/SimpleApi';
14
14
  import ErrorDefinitionsApi from './errorDefinitions/ErrorDefinitionsApi';
15
+ import TemplatesApi from './templates/TemplatesApi';
15
16
  /**
16
17
  * EncodingApi - object-oriented interface
17
18
  * @export
@@ -31,5 +32,6 @@ export default class EncodingApi extends BaseAPI {
31
32
  watchFolders: WatchFoldersApi;
32
33
  simple: SimpleApi;
33
34
  errorDefinitions: ErrorDefinitionsApi;
35
+ templates: TemplatesApi;
34
36
  constructor(configuration: Configuration);
35
37
  }
@@ -28,6 +28,7 @@ var StatisticsApi_1 = require("./statistics/StatisticsApi");
28
28
  var WatchFoldersApi_1 = require("./watchFolders/WatchFoldersApi");
29
29
  var SimpleApi_1 = require("./simple/SimpleApi");
30
30
  var ErrorDefinitionsApi_1 = require("./errorDefinitions/ErrorDefinitionsApi");
31
+ var TemplatesApi_1 = require("./templates/TemplatesApi");
31
32
  /**
32
33
  * EncodingApi - object-oriented interface
33
34
  * @export
@@ -50,6 +51,7 @@ var EncodingApi = /** @class */ (function (_super) {
50
51
  _this.watchFolders = new WatchFoldersApi_1.default(configuration);
51
52
  _this.simple = new SimpleApi_1.default(configuration);
52
53
  _this.errorDefinitions = new ErrorDefinitionsApi_1.default(configuration);
54
+ _this.templates = new TemplatesApi_1.default(configuration);
53
55
  return _this;
54
56
  }
55
57
  return EncodingApi;
@@ -1,6 +1,7 @@
1
1
  import { BaseAPI } from '../../../../../common/BaseAPI';
2
2
  import Configuration from '../../../../../common/Configuration';
3
3
  import SccApi from './scc/SccApi';
4
+ import SrtApi from './srt/SrtApi';
4
5
  /**
5
6
  * CeaApi - object-oriented interface
6
7
  * @export
@@ -9,5 +10,6 @@ import SccApi from './scc/SccApi';
9
10
  */
10
11
  export default class CeaApi extends BaseAPI {
11
12
  scc: SccApi;
13
+ srt: SrtApi;
12
14
  constructor(configuration: Configuration);
13
15
  }
@@ -17,6 +17,7 @@ var __extends = (this && this.__extends) || (function () {
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  var BaseAPI_1 = require("../../../../../common/BaseAPI");
19
19
  var SccApi_1 = require("./scc/SccApi");
20
+ var SrtApi_1 = require("./srt/SrtApi");
20
21
  /**
21
22
  * CeaApi - object-oriented interface
22
23
  * @export
@@ -28,6 +29,7 @@ var CeaApi = /** @class */ (function (_super) {
28
29
  function CeaApi(configuration) {
29
30
  var _this = _super.call(this, configuration) || this;
30
31
  _this.scc = new SccApi_1.default(configuration);
32
+ _this.srt = new SrtApi_1.default(configuration);
31
33
  return _this;
32
34
  }
33
35
  return CeaApi;
@@ -0,0 +1,53 @@
1
+ import { BaseAPI } from '../../../../../../common/BaseAPI';
2
+ import Configuration from '../../../../../../common/Configuration';
3
+ import CustomdataApi from './customdata/CustomdataApi';
4
+ import BitmovinResponse from '../../../../../../models/BitmovinResponse';
5
+ import SrtToCea608708Caption from '../../../../../../models/SrtToCea608708Caption';
6
+ import PaginationResponse from '../../../../../../models/PaginationResponse';
7
+ import { SrtToCea608708CaptionListQueryParams, SrtToCea608708CaptionListQueryParamsBuilder } from './SrtToCea608708CaptionListQueryParams';
8
+ /**
9
+ * SrtApi - object-oriented interface
10
+ * @export
11
+ * @class SrtApi
12
+ * @extends {BaseAPI}
13
+ */
14
+ export default class SrtApi extends BaseAPI {
15
+ customdata: CustomdataApi;
16
+ constructor(configuration: Configuration);
17
+ /**
18
+ * @summary Embed SRT captions as 608/708 into Stream
19
+ * @param {string} encodingId Id of the encoding.
20
+ * @param {string} streamId Id of the stream.
21
+ * @param {SrtToCea608708Caption} srtToCea608708Caption The SRT captions to be embedded as 607/708 into Stream
22
+ * @throws {BitmovinError}
23
+ * @memberof SrtApi
24
+ */
25
+ create(encodingId: string, streamId: string, srtToCea608708Caption?: SrtToCea608708Caption): Promise<SrtToCea608708Caption>;
26
+ /**
27
+ * @summary Delete SRT captions as 608/708 from Stream
28
+ * @param {string} encodingId Id of the encoding.
29
+ * @param {string} streamId Id of the stream.
30
+ * @param {string} captionsId Id of the caption.
31
+ * @throws {BitmovinError}
32
+ * @memberof SrtApi
33
+ */
34
+ delete(encodingId: string, streamId: string, captionsId: string): Promise<BitmovinResponse>;
35
+ /**
36
+ * @summary Embed SRT captions as 608/708 Details
37
+ * @param {string} encodingId Id of the encoding.
38
+ * @param {string} streamId Id of the stream.
39
+ * @param {string} captionsId Id of the caption.
40
+ * @throws {BitmovinError}
41
+ * @memberof SrtApi
42
+ */
43
+ get(encodingId: string, streamId: string, captionsId: string): Promise<SrtToCea608708Caption>;
44
+ /**
45
+ * @summary List SRT captions as 608/708 from Stream
46
+ * @param {string} encodingId Id of the encoding.
47
+ * @param {string} streamId Id of the stream.
48
+ * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
49
+ * @throws {BitmovinError}
50
+ * @memberof SrtApi
51
+ */
52
+ list(encodingId: string, streamId: string, queryParameters?: SrtToCea608708CaptionListQueryParams | ((q: SrtToCea608708CaptionListQueryParamsBuilder) => SrtToCea608708CaptionListQueryParamsBuilder)): Promise<PaginationResponse<SrtToCea608708Caption>>;
53
+ }
@@ -0,0 +1,117 @@
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 CustomdataApi_1 = require("./customdata/CustomdataApi");
21
+ var BitmovinResponse_1 = require("../../../../../../models/BitmovinResponse");
22
+ var SrtToCea608708Caption_1 = require("../../../../../../models/SrtToCea608708Caption");
23
+ var PaginationResponse_1 = require("../../../../../../models/PaginationResponse");
24
+ var SrtToCea608708CaptionListQueryParams_1 = require("./SrtToCea608708CaptionListQueryParams");
25
+ /**
26
+ * SrtApi - object-oriented interface
27
+ * @export
28
+ * @class SrtApi
29
+ * @extends {BaseAPI}
30
+ */
31
+ var SrtApi = /** @class */ (function (_super) {
32
+ __extends(SrtApi, _super);
33
+ function SrtApi(configuration) {
34
+ var _this = _super.call(this, configuration) || this;
35
+ _this.customdata = new CustomdataApi_1.default(configuration);
36
+ return _this;
37
+ }
38
+ /**
39
+ * @summary Embed SRT captions as 608/708 into Stream
40
+ * @param {string} encodingId Id of the encoding.
41
+ * @param {string} streamId Id of the stream.
42
+ * @param {SrtToCea608708Caption} srtToCea608708Caption The SRT captions to be embedded as 607/708 into Stream
43
+ * @throws {BitmovinError}
44
+ * @memberof SrtApi
45
+ */
46
+ SrtApi.prototype.create = function (encodingId, streamId, srtToCea608708Caption) {
47
+ var pathParamMap = {
48
+ encoding_id: encodingId,
49
+ stream_id: streamId
50
+ };
51
+ return this.restClient.post('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/srt', pathParamMap, srtToCea608708Caption).then(function (response) {
52
+ return (0, Mapper_1.map)(response, SrtToCea608708Caption_1.default);
53
+ });
54
+ };
55
+ /**
56
+ * @summary Delete SRT captions as 608/708 from Stream
57
+ * @param {string} encodingId Id of the encoding.
58
+ * @param {string} streamId Id of the stream.
59
+ * @param {string} captionsId Id of the caption.
60
+ * @throws {BitmovinError}
61
+ * @memberof SrtApi
62
+ */
63
+ SrtApi.prototype.delete = function (encodingId, streamId, captionsId) {
64
+ var pathParamMap = {
65
+ encoding_id: encodingId,
66
+ stream_id: streamId,
67
+ captions_id: captionsId
68
+ };
69
+ return this.restClient.delete('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/srt/{captions_id}', pathParamMap).then(function (response) {
70
+ return (0, Mapper_1.map)(response, BitmovinResponse_1.default);
71
+ });
72
+ };
73
+ /**
74
+ * @summary Embed SRT captions as 608/708 Details
75
+ * @param {string} encodingId Id of the encoding.
76
+ * @param {string} streamId Id of the stream.
77
+ * @param {string} captionsId Id of the caption.
78
+ * @throws {BitmovinError}
79
+ * @memberof SrtApi
80
+ */
81
+ SrtApi.prototype.get = function (encodingId, streamId, captionsId) {
82
+ var pathParamMap = {
83
+ encoding_id: encodingId,
84
+ stream_id: streamId,
85
+ captions_id: captionsId
86
+ };
87
+ return this.restClient.get('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/srt/{captions_id}', pathParamMap).then(function (response) {
88
+ return (0, Mapper_1.map)(response, SrtToCea608708Caption_1.default);
89
+ });
90
+ };
91
+ /**
92
+ * @summary List SRT captions as 608/708 from Stream
93
+ * @param {string} encodingId Id of the encoding.
94
+ * @param {string} streamId Id of the stream.
95
+ * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
96
+ * @throws {BitmovinError}
97
+ * @memberof SrtApi
98
+ */
99
+ SrtApi.prototype.list = function (encodingId, streamId, queryParameters) {
100
+ var pathParamMap = {
101
+ encoding_id: encodingId,
102
+ stream_id: streamId
103
+ };
104
+ var queryParams = {};
105
+ if (typeof queryParameters === 'function') {
106
+ queryParams = queryParameters(new SrtToCea608708CaptionListQueryParams_1.SrtToCea608708CaptionListQueryParamsBuilder()).buildQueryParams();
107
+ }
108
+ else if (queryParameters) {
109
+ queryParams = queryParameters;
110
+ }
111
+ return this.restClient.get('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/srt', pathParamMap, queryParams).then(function (response) {
112
+ return new PaginationResponse_1.default(response, SrtToCea608708Caption_1.default);
113
+ });
114
+ };
115
+ return SrtApi;
116
+ }(BaseAPI_1.BaseAPI));
117
+ exports.default = SrtApi;
@@ -0,0 +1,28 @@
1
+ export interface SrtToCea608708CaptionListQueryParams {
2
+ /**
3
+ * Index of the first item to return, starting at 0. Default is 0
4
+ * @type {number}
5
+ * @memberof SrtToCea608708CaptionListQueryParams
6
+ */
7
+ offset?: number | undefined;
8
+ /**
9
+ * Maximum number of items to return. Default is 25, maximum is 100
10
+ * @type {number}
11
+ * @memberof SrtToCea608708CaptionListQueryParams
12
+ */
13
+ limit?: number | undefined;
14
+ }
15
+ export declare class SrtToCea608708CaptionListQueryParamsBuilder {
16
+ private internalParams;
17
+ /**
18
+ *
19
+ * @param offset Index of the first item to return, starting at 0. Default is 0
20
+ */
21
+ offset(offset: number): this;
22
+ /**
23
+ *
24
+ * @param limit Maximum number of items to return. Default is 25, maximum is 100
25
+ */
26
+ limit(limit: number): this;
27
+ buildQueryParams(): SrtToCea608708CaptionListQueryParams;
28
+ }
@@ -0,0 +1,29 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SrtToCea608708CaptionListQueryParamsBuilder = void 0;
4
+ var SrtToCea608708CaptionListQueryParamsBuilder = /** @class */ (function () {
5
+ function SrtToCea608708CaptionListQueryParamsBuilder() {
6
+ this.internalParams = {};
7
+ }
8
+ /**
9
+ *
10
+ * @param offset Index of the first item to return, starting at 0. Default is 0
11
+ */
12
+ SrtToCea608708CaptionListQueryParamsBuilder.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
+ SrtToCea608708CaptionListQueryParamsBuilder.prototype.limit = function (limit) {
21
+ this.internalParams.limit = limit;
22
+ return this;
23
+ };
24
+ SrtToCea608708CaptionListQueryParamsBuilder.prototype.buildQueryParams = function () {
25
+ return this.internalParams;
26
+ };
27
+ return SrtToCea608708CaptionListQueryParamsBuilder;
28
+ }());
29
+ exports.SrtToCea608708CaptionListQueryParamsBuilder = SrtToCea608708CaptionListQueryParamsBuilder;
@@ -0,0 +1,21 @@
1
+ import { BaseAPI } from '../../../../../../../common/BaseAPI';
2
+ import Configuration from '../../../../../../../common/Configuration';
3
+ import CustomData from '../../../../../../../models/CustomData';
4
+ /**
5
+ * CustomdataApi - object-oriented interface
6
+ * @export
7
+ * @class CustomdataApi
8
+ * @extends {BaseAPI}
9
+ */
10
+ export default class CustomdataApi extends BaseAPI {
11
+ constructor(configuration: Configuration);
12
+ /**
13
+ * @summary Embed SRT captions as 608/708 Custom Data
14
+ * @param {string} encodingId Id of the encoding.
15
+ * @param {string} streamId Id of the stream.
16
+ * @param {string} captionsId Id of the caption.
17
+ * @throws {BitmovinError}
18
+ * @memberof CustomdataApi
19
+ */
20
+ get(encodingId: string, streamId: string, captionsId: string): Promise<CustomData>;
21
+ }
@@ -0,0 +1,52 @@
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 CustomData_1 = require("../../../../../../../models/CustomData");
21
+ /**
22
+ * CustomdataApi - object-oriented interface
23
+ * @export
24
+ * @class CustomdataApi
25
+ * @extends {BaseAPI}
26
+ */
27
+ var CustomdataApi = /** @class */ (function (_super) {
28
+ __extends(CustomdataApi, _super);
29
+ function CustomdataApi(configuration) {
30
+ return _super.call(this, configuration) || this;
31
+ }
32
+ /**
33
+ * @summary Embed SRT captions as 608/708 Custom Data
34
+ * @param {string} encodingId Id of the encoding.
35
+ * @param {string} streamId Id of the stream.
36
+ * @param {string} captionsId Id of the caption.
37
+ * @throws {BitmovinError}
38
+ * @memberof CustomdataApi
39
+ */
40
+ CustomdataApi.prototype.get = function (encodingId, streamId, captionsId) {
41
+ var pathParamMap = {
42
+ encoding_id: encodingId,
43
+ stream_id: streamId,
44
+ captions_id: captionsId
45
+ };
46
+ return this.restClient.get('/encoding/encodings/{encoding_id}/streams/{stream_id}/captions/608-708/srt/{captions_id}/customData', pathParamMap).then(function (response) {
47
+ return (0, Mapper_1.map)(response, CustomData_1.default);
48
+ });
49
+ };
50
+ return CustomdataApi;
51
+ }(BaseAPI_1.BaseAPI));
52
+ exports.default = CustomdataApi;
@@ -0,0 +1,19 @@
1
+ import { BaseAPI } from '../../common/BaseAPI';
2
+ import Configuration from '../../common/Configuration';
3
+ import EncodingTemplateStartResponse from '../../models/EncodingTemplateStartResponse';
4
+ /**
5
+ * TemplatesApi - object-oriented interface
6
+ * @export
7
+ * @class TemplatesApi
8
+ * @extends {BaseAPI}
9
+ */
10
+ export default class TemplatesApi extends BaseAPI {
11
+ constructor(configuration: Configuration);
12
+ /**
13
+ * @summary BETA: Start an Encoding defined with an Encoding Template
14
+ * @param {any} encodingTemplateRequest The Encoding Template to start an Encoding from
15
+ * @throws {BitmovinError}
16
+ * @memberof TemplatesApi
17
+ */
18
+ start(encodingTemplateRequest?: any): Promise<EncodingTemplateStartResponse>;
19
+ }
@@ -0,0 +1,45 @@
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 EncodingTemplateStartResponse_1 = require("../../models/EncodingTemplateStartResponse");
21
+ /**
22
+ * TemplatesApi - object-oriented interface
23
+ * @export
24
+ * @class TemplatesApi
25
+ * @extends {BaseAPI}
26
+ */
27
+ var TemplatesApi = /** @class */ (function (_super) {
28
+ __extends(TemplatesApi, _super);
29
+ function TemplatesApi(configuration) {
30
+ return _super.call(this, configuration) || this;
31
+ }
32
+ /**
33
+ * @summary BETA: Start an Encoding defined with an Encoding Template
34
+ * @param {any} encodingTemplateRequest The Encoding Template to start an Encoding from
35
+ * @throws {BitmovinError}
36
+ * @memberof TemplatesApi
37
+ */
38
+ TemplatesApi.prototype.start = function (encodingTemplateRequest) {
39
+ return this.restClient.post('/encoding/templates/start', {}, encodingTemplateRequest).then(function (response) {
40
+ return (0, Mapper_1.map)(response, EncodingTemplateStartResponse_1.default);
41
+ });
42
+ };
43
+ return TemplatesApi;
44
+ }(BaseAPI_1.BaseAPI));
45
+ exports.default = TemplatesApi;
@@ -4,12 +4,6 @@ import PerTitleConfiguration from './PerTitleConfiguration';
4
4
  * @class Av1PerTitleConfiguration
5
5
  */
6
6
  export declare class Av1PerTitleConfiguration extends PerTitleConfiguration {
7
- /**
8
- * Desired target quality of the highest representation expressed as CRF value
9
- * @type {number}
10
- * @memberof Av1PerTitleConfiguration
11
- */
12
- targetQualityCrf?: number;
13
7
  constructor(obj?: Partial<Av1PerTitleConfiguration>);
14
8
  }
15
9
  export default Av1PerTitleConfiguration;
@@ -16,7 +16,6 @@ var __extends = (this && this.__extends) || (function () {
16
16
  })();
17
17
  Object.defineProperty(exports, "__esModule", { value: true });
18
18
  exports.Av1PerTitleConfiguration = void 0;
19
- var Mapper_1 = require("../common/Mapper");
20
19
  var PerTitleConfiguration_1 = require("./PerTitleConfiguration");
21
20
  /**
22
21
  * @export
@@ -29,7 +28,6 @@ var Av1PerTitleConfiguration = /** @class */ (function (_super) {
29
28
  if (!obj) {
30
29
  return _this;
31
30
  }
32
- _this.targetQualityCrf = (0, Mapper_1.map)(obj.targetQualityCrf);
33
31
  return _this;
34
32
  }
35
33
  return Av1PerTitleConfiguration;
@@ -6,7 +6,6 @@ export declare enum DolbyVisionProfile {
6
6
  DVHE_04 = "DVHE_04",
7
7
  DVHE_05 = "DVHE_05",
8
8
  DVHE_07 = "DVHE_07",
9
- DVHE_08_1 = "DVHE_08_1",
10
9
  HEV1_08 = "HEV1_08",
11
10
  AVC3_09 = "AVC3_09"
12
11
  }
@@ -10,7 +10,6 @@ var DolbyVisionProfile;
10
10
  DolbyVisionProfile["DVHE_04"] = "DVHE_04";
11
11
  DolbyVisionProfile["DVHE_05"] = "DVHE_05";
12
12
  DolbyVisionProfile["DVHE_07"] = "DVHE_07";
13
- DolbyVisionProfile["DVHE_08_1"] = "DVHE_08_1";
14
13
  DolbyVisionProfile["HEV1_08"] = "HEV1_08";
15
14
  DolbyVisionProfile["AVC3_09"] = "AVC3_09";
16
15
  })(DolbyVisionProfile || (exports.DolbyVisionProfile = DolbyVisionProfile = {}));
@@ -0,0 +1,9 @@
1
+ /**
2
+ * The template request object can be either a string (YAML/JSON) or a generic object that includes all the fields. Please note that when sending the request as an object, the order of the fields is important, as it determines the sequence in which the Encoding resources are created.
3
+ * @export
4
+ * @class EncodingTemplateRequest
5
+ */
6
+ export declare class EncodingTemplateRequest {
7
+ constructor(obj?: Partial<EncodingTemplateRequest>);
8
+ }
9
+ export default EncodingTemplateRequest;
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EncodingTemplateRequest = void 0;
4
+ /**
5
+ * The template request object can be either a string (YAML/JSON) or a generic object that includes all the fields. Please note that when sending the request as an object, the order of the fields is important, as it determines the sequence in which the Encoding resources are created.
6
+ * @export
7
+ * @class EncodingTemplateRequest
8
+ */
9
+ var EncodingTemplateRequest = /** @class */ (function () {
10
+ function EncodingTemplateRequest(obj) {
11
+ if (!obj) {
12
+ return;
13
+ }
14
+ }
15
+ return EncodingTemplateRequest;
16
+ }());
17
+ exports.EncodingTemplateRequest = EncodingTemplateRequest;
18
+ exports.default = EncodingTemplateRequest;
@@ -0,0 +1,14 @@
1
+ /**
2
+ * @export
3
+ * @class EncodingTemplateStartResponse
4
+ */
5
+ export declare class EncodingTemplateStartResponse {
6
+ /**
7
+ * Id of the Encoding that is created (required)
8
+ * @type {string}
9
+ * @memberof EncodingTemplateStartResponse
10
+ */
11
+ encodingId?: string;
12
+ constructor(obj?: Partial<EncodingTemplateStartResponse>);
13
+ }
14
+ export default EncodingTemplateStartResponse;
@@ -0,0 +1,19 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.EncodingTemplateStartResponse = void 0;
4
+ var Mapper_1 = require("../common/Mapper");
5
+ /**
6
+ * @export
7
+ * @class EncodingTemplateStartResponse
8
+ */
9
+ var EncodingTemplateStartResponse = /** @class */ (function () {
10
+ function EncodingTemplateStartResponse(obj) {
11
+ if (!obj) {
12
+ return;
13
+ }
14
+ this.encodingId = (0, Mapper_1.map)(obj.encodingId);
15
+ }
16
+ return EncodingTemplateStartResponse;
17
+ }());
18
+ exports.EncodingTemplateStartResponse = EncodingTemplateStartResponse;
19
+ exports.default = EncodingTemplateStartResponse;
@@ -4,12 +4,6 @@ import PerTitleConfiguration from './PerTitleConfiguration';
4
4
  * @class H264PerTitleConfiguration
5
5
  */
6
6
  export declare class H264PerTitleConfiguration extends PerTitleConfiguration {
7
- /**
8
- * Desired target quality of the highest representation expressed as CRF value
9
- * @type {number}
10
- * @memberof H264PerTitleConfiguration
11
- */
12
- targetQualityCrf?: number;
13
7
  /**
14
8
  * This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate
15
9
  * @type {number}
@@ -29,7 +29,6 @@ var H264PerTitleConfiguration = /** @class */ (function (_super) {
29
29
  if (!obj) {
30
30
  return _this;
31
31
  }
32
- _this.targetQualityCrf = (0, Mapper_1.map)(obj.targetQualityCrf);
33
32
  _this.codecMinBitrateFactor = (0, Mapper_1.map)(obj.codecMinBitrateFactor);
34
33
  _this.codecMaxBitrateFactor = (0, Mapper_1.map)(obj.codecMaxBitrateFactor);
35
34
  _this.codecBufsizeFactor = (0, Mapper_1.map)(obj.codecBufsizeFactor);
@@ -4,12 +4,6 @@ import PerTitleConfiguration from './PerTitleConfiguration';
4
4
  * @class H265PerTitleConfiguration
5
5
  */
6
6
  export declare class H265PerTitleConfiguration extends PerTitleConfiguration {
7
- /**
8
- * Desired target quality of the highest representation expressed as CRF value
9
- * @type {number}
10
- * @memberof H265PerTitleConfiguration
11
- */
12
- targetQualityCrf?: number;
13
7
  /**
14
8
  * This factor is used to calculate the minBitrate of the codec configuration for the generated representations as a multiple of the targetBitrate
15
9
  * @type {number}
@@ -29,7 +29,6 @@ var H265PerTitleConfiguration = /** @class */ (function (_super) {
29
29
  if (!obj) {
30
30
  return _this;
31
31
  }
32
- _this.targetQualityCrf = (0, Mapper_1.map)(obj.targetQualityCrf);
33
32
  _this.codecMinBitrateFactor = (0, Mapper_1.map)(obj.codecMinBitrateFactor);
34
33
  _this.codecMaxBitrateFactor = (0, Mapper_1.map)(obj.codecMaxBitrateFactor);
35
34
  _this.codecBufsizeFactor = (0, Mapper_1.map)(obj.codecBufsizeFactor);
@@ -46,6 +46,18 @@ export declare class PerTitleConfiguration {
46
46
  * @memberof PerTitleConfiguration
47
47
  */
48
48
  fixedResolutionAndBitrateConfiguration?: PerTitleFixedResolutionAndBitrateConfiguration;
49
+ /**
50
+ * Desired target quality of the highest representation expressed as CRF value
51
+ * @type {number}
52
+ * @memberof PerTitleConfiguration
53
+ */
54
+ targetQualityCrf?: number;
55
+ /**
56
+ * This factor influences the resolution selection of the per-title algorithm. The default value is 0.0. negative values will lead to results where the algorithm will choose lower resolutions for given bitrates. A positive value will result in higher resolutions to be selected. The range of the factor is -5.0 to +5.0. Please note that changing this factor might also lead to slightly different bitrate selection by the algorithm.
57
+ * @type {number}
58
+ * @memberof PerTitleConfiguration
59
+ */
60
+ resolutionScaleFactor?: number;
49
61
  constructor(obj?: Partial<PerTitleConfiguration>);
50
62
  }
51
63
  export default PerTitleConfiguration;
@@ -20,6 +20,8 @@ var PerTitleConfiguration = /** @class */ (function () {
20
20
  this.autoRepresentations = (0, Mapper_1.map)(obj.autoRepresentations, AutoRepresentation_1.default);
21
21
  this.complexityFactor = (0, Mapper_1.map)(obj.complexityFactor);
22
22
  this.fixedResolutionAndBitrateConfiguration = (0, Mapper_1.map)(obj.fixedResolutionAndBitrateConfiguration, PerTitleFixedResolutionAndBitrateConfiguration_1.default);
23
+ this.targetQualityCrf = (0, Mapper_1.map)(obj.targetQualityCrf);
24
+ this.resolutionScaleFactor = (0, Mapper_1.map)(obj.resolutionScaleFactor);
23
25
  }
24
26
  return PerTitleConfiguration;
25
27
  }());