@bitmovin/api-sdk 1.162.0 → 1.163.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 (35) hide show
  1. package/README.md +1 -1
  2. package/dist/bitmovin-api-sdk.browser.js +115 -28
  3. package/dist/bitmovin-api-sdk.browser.min.js +1 -1
  4. package/dist/common/RestClient.js +1 -1
  5. package/dist/encoding/history/encodings/EncodingListQueryParams.d.ts +11 -0
  6. package/dist/encoding/history/encodings/EncodingListQueryParams.js +8 -0
  7. package/dist/encoding/manifests/dash/DashApi.d.ts +14 -7
  8. package/dist/encoding/manifests/dash/DashApi.js +22 -7
  9. package/dist/encoding/manifests/dash/default/DefaultApi.d.ts +2 -2
  10. package/dist/encoding/manifests/dash/default/DefaultApi.js +2 -2
  11. package/dist/encoding/manifests/hls/HlsApi.d.ts +14 -7
  12. package/dist/encoding/manifests/hls/HlsApi.js +22 -7
  13. package/dist/encoding/manifests/hls/default/DefaultApi.d.ts +2 -2
  14. package/dist/encoding/manifests/hls/default/DefaultApi.js +2 -2
  15. package/dist/encoding/manifests/smooth/SmoothApi.d.ts +13 -6
  16. package/dist/encoding/manifests/smooth/SmoothApi.js +21 -6
  17. package/dist/encoding/manifests/smooth/default/DefaultApi.d.ts +2 -2
  18. package/dist/encoding/manifests/smooth/default/DefaultApi.js +2 -2
  19. package/dist/models/DashManifestDefault.d.ts +3 -4
  20. package/dist/models/DashManifestDefault.js +0 -1
  21. package/dist/models/H265VideoConfiguration.d.ts +2 -2
  22. package/dist/models/HlsManifestDefault.d.ts +1 -1
  23. package/dist/models/Scheduling.d.ts +1 -1
  24. package/dist/models/SimpleEncodingVodJobOptions.d.ts +14 -0
  25. package/dist/models/SimpleEncodingVodJobOptions.js +19 -0
  26. package/dist/models/SimpleEncodingVodJobRequest.d.ts +7 -0
  27. package/dist/models/SimpleEncodingVodJobRequest.js +2 -0
  28. package/dist/models/SimpleEncodingVodJobResponse.d.ts +7 -0
  29. package/dist/models/SimpleEncodingVodJobResponse.js +2 -0
  30. package/dist/models/SmoothManifestDefault.d.ts +1 -1
  31. package/dist/models/SmoothStreamingRepresentation.d.ts +1 -1
  32. package/dist/models/StartManifestRequest.d.ts +1 -1
  33. package/dist/models/index.d.ts +1 -0
  34. package/dist/models/index.js +1 -0
  35. 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.162.0',
243
+ 'X-Api-Client-Version': '1.163.0',
244
244
  'Content-Type': 'application/json'
245
245
  };
246
246
  if (tenantOrgId) {
@@ -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 false
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 false
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 false
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`
@@ -21,26 +21,33 @@ export default class DashApi extends BaseAPI {
21
21
  periods: PeriodsApi;
22
22
  constructor(configuration: Configuration);
23
23
  /**
24
- * @summary Create DASH Manifest
25
- * @param {DashManifest} dashManifest The DASH manifest to be created
24
+ * @summary Create Custom DASH Manifest
25
+ * @param {DashManifest} dashManifest A Custom DASH Manifest gives you full control over its contents. Add Periods, Adaptation Sets, Representations, Content Protections or Custom XML Elements via the respective endpoints. If you need a simpler solution, create a Default Manifest instead. See TODO: link
26
26
  * @throws {BitmovinError}
27
27
  * @memberof DashApi
28
28
  */
29
29
  create(dashManifest?: DashManifest): Promise<DashManifest>;
30
30
  /**
31
31
  * @summary Delete DASH Manifest
32
- * @param {string} manifestId UUID of the DASH manifest to be deleted
32
+ * @param {string} manifestId UUID of the DASH Manifest to be deleted
33
33
  * @throws {BitmovinError}
34
34
  * @memberof DashApi
35
35
  */
36
36
  delete(manifestId: string): Promise<BitmovinResponse>;
37
37
  /**
38
38
  * @summary DASH Manifest Details
39
- * @param {string} manifestId UUID of the dash manifest
39
+ * @param {string} manifestId UUID of the DASH Manifest
40
40
  * @throws {BitmovinError}
41
41
  * @memberof DashApi
42
42
  */
43
43
  get(manifestId: string): Promise<DashManifest>;
44
+ /**
45
+ * @summary Manifest Start Details
46
+ * @param {string} manifestId Id of the manifest
47
+ * @throws {BitmovinError}
48
+ * @memberof DashApi
49
+ */
50
+ getStartRequest(manifestId: string): Promise<StartManifestRequest>;
44
51
  /**
45
52
  * @summary List DASH Manifests
46
53
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -50,7 +57,7 @@ export default class DashApi extends BaseAPI {
50
57
  list(queryParameters?: DashManifestListQueryParams | ((q: DashManifestListQueryParamsBuilder) => DashManifestListQueryParamsBuilder)): Promise<PaginationResponse<DashManifest>>;
51
58
  /**
52
59
  * @summary Start DASH Manifest Creation
53
- * @param {string} manifestId Id of the DASH manifest.
60
+ * @param {string} manifestId Id of the DASH Manifest.
54
61
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
55
62
  * @throws {BitmovinError}
56
63
  * @memberof DashApi
@@ -58,14 +65,14 @@ export default class DashApi extends BaseAPI {
58
65
  start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
59
66
  /**
60
67
  * @summary DASH Manifest Creation Status
61
- * @param {string} manifestId Id of the DASH manifest.
68
+ * @param {string} manifestId Id of the DASH Manifest.
62
69
  * @throws {BitmovinError}
63
70
  * @memberof DashApi
64
71
  */
65
72
  status(manifestId: string): Promise<Task>;
66
73
  /**
67
74
  * @summary Stop DASH Manifest Creation
68
- * @param {string} manifestId Id of the DASH manifest.
75
+ * @param {string} manifestId Id of the DASH Manifest.
69
76
  * @throws {BitmovinError}
70
77
  * @memberof DashApi
71
78
  */
@@ -22,6 +22,7 @@ var CustomdataApi_1 = require("./customdata/CustomdataApi");
22
22
  var PeriodsApi_1 = require("./periods/PeriodsApi");
23
23
  var BitmovinResponse_1 = require("../../../models/BitmovinResponse");
24
24
  var DashManifest_1 = require("../../../models/DashManifest");
25
+ var StartManifestRequest_1 = require("../../../models/StartManifestRequest");
25
26
  var Task_1 = require("../../../models/Task");
26
27
  var PaginationResponse_1 = require("../../../models/PaginationResponse");
27
28
  var DashManifestListQueryParams_1 = require("./DashManifestListQueryParams");
@@ -41,8 +42,8 @@ var DashApi = /** @class */ (function (_super) {
41
42
  return _this;
42
43
  }
43
44
  /**
44
- * @summary Create DASH Manifest
45
- * @param {DashManifest} dashManifest The DASH manifest to be created
45
+ * @summary Create Custom DASH Manifest
46
+ * @param {DashManifest} dashManifest A Custom DASH Manifest gives you full control over its contents. Add Periods, Adaptation Sets, Representations, Content Protections or Custom XML Elements via the respective endpoints. If you need a simpler solution, create a Default Manifest instead. See TODO: link
46
47
  * @throws {BitmovinError}
47
48
  * @memberof DashApi
48
49
  */
@@ -53,7 +54,7 @@ var DashApi = /** @class */ (function (_super) {
53
54
  };
54
55
  /**
55
56
  * @summary Delete DASH Manifest
56
- * @param {string} manifestId UUID of the DASH manifest to be deleted
57
+ * @param {string} manifestId UUID of the DASH Manifest to be deleted
57
58
  * @throws {BitmovinError}
58
59
  * @memberof DashApi
59
60
  */
@@ -67,7 +68,7 @@ var DashApi = /** @class */ (function (_super) {
67
68
  };
68
69
  /**
69
70
  * @summary DASH Manifest Details
70
- * @param {string} manifestId UUID of the dash manifest
71
+ * @param {string} manifestId UUID of the DASH Manifest
71
72
  * @throws {BitmovinError}
72
73
  * @memberof DashApi
73
74
  */
@@ -79,6 +80,20 @@ var DashApi = /** @class */ (function (_super) {
79
80
  return (0, Mapper_1.map)(response, DashManifest_1.default);
80
81
  });
81
82
  };
83
+ /**
84
+ * @summary Manifest Start Details
85
+ * @param {string} manifestId Id of the manifest
86
+ * @throws {BitmovinError}
87
+ * @memberof DashApi
88
+ */
89
+ DashApi.prototype.getStartRequest = function (manifestId) {
90
+ var pathParamMap = {
91
+ manifest_id: manifestId
92
+ };
93
+ return this.restClient.get('/encoding/manifests/dash/{manifest_id}/start', pathParamMap).then(function (response) {
94
+ return (0, Mapper_1.map)(response, StartManifestRequest_1.default);
95
+ });
96
+ };
82
97
  /**
83
98
  * @summary List DASH Manifests
84
99
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -99,7 +114,7 @@ var DashApi = /** @class */ (function (_super) {
99
114
  };
100
115
  /**
101
116
  * @summary Start DASH Manifest Creation
102
- * @param {string} manifestId Id of the DASH manifest.
117
+ * @param {string} manifestId Id of the DASH Manifest.
103
118
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
104
119
  * @throws {BitmovinError}
105
120
  * @memberof DashApi
@@ -114,7 +129,7 @@ var DashApi = /** @class */ (function (_super) {
114
129
  };
115
130
  /**
116
131
  * @summary DASH Manifest Creation Status
117
- * @param {string} manifestId Id of the DASH manifest.
132
+ * @param {string} manifestId Id of the DASH Manifest.
118
133
  * @throws {BitmovinError}
119
134
  * @memberof DashApi
120
135
  */
@@ -128,7 +143,7 @@ var DashApi = /** @class */ (function (_super) {
128
143
  };
129
144
  /**
130
145
  * @summary Stop DASH Manifest Creation
131
- * @param {string} manifestId Id of the DASH manifest.
146
+ * @param {string} manifestId Id of the DASH Manifest.
132
147
  * @throws {BitmovinError}
133
148
  * @memberof DashApi
134
149
  */
@@ -10,8 +10,8 @@ import DashManifestDefault from '../../../../models/DashManifestDefault';
10
10
  export default class DefaultApi extends BaseAPI {
11
11
  constructor(configuration: Configuration);
12
12
  /**
13
- * @summary Create DASH Manifest Default
14
- * @param {DashManifestDefault} dashManifestDefault The DASH Manifest Default to be created
13
+ * @summary Create Default DASH Manifest
14
+ * @param {DashManifestDefault} dashManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest instead. See TODO: link
15
15
  * @throws {BitmovinError}
16
16
  * @memberof DefaultApi
17
17
  */
@@ -30,8 +30,8 @@ var DefaultApi = /** @class */ (function (_super) {
30
30
  return _super.call(this, configuration) || this;
31
31
  }
32
32
  /**
33
- * @summary Create DASH Manifest Default
34
- * @param {DashManifestDefault} dashManifestDefault The DASH Manifest Default to be created
33
+ * @summary Create Default DASH Manifest
34
+ * @param {DashManifestDefault} dashManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest instead. See TODO: link
35
35
  * @throws {BitmovinError}
36
36
  * @memberof DefaultApi
37
37
  */
@@ -23,26 +23,33 @@ export default class HlsApi extends BaseAPI {
23
23
  media: MediaApi;
24
24
  constructor(configuration: Configuration);
25
25
  /**
26
- * @summary Create HLS Manifest
27
- * @param {HlsManifest} hlsManifest The HLS Manifest to be created
26
+ * @summary Create Custom HLS Manifest
27
+ * @param {HlsManifest} hlsManifest A Custom HLS Manifest gives you full control over its contents. Add Variant Streams and Media elements via the respective endpoints. If you need a simpler solution, create a Default Manifest instead. See TODO: link
28
28
  * @throws {BitmovinError}
29
29
  * @memberof HlsApi
30
30
  */
31
31
  create(hlsManifest?: HlsManifest): Promise<HlsManifest>;
32
32
  /**
33
33
  * @summary Delete HLS Manifest
34
- * @param {string} manifestId Id of the hls manifest.
34
+ * @param {string} manifestId Id of the HLS Manifest.
35
35
  * @throws {BitmovinError}
36
36
  * @memberof HlsApi
37
37
  */
38
38
  delete(manifestId: string): Promise<BitmovinResponse>;
39
39
  /**
40
40
  * @summary HLS Manifest Details
41
- * @param {string} manifestId Id of the hls manifest.
41
+ * @param {string} manifestId Id of the HLS Manifest.
42
42
  * @throws {BitmovinError}
43
43
  * @memberof HlsApi
44
44
  */
45
45
  get(manifestId: string): Promise<HlsManifest>;
46
+ /**
47
+ * @summary Manifest Start Details
48
+ * @param {string} manifestId ID of the manifest
49
+ * @throws {BitmovinError}
50
+ * @memberof HlsApi
51
+ */
52
+ getStartRequest(manifestId: string): Promise<StartManifestRequest>;
46
53
  /**
47
54
  * @summary List HLS Manifests
48
55
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -52,7 +59,7 @@ export default class HlsApi extends BaseAPI {
52
59
  list(queryParameters?: HlsManifestListQueryParams | ((q: HlsManifestListQueryParamsBuilder) => HlsManifestListQueryParamsBuilder)): Promise<PaginationResponse<HlsManifest>>;
53
60
  /**
54
61
  * @summary Start HLS Manifest Creation
55
- * @param {string} manifestId Id of the HLS manifest.
62
+ * @param {string} manifestId Id of the HLS Manifest.
56
63
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
57
64
  * @throws {BitmovinError}
58
65
  * @memberof HlsApi
@@ -60,14 +67,14 @@ export default class HlsApi extends BaseAPI {
60
67
  start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
61
68
  /**
62
69
  * @summary HLS Manifest Creation Status
63
- * @param {string} manifestId Id of the HLS manifest.
70
+ * @param {string} manifestId Id of the HLS Manifest.
64
71
  * @throws {BitmovinError}
65
72
  * @memberof HlsApi
66
73
  */
67
74
  status(manifestId: string): Promise<Task>;
68
75
  /**
69
76
  * @summary Stop HLS Manifest Creation
70
- * @param {string} manifestId Id of the HLS manifest.
77
+ * @param {string} manifestId Id of the HLS Manifest.
71
78
  * @throws {BitmovinError}
72
79
  * @memberof HlsApi
73
80
  */
@@ -23,6 +23,7 @@ var StreamsApi_1 = require("./streams/StreamsApi");
23
23
  var MediaApi_1 = require("./media/MediaApi");
24
24
  var BitmovinResponse_1 = require("../../../models/BitmovinResponse");
25
25
  var HlsManifest_1 = require("../../../models/HlsManifest");
26
+ var StartManifestRequest_1 = require("../../../models/StartManifestRequest");
26
27
  var Task_1 = require("../../../models/Task");
27
28
  var PaginationResponse_1 = require("../../../models/PaginationResponse");
28
29
  var HlsManifestListQueryParams_1 = require("./HlsManifestListQueryParams");
@@ -43,8 +44,8 @@ var HlsApi = /** @class */ (function (_super) {
43
44
  return _this;
44
45
  }
45
46
  /**
46
- * @summary Create HLS Manifest
47
- * @param {HlsManifest} hlsManifest The HLS Manifest to be created
47
+ * @summary Create Custom HLS Manifest
48
+ * @param {HlsManifest} hlsManifest A Custom HLS Manifest gives you full control over its contents. Add Variant Streams and Media elements via the respective endpoints. If you need a simpler solution, create a Default Manifest instead. See TODO: link
48
49
  * @throws {BitmovinError}
49
50
  * @memberof HlsApi
50
51
  */
@@ -55,7 +56,7 @@ var HlsApi = /** @class */ (function (_super) {
55
56
  };
56
57
  /**
57
58
  * @summary Delete HLS Manifest
58
- * @param {string} manifestId Id of the hls manifest.
59
+ * @param {string} manifestId Id of the HLS Manifest.
59
60
  * @throws {BitmovinError}
60
61
  * @memberof HlsApi
61
62
  */
@@ -69,7 +70,7 @@ var HlsApi = /** @class */ (function (_super) {
69
70
  };
70
71
  /**
71
72
  * @summary HLS Manifest Details
72
- * @param {string} manifestId Id of the hls manifest.
73
+ * @param {string} manifestId Id of the HLS Manifest.
73
74
  * @throws {BitmovinError}
74
75
  * @memberof HlsApi
75
76
  */
@@ -81,6 +82,20 @@ var HlsApi = /** @class */ (function (_super) {
81
82
  return (0, Mapper_1.map)(response, HlsManifest_1.default);
82
83
  });
83
84
  };
85
+ /**
86
+ * @summary Manifest Start Details
87
+ * @param {string} manifestId ID of the manifest
88
+ * @throws {BitmovinError}
89
+ * @memberof HlsApi
90
+ */
91
+ HlsApi.prototype.getStartRequest = function (manifestId) {
92
+ var pathParamMap = {
93
+ manifest_id: manifestId
94
+ };
95
+ return this.restClient.get('/encoding/manifests/hls/{manifest_id}/start', pathParamMap).then(function (response) {
96
+ return (0, Mapper_1.map)(response, StartManifestRequest_1.default);
97
+ });
98
+ };
84
99
  /**
85
100
  * @summary List HLS Manifests
86
101
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -101,7 +116,7 @@ var HlsApi = /** @class */ (function (_super) {
101
116
  };
102
117
  /**
103
118
  * @summary Start HLS Manifest Creation
104
- * @param {string} manifestId Id of the HLS manifest.
119
+ * @param {string} manifestId Id of the HLS Manifest.
105
120
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
106
121
  * @throws {BitmovinError}
107
122
  * @memberof HlsApi
@@ -116,7 +131,7 @@ var HlsApi = /** @class */ (function (_super) {
116
131
  };
117
132
  /**
118
133
  * @summary HLS Manifest Creation Status
119
- * @param {string} manifestId Id of the HLS manifest.
134
+ * @param {string} manifestId Id of the HLS Manifest.
120
135
  * @throws {BitmovinError}
121
136
  * @memberof HlsApi
122
137
  */
@@ -130,7 +145,7 @@ var HlsApi = /** @class */ (function (_super) {
130
145
  };
131
146
  /**
132
147
  * @summary Stop HLS Manifest Creation
133
- * @param {string} manifestId Id of the HLS manifest.
148
+ * @param {string} manifestId Id of the HLS Manifest.
134
149
  * @throws {BitmovinError}
135
150
  * @memberof HlsApi
136
151
  */
@@ -10,8 +10,8 @@ import HlsManifestDefault from '../../../../models/HlsManifestDefault';
10
10
  export default class DefaultApi extends BaseAPI {
11
11
  constructor(configuration: Configuration);
12
12
  /**
13
- * @summary Create HLS Manifest Default
14
- * @param {HlsManifestDefault} hlsManifestDefault The HLS Manifest to be created
13
+ * @summary Create Default HLS Manifest
14
+ * @param {HlsManifestDefault} hlsManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest instead. See TODO: link
15
15
  * @throws {BitmovinError}
16
16
  * @memberof DefaultApi
17
17
  */
@@ -30,8 +30,8 @@ var DefaultApi = /** @class */ (function (_super) {
30
30
  return _super.call(this, configuration) || this;
31
31
  }
32
32
  /**
33
- * @summary Create HLS Manifest Default
34
- * @param {HlsManifestDefault} hlsManifestDefault The HLS Manifest to be created
33
+ * @summary Create Default HLS Manifest
34
+ * @param {HlsManifestDefault} hlsManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest instead. See TODO: link
35
35
  * @throws {BitmovinError}
36
36
  * @memberof DefaultApi
37
37
  */
@@ -24,25 +24,32 @@ export default class SmoothApi extends BaseAPI {
24
24
  constructor(configuration: Configuration);
25
25
  /**
26
26
  * @summary Create Smooth Streaming Manifest
27
- * @param {SmoothStreamingManifest} smoothStreamingManifest The Smooth Streaming Manifest to be created
27
+ * @param {SmoothStreamingManifest} smoothStreamingManifest A Custom Smooth Streaming Manifest gives you full control over its contents. Add Representations and Content Protections via the respective endpoints. If you need a simpler solution, create a Default Manifest instead. See TODO: link
28
28
  * @throws {BitmovinError}
29
29
  * @memberof SmoothApi
30
30
  */
31
31
  create(smoothStreamingManifest?: SmoothStreamingManifest): Promise<SmoothStreamingManifest>;
32
32
  /**
33
33
  * @summary Delete Smooth Streaming Manifest
34
- * @param {string} manifestId Id of the Smooth Streaming manifest.
34
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
35
35
  * @throws {BitmovinError}
36
36
  * @memberof SmoothApi
37
37
  */
38
38
  delete(manifestId: string): Promise<BitmovinResponse>;
39
39
  /**
40
40
  * @summary Smooth Streaming Manifest Details
41
- * @param {string} manifestId Id of the Smooth Streaming manifest.
41
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
42
42
  * @throws {BitmovinError}
43
43
  * @memberof SmoothApi
44
44
  */
45
45
  get(manifestId: string): Promise<SmoothStreamingManifest>;
46
+ /**
47
+ * @summary Manifest Start Details
48
+ * @param {string} manifestId Id of the manifest
49
+ * @throws {BitmovinError}
50
+ * @memberof SmoothApi
51
+ */
52
+ getStartRequest(manifestId: string): Promise<StartManifestRequest>;
46
53
  /**
47
54
  * @summary List Smooth Streaming Manifests
48
55
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -52,7 +59,7 @@ export default class SmoothApi extends BaseAPI {
52
59
  list(queryParameters?: SmoothStreamingManifestListQueryParams | ((q: SmoothStreamingManifestListQueryParamsBuilder) => SmoothStreamingManifestListQueryParamsBuilder)): Promise<PaginationResponse<SmoothStreamingManifest>>;
53
60
  /**
54
61
  * @summary Start Smooth Streaming Manifest Creation
55
- * @param {string} manifestId Id of the Smooth Streaming manifest.
62
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
56
63
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
57
64
  * @throws {BitmovinError}
58
65
  * @memberof SmoothApi
@@ -60,14 +67,14 @@ export default class SmoothApi extends BaseAPI {
60
67
  start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
61
68
  /**
62
69
  * @summary Smooth Streaming Manifest Creation Status
63
- * @param {string} manifestId Id of the Smooth Streaming manifest.
70
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
64
71
  * @throws {BitmovinError}
65
72
  * @memberof SmoothApi
66
73
  */
67
74
  status(manifestId: string): Promise<Task>;
68
75
  /**
69
76
  * @summary Stop Smooth Streaming Manifest Creation
70
- * @param {string} manifestId Id of the Smooth Streaming manifest.
77
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
71
78
  * @throws {BitmovinError}
72
79
  * @memberof SmoothApi
73
80
  */
@@ -23,6 +23,7 @@ var RepresentationsApi_1 = require("./representations/RepresentationsApi");
23
23
  var ContentprotectionApi_1 = require("./contentprotection/ContentprotectionApi");
24
24
  var BitmovinResponse_1 = require("../../../models/BitmovinResponse");
25
25
  var SmoothStreamingManifest_1 = require("../../../models/SmoothStreamingManifest");
26
+ var StartManifestRequest_1 = require("../../../models/StartManifestRequest");
26
27
  var Task_1 = require("../../../models/Task");
27
28
  var PaginationResponse_1 = require("../../../models/PaginationResponse");
28
29
  var SmoothStreamingManifestListQueryParams_1 = require("./SmoothStreamingManifestListQueryParams");
@@ -44,7 +45,7 @@ var SmoothApi = /** @class */ (function (_super) {
44
45
  }
45
46
  /**
46
47
  * @summary Create Smooth Streaming Manifest
47
- * @param {SmoothStreamingManifest} smoothStreamingManifest The Smooth Streaming Manifest to be created
48
+ * @param {SmoothStreamingManifest} smoothStreamingManifest A Custom Smooth Streaming Manifest gives you full control over its contents. Add Representations and Content Protections via the respective endpoints. If you need a simpler solution, create a Default Manifest instead. See TODO: link
48
49
  * @throws {BitmovinError}
49
50
  * @memberof SmoothApi
50
51
  */
@@ -55,7 +56,7 @@ var SmoothApi = /** @class */ (function (_super) {
55
56
  };
56
57
  /**
57
58
  * @summary Delete Smooth Streaming Manifest
58
- * @param {string} manifestId Id of the Smooth Streaming manifest.
59
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
59
60
  * @throws {BitmovinError}
60
61
  * @memberof SmoothApi
61
62
  */
@@ -69,7 +70,7 @@ var SmoothApi = /** @class */ (function (_super) {
69
70
  };
70
71
  /**
71
72
  * @summary Smooth Streaming Manifest Details
72
- * @param {string} manifestId Id of the Smooth Streaming manifest.
73
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
73
74
  * @throws {BitmovinError}
74
75
  * @memberof SmoothApi
75
76
  */
@@ -81,6 +82,20 @@ var SmoothApi = /** @class */ (function (_super) {
81
82
  return (0, Mapper_1.map)(response, SmoothStreamingManifest_1.default);
82
83
  });
83
84
  };
85
+ /**
86
+ * @summary Manifest Start Details
87
+ * @param {string} manifestId Id of the manifest
88
+ * @throws {BitmovinError}
89
+ * @memberof SmoothApi
90
+ */
91
+ SmoothApi.prototype.getStartRequest = function (manifestId) {
92
+ var pathParamMap = {
93
+ manifest_id: manifestId
94
+ };
95
+ return this.restClient.get('/encoding/manifests/smooth/{manifest_id}/start', pathParamMap).then(function (response) {
96
+ return (0, Mapper_1.map)(response, StartManifestRequest_1.default);
97
+ });
98
+ };
84
99
  /**
85
100
  * @summary List Smooth Streaming Manifests
86
101
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
@@ -101,7 +116,7 @@ var SmoothApi = /** @class */ (function (_super) {
101
116
  };
102
117
  /**
103
118
  * @summary Start Smooth Streaming Manifest Creation
104
- * @param {string} manifestId Id of the Smooth Streaming manifest.
119
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
105
120
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
106
121
  * @throws {BitmovinError}
107
122
  * @memberof SmoothApi
@@ -116,7 +131,7 @@ var SmoothApi = /** @class */ (function (_super) {
116
131
  };
117
132
  /**
118
133
  * @summary Smooth Streaming Manifest Creation Status
119
- * @param {string} manifestId Id of the Smooth Streaming manifest.
134
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
120
135
  * @throws {BitmovinError}
121
136
  * @memberof SmoothApi
122
137
  */
@@ -130,7 +145,7 @@ var SmoothApi = /** @class */ (function (_super) {
130
145
  };
131
146
  /**
132
147
  * @summary Stop Smooth Streaming Manifest Creation
133
- * @param {string} manifestId Id of the Smooth Streaming manifest.
148
+ * @param {string} manifestId Id of the Smooth Streaming Manifest.
134
149
  * @throws {BitmovinError}
135
150
  * @memberof SmoothApi
136
151
  */
@@ -10,8 +10,8 @@ import SmoothManifestDefault from '../../../../models/SmoothManifestDefault';
10
10
  export default class DefaultApi extends BaseAPI {
11
11
  constructor(configuration: Configuration);
12
12
  /**
13
- * @summary Create Smooth Streaming Manifest Default
14
- * @param {SmoothManifestDefault} smoothManifestDefault The Smooth Streaming Default Manifest to be created
13
+ * @summary Create Default Smooth Streaming Manifest
14
+ * @param {SmoothManifestDefault} smoothManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest instead. See TODO: link
15
15
  * @throws {BitmovinError}
16
16
  * @memberof DefaultApi
17
17
  */
@@ -30,8 +30,8 @@ var DefaultApi = /** @class */ (function (_super) {
30
30
  return _super.call(this, configuration) || this;
31
31
  }
32
32
  /**
33
- * @summary Create Smooth Streaming Manifest Default
34
- * @param {SmoothManifestDefault} smoothManifestDefault The Smooth Streaming Default Manifest to be created
33
+ * @summary Create Default Smooth Streaming Manifest
34
+ * @param {SmoothManifestDefault} smoothManifestDefault A Default Manifest is the easiest way to create a manifest file. Its contents will be configured automatically, depending on what output your encoding creates (muxings, thumbnails, sprites, subtitles, DRM information). If you need more control, create a Custom Manifest instead. See TODO: link
35
35
  * @throws {BitmovinError}
36
36
  * @memberof DefaultApi
37
37
  */
@@ -2,25 +2,24 @@ import DashManifest from './DashManifest';
2
2
  import DashManifestDefaultVersion from './DashManifestDefaultVersion';
3
3
  import DefaultDashManifestPeriod from './DefaultDashManifestPeriod';
4
4
  /**
5
- * V2 of the default dash manifest is an experimental feature and might be subject to change in the future.
6
5
  * @export
7
6
  * @class DashManifestDefault
8
7
  */
9
8
  export declare class DashManifestDefault extends DashManifest {
10
9
  /**
11
- * The id of the encoding to create a default manifest from. Required: encodingId or periods
10
+ * The id of the encoding to create a default manifest from. Either \"encodingId\" or \"periods\" is required.
12
11
  * @type {string}
13
12
  * @memberof DashManifestDefault
14
13
  */
15
14
  encodingId?: string;
16
15
  /**
17
- * The version of the default manifest generator
16
+ * Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the \"manifestGenerator\" version of the \"Start\" request.
18
17
  * @type {DashManifestDefaultVersion}
19
18
  * @memberof DashManifestDefault
20
19
  */
21
20
  version?: DashManifestDefaultVersion;
22
21
  /**
23
- * Adds a period for every item. Required: encodingId or periods
22
+ * Adds a period for every item. Either \"periods\" or \"encodingId\" is required.
24
23
  * @type {DefaultDashManifestPeriod[]}
25
24
  * @memberof DashManifestDefault
26
25
  */
@@ -20,7 +20,6 @@ var Mapper_1 = require("../common/Mapper");
20
20
  var DashManifest_1 = require("./DashManifest");
21
21
  var DefaultDashManifestPeriod_1 = require("./DefaultDashManifestPeriod");
22
22
  /**
23
- * V2 of the default dash manifest is an experimental feature and might be subject to change in the future.
24
23
  * @export
25
24
  * @class DashManifestDefault
26
25
  */
@@ -87,7 +87,7 @@ export declare class H265VideoConfiguration extends VideoConfiguration {
87
87
  */
88
88
  minBitrate?: number;
89
89
  /**
90
- * Specify the size of the VBV buffer (kbits)
90
+ * Size of the VBV buffer (kbits)
91
91
  * @type {number}
92
92
  * @memberof H265VideoConfiguration
93
93
  */
@@ -340,7 +340,7 @@ export declare class H265VideoConfiguration extends VideoConfiguration {
340
340
  */
341
341
  rateDistortionLevelForModeDecision?: number;
342
342
  /**
343
- * Specify the amount of rate-distortion analysis to use within quantization.
343
+ * Specifies the amount of rate-distortion analysis to use within quantization.
344
344
  * @type {RateDistortionLevelForQuantization}
345
345
  * @memberof H265VideoConfiguration
346
346
  */
@@ -12,7 +12,7 @@ export declare class HlsManifestDefault extends HlsManifest {
12
12
  */
13
13
  encodingId?: string;
14
14
  /**
15
- * The version of the default manifest generator
15
+ * Specifies the algorithm that determines which output of the given encoding is included into the manifest. Note that this is not related to the \"manifestGenerator\" version of the \"Start\" request.
16
16
  * @type {HlsManifestDefaultVersion}
17
17
  * @memberof HlsManifestDefault
18
18
  */
@@ -4,7 +4,7 @@
4
4
  */
5
5
  export declare class Scheduling {
6
6
  /**
7
- * Specify the priority of this encoding (0 - 100). Higher numbers mean higher priority. Default is 50.
7
+ * Specifies the priority of this encoding (0 - 100). Higher numbers mean higher priority. Default is 50.
8
8
  * @type {number}
9
9
  * @memberof Scheduling
10
10
  */