@bitmovin/api-sdk 1.225.0 → 1.227.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 (138) hide show
  1. package/README.md +1 -1
  2. package/dist/BitmovinApi.d.ts +2 -0
  3. package/dist/BitmovinApi.js +2 -0
  4. package/dist/aiSceneAnalysis/AiSceneAnalysisApi.d.ts +13 -0
  5. package/dist/{models/SimpleEncodingLiveJobAzureCredentials.js → aiSceneAnalysis/AiSceneAnalysisApi.js} +13 -16
  6. package/dist/aiSceneAnalysis/analyses/AnalysesApi.d.ts +13 -0
  7. package/dist/{encoding/simple/SimpleApi.js → aiSceneAnalysis/analyses/AnalysesApi.js} +9 -9
  8. package/dist/aiSceneAnalysis/analyses/byEncodingId/ByEncodingIdApi.d.ts +13 -0
  9. package/dist/{encoding/simple/jobs/JobsApi.js → aiSceneAnalysis/analyses/byEncodingId/ByEncodingIdApi.js} +9 -11
  10. package/dist/aiSceneAnalysis/analyses/byEncodingId/details/DetailsApi.d.ts +19 -0
  11. package/dist/aiSceneAnalysis/analyses/byEncodingId/details/DetailsApi.js +48 -0
  12. package/dist/bitmovin-api-sdk.browser.js +774 -1926
  13. package/dist/bitmovin-api-sdk.browser.min.js +1 -1
  14. package/dist/common/RestClient.js +1 -1
  15. package/dist/encoding/EncodingApi.d.ts +0 -2
  16. package/dist/encoding/EncodingApi.js +0 -2
  17. package/dist/encoding/encodings/streams/burnInSubtitles/BurnInSubtitlesApi.d.ts +2 -0
  18. package/dist/encoding/encodings/streams/burnInSubtitles/BurnInSubtitlesApi.js +2 -0
  19. package/dist/encoding/encodings/streams/burnInSubtitles/assa/AssaApi.d.ts +51 -0
  20. package/dist/encoding/encodings/streams/burnInSubtitles/assa/AssaApi.js +114 -0
  21. package/dist/encoding/encodings/streams/burnInSubtitles/assa/BurnInSubtitleAssaListQueryParams.d.ts +28 -0
  22. package/dist/encoding/encodings/streams/burnInSubtitles/assa/BurnInSubtitleAssaListQueryParams.js +29 -0
  23. package/dist/encoding/statistics/encodings/liveStatistics/events/LiveEncodingStatsEventListQueryParams.d.ts +11 -0
  24. package/dist/encoding/statistics/encodings/liveStatistics/events/LiveEncodingStatsEventListQueryParams.js +8 -0
  25. package/dist/models/Atmosphere.d.ts +23 -0
  26. package/dist/models/Atmosphere.js +21 -0
  27. package/dist/models/BurnInSubtitleAssa.d.ts +23 -0
  28. package/dist/models/{SimpleEncodingVodJobAzureCredentials.js → BurnInSubtitleAssa.js} +13 -11
  29. package/dist/models/CacheControl.d.ts +1 -1
  30. package/dist/models/Character.d.ts +23 -0
  31. package/dist/models/Character.js +21 -0
  32. package/dist/models/Content.d.ts +26 -0
  33. package/dist/models/Content.js +24 -0
  34. package/dist/models/Fmp4Muxing.d.ts +6 -0
  35. package/dist/models/Fmp4Muxing.js +1 -0
  36. package/dist/models/IABTaxonomy.d.ts +28 -0
  37. package/dist/models/IABTaxonomy.js +22 -0
  38. package/dist/models/Location.d.ts +18 -0
  39. package/dist/models/Location.js +20 -0
  40. package/dist/models/Rating.d.ts +23 -0
  41. package/dist/models/Rating.js +21 -0
  42. package/dist/models/Scene.d.ts +50 -0
  43. package/dist/models/Scene.js +28 -0
  44. package/dist/models/SceneAnalysisDetailsResponse.d.ts +40 -0
  45. package/dist/models/SceneAnalysisDetailsResponse.js +26 -0
  46. package/dist/models/SceneObject.d.ts +18 -0
  47. package/dist/models/SceneObject.js +20 -0
  48. package/dist/models/Setting.d.ts +25 -0
  49. package/dist/models/Setting.js +23 -0
  50. package/dist/models/index.d.ts +11 -40
  51. package/dist/models/index.js +11 -40
  52. package/package.json +1 -1
  53. package/dist/encoding/simple/SimpleApi.d.ts +0 -13
  54. package/dist/encoding/simple/jobs/JobsApi.d.ts +0 -15
  55. package/dist/encoding/simple/jobs/live/LiveApi.d.ts +0 -27
  56. package/dist/encoding/simple/jobs/live/LiveApi.js +0 -59
  57. package/dist/encoding/simple/jobs/vod/SimpleEncodingVodJobResponseListQueryParams.d.ts +0 -50
  58. package/dist/encoding/simple/jobs/vod/SimpleEncodingVodJobResponseListQueryParams.js +0 -45
  59. package/dist/encoding/simple/jobs/vod/VodApi.d.ts +0 -36
  60. package/dist/encoding/simple/jobs/vod/VodApi.js +0 -79
  61. package/dist/models/EncodingTemplate.d.ts +0 -10
  62. package/dist/models/EncodingTemplate.js +0 -14
  63. package/dist/models/SimpleEncodingLiveCloudRegion.d.ts +0 -13
  64. package/dist/models/SimpleEncodingLiveCloudRegion.js +0 -17
  65. package/dist/models/SimpleEncodingLiveJobAccessKeyCredentials.d.ts +0 -21
  66. package/dist/models/SimpleEncodingLiveJobAccessKeyCredentials.js +0 -39
  67. package/dist/models/SimpleEncodingLiveJobAzureCredentials.d.ts +0 -15
  68. package/dist/models/SimpleEncodingLiveJobCdnOutput.d.ts +0 -16
  69. package/dist/models/SimpleEncodingLiveJobCdnOutput.js +0 -43
  70. package/dist/models/SimpleEncodingLiveJobCredentials.d.ts +0 -8
  71. package/dist/models/SimpleEncodingLiveJobCredentials.js +0 -17
  72. package/dist/models/SimpleEncodingLiveJobGcsServiceAccountCredentials.d.ts +0 -15
  73. package/dist/models/SimpleEncodingLiveJobGcsServiceAccountCredentials.js +0 -38
  74. package/dist/models/SimpleEncodingLiveJobInput.d.ts +0 -15
  75. package/dist/models/SimpleEncodingLiveJobInput.js +0 -19
  76. package/dist/models/SimpleEncodingLiveJobInputType.d.ts +0 -9
  77. package/dist/models/SimpleEncodingLiveJobInputType.js +0 -13
  78. package/dist/models/SimpleEncodingLiveJobOutput.d.ts +0 -23
  79. package/dist/models/SimpleEncodingLiveJobOutput.js +0 -24
  80. package/dist/models/SimpleEncodingLiveJobOutputType.d.ts +0 -10
  81. package/dist/models/SimpleEncodingLiveJobOutputType.js +0 -14
  82. package/dist/models/SimpleEncodingLiveJobRequest.d.ts +0 -42
  83. package/dist/models/SimpleEncodingLiveJobRequest.js +0 -25
  84. package/dist/models/SimpleEncodingLiveJobResponse.d.ts +0 -90
  85. package/dist/models/SimpleEncodingLiveJobResponse.js +0 -34
  86. package/dist/models/SimpleEncodingLiveJobS3RoleBasedCredentials.d.ts +0 -21
  87. package/dist/models/SimpleEncodingLiveJobS3RoleBasedCredentials.js +0 -39
  88. package/dist/models/SimpleEncodingLiveJobStatus.d.ts +0 -15
  89. package/dist/models/SimpleEncodingLiveJobStatus.js +0 -19
  90. package/dist/models/SimpleEncodingLiveJobUrlOutput.d.ts +0 -35
  91. package/dist/models/SimpleEncodingLiveJobUrlOutput.js +0 -48
  92. package/dist/models/SimpleEncodingLiveJobUsernamePasswordCredentials.d.ts +0 -21
  93. package/dist/models/SimpleEncodingLiveJobUsernamePasswordCredentials.js +0 -39
  94. package/dist/models/SimpleEncodingLiveMaxResolution.d.ts +0 -10
  95. package/dist/models/SimpleEncodingLiveMaxResolution.js +0 -14
  96. package/dist/models/SimpleEncodingLiveProfile.d.ts +0 -9
  97. package/dist/models/SimpleEncodingLiveProfile.js +0 -13
  98. package/dist/models/SimpleEncodingVodJobAccessKeyCredentials.d.ts +0 -21
  99. package/dist/models/SimpleEncodingVodJobAccessKeyCredentials.js +0 -39
  100. package/dist/models/SimpleEncodingVodJobAzureCredentials.d.ts +0 -15
  101. package/dist/models/SimpleEncodingVodJobCdnOutput.d.ts +0 -23
  102. package/dist/models/SimpleEncodingVodJobCdnOutput.js +0 -45
  103. package/dist/models/SimpleEncodingVodJobCredentials.d.ts +0 -8
  104. package/dist/models/SimpleEncodingVodJobCredentials.js +0 -17
  105. package/dist/models/SimpleEncodingVodJobDirectFileUploadInput.d.ts +0 -35
  106. package/dist/models/SimpleEncodingVodJobDirectFileUploadInput.js +0 -47
  107. package/dist/models/SimpleEncodingVodJobErrors.d.ts +0 -26
  108. package/dist/models/SimpleEncodingVodJobErrors.js +0 -21
  109. package/dist/models/SimpleEncodingVodJobGcsServiceAccountCredentials.d.ts +0 -15
  110. package/dist/models/SimpleEncodingVodJobGcsServiceAccountCredentials.js +0 -38
  111. package/dist/models/SimpleEncodingVodJobInput.d.ts +0 -16
  112. package/dist/models/SimpleEncodingVodJobInput.js +0 -22
  113. package/dist/models/SimpleEncodingVodJobInputSourceType.d.ts +0 -10
  114. package/dist/models/SimpleEncodingVodJobInputSourceType.js +0 -14
  115. package/dist/models/SimpleEncodingVodJobInputType.d.ts +0 -11
  116. package/dist/models/SimpleEncodingVodJobInputType.js +0 -15
  117. package/dist/models/SimpleEncodingVodJobOptions.d.ts +0 -14
  118. package/dist/models/SimpleEncodingVodJobOptions.js +0 -19
  119. package/dist/models/SimpleEncodingVodJobOutput.d.ts +0 -23
  120. package/dist/models/SimpleEncodingVodJobOutput.js +0 -25
  121. package/dist/models/SimpleEncodingVodJobOutputArtifact.d.ts +0 -20
  122. package/dist/models/SimpleEncodingVodJobOutputArtifact.js +0 -20
  123. package/dist/models/SimpleEncodingVodJobOutputType.d.ts +0 -10
  124. package/dist/models/SimpleEncodingVodJobOutputType.js +0 -14
  125. package/dist/models/SimpleEncodingVodJobRequest.d.ts +0 -42
  126. package/dist/models/SimpleEncodingVodJobRequest.js +0 -26
  127. package/dist/models/SimpleEncodingVodJobResponse.d.ts +0 -78
  128. package/dist/models/SimpleEncodingVodJobResponse.js +0 -33
  129. package/dist/models/SimpleEncodingVodJobS3RoleBasedCredentials.d.ts +0 -21
  130. package/dist/models/SimpleEncodingVodJobS3RoleBasedCredentials.js +0 -39
  131. package/dist/models/SimpleEncodingVodJobStatus.d.ts +0 -14
  132. package/dist/models/SimpleEncodingVodJobStatus.js +0 -18
  133. package/dist/models/SimpleEncodingVodJobUrlInput.d.ts +0 -42
  134. package/dist/models/SimpleEncodingVodJobUrlInput.js +0 -49
  135. package/dist/models/SimpleEncodingVodJobUrlOutput.d.ts +0 -35
  136. package/dist/models/SimpleEncodingVodJobUrlOutput.js +0 -48
  137. package/dist/models/SimpleEncodingVodJobUsernamePasswordCredentials.d.ts +0 -21
  138. package/dist/models/SimpleEncodingVodJobUsernamePasswordCredentials.js +0 -39
@@ -1,78 +0,0 @@
1
- import EncodingTemplate from './EncodingTemplate';
2
- import SimpleEncodingVodJobErrors from './SimpleEncodingVodJobErrors';
3
- import SimpleEncodingVodJobInput from './SimpleEncodingVodJobInput';
4
- import SimpleEncodingVodJobOptions from './SimpleEncodingVodJobOptions';
5
- import SimpleEncodingVodJobOutput from './SimpleEncodingVodJobOutput';
6
- import SimpleEncodingVodJobStatus from './SimpleEncodingVodJobStatus';
7
- /**
8
- * @export
9
- * @class SimpleEncodingVodJobResponse
10
- */
11
- export declare class SimpleEncodingVodJobResponse {
12
- /**
13
- * The identifier of the Simple Encoding VOD Job
14
- * @type {string}
15
- * @memberof SimpleEncodingVodJobResponse
16
- */
17
- id?: string;
18
- /**
19
- * The current status of the Simple Encoding VOD Job
20
- * @type {SimpleEncodingVodJobStatus}
21
- * @memberof SimpleEncodingVodJobResponse
22
- */
23
- status?: SimpleEncodingVodJobStatus;
24
- /**
25
- * The template that has been used for the encoding.
26
- * @type {EncodingTemplate}
27
- * @memberof SimpleEncodingVodJobResponse
28
- */
29
- encodingTemplate?: EncodingTemplate;
30
- /**
31
- * The identifier of the encoding that has been created based on the job request. This is only returned once the job execution has been successful and the encoding could be started.
32
- * @type {string}
33
- * @memberof SimpleEncodingVodJobResponse
34
- */
35
- encodingId?: string;
36
- /**
37
- * @type {SimpleEncodingVodJobInput[]}
38
- * @memberof SimpleEncodingVodJobResponse
39
- */
40
- inputs?: SimpleEncodingVodJobInput[];
41
- /**
42
- * @type {SimpleEncodingVodJobOutput[]}
43
- * @memberof SimpleEncodingVodJobResponse
44
- */
45
- outputs?: SimpleEncodingVodJobOutput[];
46
- /**
47
- * Options to customize the Simple Encoding Job
48
- * @type {SimpleEncodingVodJobOptions}
49
- * @memberof SimpleEncodingVodJobResponse
50
- */
51
- options?: SimpleEncodingVodJobOptions;
52
- /**
53
- * Describes all the errors in cases the status of the job is 'error'.
54
- * @type {SimpleEncodingVodJobErrors[]}
55
- * @memberof SimpleEncodingVodJobResponse
56
- */
57
- errors?: SimpleEncodingVodJobErrors[];
58
- /**
59
- * Creation timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
60
- * @type {Date}
61
- * @memberof SimpleEncodingVodJobResponse
62
- */
63
- createdAt?: Date;
64
- /**
65
- * Modified timestamp, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ. The job is updated for example when the status changes
66
- * @type {Date}
67
- * @memberof SimpleEncodingVodJobResponse
68
- */
69
- modifiedAt?: Date;
70
- /**
71
- * This property will be used for naming the encoding and the manifests.
72
- * @type {string}
73
- * @memberof SimpleEncodingVodJobResponse
74
- */
75
- name?: string;
76
- constructor(obj?: Partial<SimpleEncodingVodJobResponse>);
77
- }
78
- export default SimpleEncodingVodJobResponse;
@@ -1,33 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SimpleEncodingVodJobResponse = void 0;
4
- var Mapper_1 = require("../common/Mapper");
5
- var SimpleEncodingVodJobErrors_1 = require("./SimpleEncodingVodJobErrors");
6
- var SimpleEncodingVodJobInput_1 = require("./SimpleEncodingVodJobInput");
7
- var SimpleEncodingVodJobOptions_1 = require("./SimpleEncodingVodJobOptions");
8
- var SimpleEncodingVodJobOutput_1 = require("./SimpleEncodingVodJobOutput");
9
- /**
10
- * @export
11
- * @class SimpleEncodingVodJobResponse
12
- */
13
- var SimpleEncodingVodJobResponse = /** @class */ (function () {
14
- function SimpleEncodingVodJobResponse(obj) {
15
- if (!obj) {
16
- return;
17
- }
18
- this.id = (0, Mapper_1.map)(obj.id);
19
- this.status = (0, Mapper_1.map)(obj.status);
20
- this.encodingTemplate = (0, Mapper_1.map)(obj.encodingTemplate);
21
- this.encodingId = (0, Mapper_1.map)(obj.encodingId);
22
- this.inputs = (0, Mapper_1.mapArray)(obj.inputs, SimpleEncodingVodJobInput_1.default);
23
- this.outputs = (0, Mapper_1.mapArray)(obj.outputs, SimpleEncodingVodJobOutput_1.default);
24
- this.options = (0, Mapper_1.map)(obj.options, SimpleEncodingVodJobOptions_1.default);
25
- this.errors = (0, Mapper_1.mapArray)(obj.errors, SimpleEncodingVodJobErrors_1.default);
26
- this.createdAt = (0, Mapper_1.map)(obj.createdAt, Date);
27
- this.modifiedAt = (0, Mapper_1.map)(obj.modifiedAt, Date);
28
- this.name = (0, Mapper_1.map)(obj.name);
29
- }
30
- return SimpleEncodingVodJobResponse;
31
- }());
32
- exports.SimpleEncodingVodJobResponse = SimpleEncodingVodJobResponse;
33
- exports.default = SimpleEncodingVodJobResponse;
@@ -1,21 +0,0 @@
1
- import SimpleEncodingVodJobCredentials from './SimpleEncodingVodJobCredentials';
2
- /**
3
- * @export
4
- * @class SimpleEncodingVodJobS3RoleBasedCredentials
5
- */
6
- export declare class SimpleEncodingVodJobS3RoleBasedCredentials extends SimpleEncodingVodJobCredentials {
7
- /**
8
- * Amazon ARN of the IAM Role (Identity and Access Management Role) that will be assumed for S3 access. More details can be found [here](https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/PostEncodingInputsS3RoleBased) (required)
9
- * @type {string}
10
- * @memberof SimpleEncodingVodJobS3RoleBasedCredentials
11
- */
12
- roleArn?: string;
13
- /**
14
- * Defines if the organization ID has to be used as externalId when assuming the role. More details can be found [here](https://bitmovin.com/docs/encoding/api-reference/sections/inputs#/Encoding/PostEncodingInputsS3RoleBased)
15
- * @type {boolean}
16
- * @memberof SimpleEncodingVodJobS3RoleBasedCredentials
17
- */
18
- useExternalId?: boolean;
19
- constructor(obj?: Partial<SimpleEncodingVodJobS3RoleBasedCredentials>);
20
- }
21
- export default SimpleEncodingVodJobS3RoleBasedCredentials;
@@ -1,39 +0,0 @@
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
- exports.SimpleEncodingVodJobS3RoleBasedCredentials = void 0;
19
- var Mapper_1 = require("../common/Mapper");
20
- var SimpleEncodingVodJobCredentials_1 = require("./SimpleEncodingVodJobCredentials");
21
- /**
22
- * @export
23
- * @class SimpleEncodingVodJobS3RoleBasedCredentials
24
- */
25
- var SimpleEncodingVodJobS3RoleBasedCredentials = /** @class */ (function (_super) {
26
- __extends(SimpleEncodingVodJobS3RoleBasedCredentials, _super);
27
- function SimpleEncodingVodJobS3RoleBasedCredentials(obj) {
28
- var _this = _super.call(this, obj) || this;
29
- if (!obj) {
30
- return _this;
31
- }
32
- _this.roleArn = (0, Mapper_1.map)(obj.roleArn);
33
- _this.useExternalId = (0, Mapper_1.map)(obj.useExternalId);
34
- return _this;
35
- }
36
- return SimpleEncodingVodJobS3RoleBasedCredentials;
37
- }(SimpleEncodingVodJobCredentials_1.default));
38
- exports.SimpleEncodingVodJobS3RoleBasedCredentials = SimpleEncodingVodJobS3RoleBasedCredentials;
39
- exports.default = SimpleEncodingVodJobS3RoleBasedCredentials;
@@ -1,14 +0,0 @@
1
- /**
2
- * @export
3
- * @enum {string}
4
- */
5
- export declare enum SimpleEncodingVodJobStatus {
6
- CREATED = "CREATED",
7
- EXECUTING = "EXECUTING",
8
- FAILURE = "FAILURE",
9
- RUNNING = "RUNNING",
10
- FINISHED = "FINISHED",
11
- ERROR = "ERROR",
12
- CANCELED = "CANCELED"
13
- }
14
- export default SimpleEncodingVodJobStatus;
@@ -1,18 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.SimpleEncodingVodJobStatus = void 0;
4
- /**
5
- * @export
6
- * @enum {string}
7
- */
8
- var SimpleEncodingVodJobStatus;
9
- (function (SimpleEncodingVodJobStatus) {
10
- SimpleEncodingVodJobStatus["CREATED"] = "CREATED";
11
- SimpleEncodingVodJobStatus["EXECUTING"] = "EXECUTING";
12
- SimpleEncodingVodJobStatus["FAILURE"] = "FAILURE";
13
- SimpleEncodingVodJobStatus["RUNNING"] = "RUNNING";
14
- SimpleEncodingVodJobStatus["FINISHED"] = "FINISHED";
15
- SimpleEncodingVodJobStatus["ERROR"] = "ERROR";
16
- SimpleEncodingVodJobStatus["CANCELED"] = "CANCELED";
17
- })(SimpleEncodingVodJobStatus || (exports.SimpleEncodingVodJobStatus = SimpleEncodingVodJobStatus = {}));
18
- exports.default = SimpleEncodingVodJobStatus;
@@ -1,42 +0,0 @@
1
- import SimpleEncodingVodJobCredentials from './SimpleEncodingVodJobCredentials';
2
- import SimpleEncodingVodJobInput from './SimpleEncodingVodJobInput';
3
- import SimpleEncodingVodJobInputSourceType from './SimpleEncodingVodJobInputSourceType';
4
- import SimpleEncodingVodJobInputType from './SimpleEncodingVodJobInputType';
5
- /**
6
- * @export
7
- * @class SimpleEncodingVodJobUrlInput
8
- */
9
- export declare class SimpleEncodingVodJobUrlInput extends SimpleEncodingVodJobInput {
10
- /**
11
- * Discriminator property for SimpleEncodingVodJobInput
12
- * @type {string}
13
- * @memberof SimpleEncodingVodJobUrlInput
14
- */
15
- readonly type: SimpleEncodingVodJobInputSourceType;
16
- /**
17
- * Define a URL pointing to the asset that should be encoded. The URL has to point to a file. Currently the following protocols/storages systems are supported: HTTP(S), (S)FTP, S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require `credentials` to access the asset. Check the description below which ones are applicable. See below how to construct the URLs for the individual protocols/storage systems. --- **HTTP** and **HTTPS**: * `http://<host>[:<port>]/path/file.mp4` * `https://<host>[:<port>]/path/file.mp4` The port is defaulted to 80 if it's not provided. If the content is secured by Basic Authentication please provide corresponding credentials. **FTP** and **SFTP**: * `ftp://<host>[:<port>]/path/file.mp4` * `sftp://<host>[:<port>]/path/file.mp4` The port is defaulted to 21 (ftp) or 22 (sftp) if it's not provided. If the content is secured please provide corresponding credentials. **S3**: * `s3://<my-bucket>/path/file.mp4` Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. **GCS**: * `gcs://<my-bucket>/path/file.mp4` Authentication can be done via accesskey/secretkey or a service account **Azure Blob Storage (ABS)**: * `https://<account>.blob.core.windows.net/<container>/path/file.mp4` It is required to provide the Azure key credentials for authentication. **Akamai NetStorage**: * `https://<host>-nsu.akamaihd.net/<CP-code>/path/file.mp4` It is required to provide username/password credentials for authentication. (required)
18
- * @type {string}
19
- * @memberof SimpleEncodingVodJobUrlInput
20
- */
21
- url?: string;
22
- /**
23
- * Credentials to be used for authentication and accessing the file. Check out the examples on how to define the credentials correctly.
24
- * @type {SimpleEncodingVodJobCredentials}
25
- * @memberof SimpleEncodingVodJobUrlInput
26
- */
27
- credentials?: SimpleEncodingVodJobCredentials;
28
- /**
29
- * Defines the type of the input file, if no type is set it is assumed that the input file contains at least one video stream and optionally one or multiple audio streams. Note that when defining video and audio inputs, you can either - add one single input without inputType, in which case that source file must contain a video stream and (if you want audio) one audio stream, or - add one single input with inputType=VIDEO and (if you want audio) one or more inputs with inputType=AUDIO (each containing one audio stream) Other combinations are not valid.
30
- * @type {SimpleEncodingVodJobInputType}
31
- * @memberof SimpleEncodingVodJobUrlInput
32
- */
33
- inputType?: SimpleEncodingVodJobInputType;
34
- /**
35
- * The language of the audio track, the subtitles, or closed captions file. The language code must be compliant with [BCP 47](https://datatracker.ietf.org/doc/html/rfc5646). This property is mandatory if the input provided is of type SUBTITLES or CLOSED_CAPTIONS and recommended for input type AUDIO and an input that does not specify an input type (combined audio and video). If an audio input does not specify the language, it is defaulted to `und` (undefined).
36
- * @type {string}
37
- * @memberof SimpleEncodingVodJobUrlInput
38
- */
39
- language?: string;
40
- constructor(obj?: Partial<SimpleEncodingVodJobUrlInput>);
41
- }
42
- export default SimpleEncodingVodJobUrlInput;
@@ -1,49 +0,0 @@
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
- exports.SimpleEncodingVodJobUrlInput = void 0;
19
- var Mapper_1 = require("../common/Mapper");
20
- var SimpleEncodingVodJobCredentials_1 = require("./SimpleEncodingVodJobCredentials");
21
- var SimpleEncodingVodJobInput_1 = require("./SimpleEncodingVodJobInput");
22
- var SimpleEncodingVodJobInputSourceType_1 = require("./SimpleEncodingVodJobInputSourceType");
23
- /**
24
- * @export
25
- * @class SimpleEncodingVodJobUrlInput
26
- */
27
- var SimpleEncodingVodJobUrlInput = /** @class */ (function (_super) {
28
- __extends(SimpleEncodingVodJobUrlInput, _super);
29
- function SimpleEncodingVodJobUrlInput(obj) {
30
- var _this = _super.call(this, obj) || this;
31
- /**
32
- * Discriminator property for SimpleEncodingVodJobInput
33
- * @type {string}
34
- * @memberof SimpleEncodingVodJobUrlInput
35
- */
36
- _this.type = SimpleEncodingVodJobInputSourceType_1.default.URL;
37
- if (!obj) {
38
- return _this;
39
- }
40
- _this.url = (0, Mapper_1.map)(obj.url);
41
- _this.credentials = (0, Mapper_1.map)(obj.credentials, SimpleEncodingVodJobCredentials_1.default);
42
- _this.inputType = (0, Mapper_1.map)(obj.inputType);
43
- _this.language = (0, Mapper_1.map)(obj.language);
44
- return _this;
45
- }
46
- return SimpleEncodingVodJobUrlInput;
47
- }(SimpleEncodingVodJobInput_1.default));
48
- exports.SimpleEncodingVodJobUrlInput = SimpleEncodingVodJobUrlInput;
49
- exports.default = SimpleEncodingVodJobUrlInput;
@@ -1,35 +0,0 @@
1
- import SimpleEncodingVodJobCredentials from './SimpleEncodingVodJobCredentials';
2
- import SimpleEncodingVodJobOutput from './SimpleEncodingVodJobOutput';
3
- import SimpleEncodingVodJobOutputType from './SimpleEncodingVodJobOutputType';
4
- /**
5
- * @export
6
- * @class SimpleEncodingVodJobUrlOutput
7
- */
8
- export declare class SimpleEncodingVodJobUrlOutput extends SimpleEncodingVodJobOutput {
9
- /**
10
- * Discriminator property for SimpleEncodingVodJobOutput
11
- * @type {string}
12
- * @memberof SimpleEncodingVodJobUrlOutput
13
- */
14
- readonly type: SimpleEncodingVodJobOutputType;
15
- /**
16
- * Define a URL pointing to a folder which will be used to upload the encoded assets. The output folder structure used looks the following way: <br><br> `http://host/my-folder` <ul> <li> `/video` <ul> <li>`/h264/{width}x{height}_{bitrate}/` (multiple subfolders containing different output renditions)</li> </ul> </li> <li>`/audio` <ul> <li>`/aac/{language}/` - if language is unique (subfolder containing audio output files)</li> <li>`/aac/{language}_{index}/` - if language is not unique (subfolder containing audio output files)</li> </ul> </li> <li>`/subtitles` (subfolder containing subtitles files)</li> <li>`/captions` (subfolder containing subtitles files)</li> <li>`/sprites` (subfolder containing generated sprites)</li> <li>`/thumbnails` (subfolder containing generated thumbnails)</li> <li>`/index.m3u8` (HLS manifest file) </li> <li>`/stream.mpd` (DASH manifest file) </li> </ul> Currently the following protocols/storages systems are supported: S3, GCS, Azure Blob Storage, Akamai NetStorage. Note that most protocols will require `credentials` to access the asset. Check in the descriptions below which properties can or need to be provided within the `credentials` key. See below how to construct the URLs for the individual protocols/storage systems. ___ **Recommendation** To ensure uniqueness of output paths accross multiple encodings, make use of the following placeholders in the output's URL: {uuid} - will be replaced with a random UUID {asset} - will be replaced with the asset file name (only for the input type VIDEO or DEFAULT) Examples: * using the `{uuid}` placeholder: The output URL `s3://<my-bucket>/{uuid}/path/` will be transformed to e.g. `s3://<my-bucket>/d59295f3-1548-4bd9-843d-6ac6896dbdb6/path/`. * using the `{asset}` placeholder: Given an input `s3://my-bucket/path/filename.mp4` of type VIDEO or DEFAULT, the output URL `s3://<my-bucket>/{asset}/path/` will be transformed to `s3://<my-bucket>/filename/path/` Notes: - Placeholders can be combined or used multiple times in the same URL. - Placeholders are ignored when used in conjunction with `DirectFileUploadInput`s because in this case the asset file name cannot be set. ___ **S3**: * `s3://<my-bucket>/path/` Authentication can be done via accesskey/secretkey or role-based authentication. Generic S3 is currently NOT supported. **GCS**: * `gcs://<my-bucket>/path/` Authentication can be done via accesskey/secretkey or a service account **Azure Blob Storage (ABS)**: * `https://<account>.blob.core.windows.net/<container>/path/` It is required to provide the Azure key credentials for authentication. **Akamai NetStorage**: * `https://<host>-nsu.akamaihd.net/<CP-code>/path/` It is required to provide username/password credentials for authentication. (required)
17
- * @type {string}
18
- * @memberof SimpleEncodingVodJobUrlOutput
19
- */
20
- url?: string;
21
- /**
22
- * Credentials to be used for authentication and accessing the folder
23
- * @type {SimpleEncodingVodJobCredentials}
24
- * @memberof SimpleEncodingVodJobUrlOutput
25
- */
26
- credentials?: SimpleEncodingVodJobCredentials;
27
- /**
28
- * Indicates if the output should be publically available so that playback immediately works over the internet. Note that not every storage provider supports public output, in this case the flag will be ignored (e.g., Akamai NetStorage). It might forbidden by some storage configuration to make files public, for example an S3 buckets can be configured to disallow public access. In this case set it to false.
29
- * @type {boolean}
30
- * @memberof SimpleEncodingVodJobUrlOutput
31
- */
32
- makePublic?: boolean;
33
- constructor(obj?: Partial<SimpleEncodingVodJobUrlOutput>);
34
- }
35
- export default SimpleEncodingVodJobUrlOutput;
@@ -1,48 +0,0 @@
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
- exports.SimpleEncodingVodJobUrlOutput = void 0;
19
- var Mapper_1 = require("../common/Mapper");
20
- var SimpleEncodingVodJobCredentials_1 = require("./SimpleEncodingVodJobCredentials");
21
- var SimpleEncodingVodJobOutput_1 = require("./SimpleEncodingVodJobOutput");
22
- var SimpleEncodingVodJobOutputType_1 = require("./SimpleEncodingVodJobOutputType");
23
- /**
24
- * @export
25
- * @class SimpleEncodingVodJobUrlOutput
26
- */
27
- var SimpleEncodingVodJobUrlOutput = /** @class */ (function (_super) {
28
- __extends(SimpleEncodingVodJobUrlOutput, _super);
29
- function SimpleEncodingVodJobUrlOutput(obj) {
30
- var _this = _super.call(this, obj) || this;
31
- /**
32
- * Discriminator property for SimpleEncodingVodJobOutput
33
- * @type {string}
34
- * @memberof SimpleEncodingVodJobUrlOutput
35
- */
36
- _this.type = SimpleEncodingVodJobOutputType_1.default.URL;
37
- if (!obj) {
38
- return _this;
39
- }
40
- _this.url = (0, Mapper_1.map)(obj.url);
41
- _this.credentials = (0, Mapper_1.map)(obj.credentials, SimpleEncodingVodJobCredentials_1.default);
42
- _this.makePublic = (0, Mapper_1.map)(obj.makePublic);
43
- return _this;
44
- }
45
- return SimpleEncodingVodJobUrlOutput;
46
- }(SimpleEncodingVodJobOutput_1.default));
47
- exports.SimpleEncodingVodJobUrlOutput = SimpleEncodingVodJobUrlOutput;
48
- exports.default = SimpleEncodingVodJobUrlOutput;
@@ -1,21 +0,0 @@
1
- import SimpleEncodingVodJobCredentials from './SimpleEncodingVodJobCredentials';
2
- /**
3
- * @export
4
- * @class SimpleEncodingVodJobUsernamePasswordCredentials
5
- */
6
- export declare class SimpleEncodingVodJobUsernamePasswordCredentials extends SimpleEncodingVodJobCredentials {
7
- /**
8
- * The username to be used for authentication. (required)
9
- * @type {string}
10
- * @memberof SimpleEncodingVodJobUsernamePasswordCredentials
11
- */
12
- username?: string;
13
- /**
14
- * The password to be used for authentication (required)
15
- * @type {string}
16
- * @memberof SimpleEncodingVodJobUsernamePasswordCredentials
17
- */
18
- password?: string;
19
- constructor(obj?: Partial<SimpleEncodingVodJobUsernamePasswordCredentials>);
20
- }
21
- export default SimpleEncodingVodJobUsernamePasswordCredentials;
@@ -1,39 +0,0 @@
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
- exports.SimpleEncodingVodJobUsernamePasswordCredentials = void 0;
19
- var Mapper_1 = require("../common/Mapper");
20
- var SimpleEncodingVodJobCredentials_1 = require("./SimpleEncodingVodJobCredentials");
21
- /**
22
- * @export
23
- * @class SimpleEncodingVodJobUsernamePasswordCredentials
24
- */
25
- var SimpleEncodingVodJobUsernamePasswordCredentials = /** @class */ (function (_super) {
26
- __extends(SimpleEncodingVodJobUsernamePasswordCredentials, _super);
27
- function SimpleEncodingVodJobUsernamePasswordCredentials(obj) {
28
- var _this = _super.call(this, obj) || this;
29
- if (!obj) {
30
- return _this;
31
- }
32
- _this.username = (0, Mapper_1.map)(obj.username);
33
- _this.password = (0, Mapper_1.map)(obj.password);
34
- return _this;
35
- }
36
- return SimpleEncodingVodJobUsernamePasswordCredentials;
37
- }(SimpleEncodingVodJobCredentials_1.default));
38
- exports.SimpleEncodingVodJobUsernamePasswordCredentials = SimpleEncodingVodJobUsernamePasswordCredentials;
39
- exports.default = SimpleEncodingVodJobUsernamePasswordCredentials;