@bitmovin/api-sdk 1.165.0 → 1.167.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 (95) hide show
  1. package/README.md +1 -1
  2. package/dist/bitmovin-api-sdk.browser.js +149 -116
  3. package/dist/bitmovin-api-sdk.browser.min.js +1 -1
  4. package/dist/common/RestClient.js +1 -1
  5. package/dist/encoding/configurations/audio/ac3/Ac3Api.d.ts +4 -4
  6. package/dist/encoding/configurations/audio/ac3/Ac3Api.js +4 -4
  7. package/dist/encoding/configurations/audio/eac3/Eac3Api.d.ts +4 -4
  8. package/dist/encoding/configurations/audio/eac3/Eac3Api.js +4 -4
  9. package/dist/encoding/encodings/EncodingListQueryParams.d.ts +4 -4
  10. package/dist/encoding/encodings/EncodingListQueryParams.js +2 -2
  11. package/dist/encoding/encodings/live/insertableContent/InsertableContentApi.d.ts +2 -2
  12. package/dist/encoding/encodings/live/insertableContent/InsertableContentApi.js +2 -2
  13. package/dist/encoding/encodings/live/insertableContent/schedule/ScheduleApi.d.ts +1 -1
  14. package/dist/encoding/encodings/live/insertableContent/schedule/ScheduleApi.js +1 -1
  15. package/dist/encoding/encodings/live/insertableContent/scheduled/ScheduledApi.d.ts +1 -1
  16. package/dist/encoding/encodings/live/insertableContent/scheduled/ScheduledApi.js +1 -1
  17. package/dist/encoding/encodings/muxings/mp4/Mp4Api.d.ts +1 -1
  18. package/dist/encoding/encodings/muxings/mp4/Mp4Api.js +1 -1
  19. package/dist/encoding/encodings/streams/qc/psnr/PsnrApi.d.ts +1 -1
  20. package/dist/encoding/encodings/streams/qc/psnr/PsnrApi.js +1 -1
  21. package/dist/encoding/encodings/transferRetries/TransferRetriesApi.d.ts +1 -1
  22. package/dist/encoding/encodings/transferRetries/TransferRetriesApi.js +1 -1
  23. package/dist/encoding/filters/conform/ConformApi.d.ts +1 -1
  24. package/dist/encoding/filters/conform/ConformApi.js +1 -1
  25. package/dist/encoding/manifests/dash/DashApi.d.ts +1 -1
  26. package/dist/encoding/manifests/dash/DashApi.js +1 -1
  27. package/dist/encoding/manifests/dash/default/DefaultApi.d.ts +1 -1
  28. package/dist/encoding/manifests/dash/default/DefaultApi.js +1 -1
  29. package/dist/encoding/manifests/hls/HlsApi.d.ts +1 -1
  30. package/dist/encoding/manifests/hls/HlsApi.js +1 -1
  31. package/dist/encoding/manifests/hls/default/DefaultApi.d.ts +1 -1
  32. package/dist/encoding/manifests/hls/default/DefaultApi.js +1 -1
  33. package/dist/encoding/manifests/smooth/SmoothApi.d.ts +1 -1
  34. package/dist/encoding/manifests/smooth/SmoothApi.js +1 -1
  35. package/dist/encoding/manifests/smooth/default/DefaultApi.d.ts +1 -1
  36. package/dist/encoding/manifests/smooth/default/DefaultApi.js +1 -1
  37. package/dist/encoding/simple/jobs/live/LiveApi.d.ts +1 -1
  38. package/dist/encoding/simple/jobs/live/LiveApi.js +1 -1
  39. package/dist/encoding/simple/jobs/vod/VodApi.d.ts +1 -1
  40. package/dist/encoding/simple/jobs/vod/VodApi.js +1 -1
  41. package/dist/models/AnalyticsLicense.d.ts +7 -1
  42. package/dist/models/AnalyticsLicense.js +1 -0
  43. package/dist/models/AnalyticsVirtualLicense.d.ts +6 -0
  44. package/dist/models/AnalyticsVirtualLicense.js +1 -0
  45. package/dist/models/Encoding.d.ts +8 -1
  46. package/dist/models/Encoding.js +1 -0
  47. package/dist/models/LiveOptionsType.d.ts +8 -0
  48. package/dist/models/LiveOptionsType.js +12 -0
  49. package/dist/models/Mp4Muxing.d.ts +1 -1
  50. package/dist/models/PresetConfiguration.d.ts +2 -1
  51. package/dist/models/PresetConfiguration.js +1 -0
  52. package/dist/models/PrewarmedEncoderPool.d.ts +6 -0
  53. package/dist/models/PrewarmedEncoderPool.js +1 -0
  54. package/dist/models/SpekeDrmProvider.d.ts +6 -0
  55. package/dist/models/SpekeDrmProvider.js +1 -0
  56. package/dist/models/StartEncodingRequest.d.ts +1 -1
  57. package/dist/models/StartLiveEncodingRequest.d.ts +1 -1
  58. package/dist/models/Stream.d.ts +1 -1
  59. package/dist/models/StreamsContentProtectionResponse.d.ts +6 -0
  60. package/dist/models/StreamsContentProtectionResponse.js +1 -0
  61. package/dist/models/StreamsLiveCreateRequest.d.ts +2 -2
  62. package/dist/models/StreamsLiveCreateRequest.js +1 -1
  63. package/dist/models/StreamsLiveResponse.d.ts +3 -3
  64. package/dist/models/StreamsLiveResponse.js +2 -2
  65. package/dist/models/StreamsLiveUpdateRequest.d.ts +8 -2
  66. package/dist/models/StreamsLiveUpdateRequest.js +2 -1
  67. package/dist/models/{StreamsConfigPlayerStyle.d.ts → StreamsStyleConfigPlayerStyle.d.ts} +11 -11
  68. package/dist/models/{StreamsConfigPlayerStyle.js → StreamsStyleConfigPlayerStyle.js} +7 -7
  69. package/dist/models/StreamsStyleConfigResponse.d.ts +38 -0
  70. package/dist/models/{StreamsConfigResponse.js → StreamsStyleConfigResponse.js} +9 -9
  71. package/dist/models/StreamsVideoCreateRequest.d.ts +2 -2
  72. package/dist/models/StreamsVideoCreateRequest.js +1 -1
  73. package/dist/models/StreamsVideoResponse.d.ts +3 -3
  74. package/dist/models/StreamsVideoResponse.js +2 -2
  75. package/dist/models/StreamsVideoUpdateRequest.d.ts +8 -2
  76. package/dist/models/StreamsVideoUpdateRequest.js +2 -1
  77. package/dist/models/VideoConfiguration.d.ts +1 -1
  78. package/dist/models/index.d.ts +3 -2
  79. package/dist/models/index.js +3 -2
  80. package/dist/notifications/webhooks/encoding/encodings/error/ErrorApi.d.ts +1 -1
  81. package/dist/notifications/webhooks/encoding/encodings/error/ErrorApi.js +1 -1
  82. package/dist/notifications/webhooks/encoding/encodings/finished/FinishedApi.d.ts +1 -1
  83. package/dist/notifications/webhooks/encoding/encodings/finished/FinishedApi.js +1 -1
  84. package/dist/notifications/webhooks/encoding/encodings/transferError/TransferErrorApi.d.ts +1 -1
  85. package/dist/notifications/webhooks/encoding/encodings/transferError/TransferErrorApi.js +1 -1
  86. package/dist/notifications/webhooks/encoding/manifest/error/ErrorApi.d.ts +1 -1
  87. package/dist/notifications/webhooks/encoding/manifest/error/ErrorApi.js +1 -1
  88. package/dist/notifications/webhooks/encoding/manifest/finished/FinishedApi.d.ts +1 -1
  89. package/dist/notifications/webhooks/encoding/manifest/finished/FinishedApi.js +1 -1
  90. package/dist/streams/live/LiveApi.d.ts +1 -1
  91. package/dist/streams/live/LiveApi.js +1 -1
  92. package/dist/streams/video/VideoApi.d.ts +1 -1
  93. package/dist/streams/video/VideoApi.js +1 -1
  94. package/package.json +1 -1
  95. package/dist/models/StreamsConfigResponse.d.ts +0 -38
@@ -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.165.0',
243
+ 'X-Api-Client-Version': '1.167.0',
244
244
  'Content-Type': 'application/json'
245
245
  };
246
246
  if (tenantOrgId) {
@@ -15,28 +15,28 @@ export default class Ac3Api extends BaseAPI {
15
15
  customdata: CustomdataApi;
16
16
  constructor(configuration: Configuration);
17
17
  /**
18
- * @summary Create AC3 Codec Configuration. Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
18
+ * @summary Create AC3 Codec Configuration
19
19
  * @param {Ac3AudioConfiguration} ac3AudioConfiguration The AC3 Codec Configuration to be created
20
20
  * @throws {BitmovinError}
21
21
  * @memberof Ac3Api
22
22
  */
23
23
  create(ac3AudioConfiguration?: Ac3AudioConfiguration): Promise<Ac3AudioConfiguration>;
24
24
  /**
25
- * @summary Delete AC3 Codec Configuration. Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
25
+ * @summary Delete AC3 Codec Configuration
26
26
  * @param {string} configurationId Id of the codec configuration
27
27
  * @throws {BitmovinError}
28
28
  * @memberof Ac3Api
29
29
  */
30
30
  delete(configurationId: string): Promise<BitmovinResponse>;
31
31
  /**
32
- * @summary AC3 Codec Configuration Details Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
32
+ * @summary AC3 Codec Configuration Details
33
33
  * @param {string} configurationId Id of the codec configuration
34
34
  * @throws {BitmovinError}
35
35
  * @memberof Ac3Api
36
36
  */
37
37
  get(configurationId: string): Promise<Ac3AudioConfiguration>;
38
38
  /**
39
- * @summary List AC3 Configurations. Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
39
+ * @summary List AC3 Configurations
40
40
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
41
41
  * @throws {BitmovinError}
42
42
  * @memberof Ac3Api
@@ -36,7 +36,7 @@ var Ac3Api = /** @class */ (function (_super) {
36
36
  return _this;
37
37
  }
38
38
  /**
39
- * @summary Create AC3 Codec Configuration. Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
39
+ * @summary Create AC3 Codec Configuration
40
40
  * @param {Ac3AudioConfiguration} ac3AudioConfiguration The AC3 Codec Configuration to be created
41
41
  * @throws {BitmovinError}
42
42
  * @memberof Ac3Api
@@ -47,7 +47,7 @@ var Ac3Api = /** @class */ (function (_super) {
47
47
  });
48
48
  };
49
49
  /**
50
- * @summary Delete AC3 Codec Configuration. Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
50
+ * @summary Delete AC3 Codec Configuration
51
51
  * @param {string} configurationId Id of the codec configuration
52
52
  * @throws {BitmovinError}
53
53
  * @memberof Ac3Api
@@ -61,7 +61,7 @@ var Ac3Api = /** @class */ (function (_super) {
61
61
  });
62
62
  };
63
63
  /**
64
- * @summary AC3 Codec Configuration Details Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
64
+ * @summary AC3 Codec Configuration Details
65
65
  * @param {string} configurationId Id of the codec configuration
66
66
  * @throws {BitmovinError}
67
67
  * @memberof Ac3Api
@@ -75,7 +75,7 @@ var Ac3Api = /** @class */ (function (_super) {
75
75
  });
76
76
  };
77
77
  /**
78
- * @summary List AC3 Configurations. Deprecation notice: use Dolby Digital instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
78
+ * @summary List AC3 Configurations
79
79
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
80
80
  * @throws {BitmovinError}
81
81
  * @memberof Ac3Api
@@ -15,28 +15,28 @@ export default class Eac3Api extends BaseAPI {
15
15
  customdata: CustomdataApi;
16
16
  constructor(configuration: Configuration);
17
17
  /**
18
- * @summary Create E-AC3 Codec Configuration. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
18
+ * @summary Create E-AC3 Codec Configuration
19
19
  * @param {Eac3AudioConfiguration} eac3AudioConfiguration The E-AC3 Codec Configuration to be created
20
20
  * @throws {BitmovinError}
21
21
  * @memberof Eac3Api
22
22
  */
23
23
  create(eac3AudioConfiguration?: Eac3AudioConfiguration): Promise<Eac3AudioConfiguration>;
24
24
  /**
25
- * @summary Delete E-AC3 Codec Configuration. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
25
+ * @summary Delete E-AC3 Codec Configuration
26
26
  * @param {string} configurationId Id of the codec configuration
27
27
  * @throws {BitmovinError}
28
28
  * @memberof Eac3Api
29
29
  */
30
30
  delete(configurationId: string): Promise<BitmovinResponse>;
31
31
  /**
32
- * @summary E-AC3 Codec Configuration Details. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
32
+ * @summary E-AC3 Codec Configuration Details
33
33
  * @param {string} configurationId Id of the codec configuration
34
34
  * @throws {BitmovinError}
35
35
  * @memberof Eac3Api
36
36
  */
37
37
  get(configurationId: string): Promise<Eac3AudioConfiguration>;
38
38
  /**
39
- * @summary List E-AC3 Configurations. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
39
+ * @summary List E-AC3 Configurations
40
40
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
41
41
  * @throws {BitmovinError}
42
42
  * @memberof Eac3Api
@@ -36,7 +36,7 @@ var Eac3Api = /** @class */ (function (_super) {
36
36
  return _this;
37
37
  }
38
38
  /**
39
- * @summary Create E-AC3 Codec Configuration. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
39
+ * @summary Create E-AC3 Codec Configuration
40
40
  * @param {Eac3AudioConfiguration} eac3AudioConfiguration The E-AC3 Codec Configuration to be created
41
41
  * @throws {BitmovinError}
42
42
  * @memberof Eac3Api
@@ -47,7 +47,7 @@ var Eac3Api = /** @class */ (function (_super) {
47
47
  });
48
48
  };
49
49
  /**
50
- * @summary Delete E-AC3 Codec Configuration. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
50
+ * @summary Delete E-AC3 Codec Configuration
51
51
  * @param {string} configurationId Id of the codec configuration
52
52
  * @throws {BitmovinError}
53
53
  * @memberof Eac3Api
@@ -61,7 +61,7 @@ var Eac3Api = /** @class */ (function (_super) {
61
61
  });
62
62
  };
63
63
  /**
64
- * @summary E-AC3 Codec Configuration Details. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
64
+ * @summary E-AC3 Codec Configuration Details
65
65
  * @param {string} configurationId Id of the codec configuration
66
66
  * @throws {BitmovinError}
67
67
  * @memberof Eac3Api
@@ -75,7 +75,7 @@ var Eac3Api = /** @class */ (function (_super) {
75
75
  });
76
76
  };
77
77
  /**
78
- * @summary List E-AC3 Configurations. Deprecation notice: use Dolby Digital Plus instead. For more information check out our tutorial here: https://bitmovin.com/docs/encoding/tutorials/how-to-create-dolby-digital-plus-encodings
78
+ * @summary List E-AC3 Configurations
79
79
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
80
80
  * @throws {BitmovinError}
81
81
  * @memberof Eac3Api
@@ -14,13 +14,13 @@ export interface EncodingListQueryParams {
14
14
  */
15
15
  limit?: number | undefined;
16
16
  /**
17
- * A boolean indicating whether the total count should be returned as well. Default is true
17
+ * A boolean indicating whether the total count should be returned as well. Default is false. Setting this flag to true is discouraged.
18
18
  * @type {boolean}
19
19
  * @memberof EncodingListQueryParams
20
20
  */
21
21
  includeTotalCount?: boolean | undefined;
22
22
  /**
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`
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`
24
24
  * @type {string}
25
25
  * @memberof EncodingListQueryParams
26
26
  */
@@ -130,12 +130,12 @@ export declare class EncodingListQueryParamsBuilder {
130
130
  limit(limit: number): this;
131
131
  /**
132
132
  *
133
- * @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is true
133
+ * @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is false. Setting this flag to true is discouraged.
134
134
  */
135
135
  includeTotalCount(includeTotalCount: boolean): this;
136
136
  /**
137
137
  *
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`
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`
139
139
  */
140
140
  sort(sort: string): this;
141
141
  /**
@@ -23,7 +23,7 @@ var EncodingListQueryParamsBuilder = /** @class */ (function () {
23
23
  };
24
24
  /**
25
25
  *
26
- * @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is true
26
+ * @param includeTotalCount A boolean indicating whether the total count should be returned as well. Default is false. Setting this flag to true is discouraged.
27
27
  */
28
28
  EncodingListQueryParamsBuilder.prototype.includeTotalCount = function (includeTotalCount) {
29
29
  this.internalParams.includeTotalCount = includeTotalCount;
@@ -31,7 +31,7 @@ var EncodingListQueryParamsBuilder = /** @class */ (function () {
31
31
  };
32
32
  /**
33
33
  *
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`
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`
35
35
  */
36
36
  EncodingListQueryParamsBuilder.prototype.sort = function (sort) {
37
37
  this.internalParams.sort = sort;
@@ -18,7 +18,7 @@ export default class InsertableContentApi extends BaseAPI {
18
18
  stop: StopApi;
19
19
  constructor(configuration: Configuration);
20
20
  /**
21
- * @summary Make Insertable Content Available For A Live Encoding
21
+ * @summary Create Insertable Content
22
22
  * @param {string} encodingId Id of the encoding.
23
23
  * @param {InsertableContent} insertableContent The insertable content to be created
24
24
  * @throws {BitmovinError}
@@ -26,7 +26,7 @@ export default class InsertableContentApi extends BaseAPI {
26
26
  */
27
27
  create(encodingId: string, insertableContent?: InsertableContent): Promise<InsertableContent>;
28
28
  /**
29
- * @summary List All Insertable Content Available For A Live Encoding
29
+ * @summary List Insertable Content
30
30
  * @param {string} encodingId Id of the encoding.
31
31
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
32
32
  * @throws {BitmovinError}
@@ -39,7 +39,7 @@ var InsertableContentApi = /** @class */ (function (_super) {
39
39
  return _this;
40
40
  }
41
41
  /**
42
- * @summary Make Insertable Content Available For A Live Encoding
42
+ * @summary Create Insertable Content
43
43
  * @param {string} encodingId Id of the encoding.
44
44
  * @param {InsertableContent} insertableContent The insertable content to be created
45
45
  * @throws {BitmovinError}
@@ -54,7 +54,7 @@ var InsertableContentApi = /** @class */ (function (_super) {
54
54
  });
55
55
  };
56
56
  /**
57
- * @summary List All Insertable Content Available For A Live Encoding
57
+ * @summary List Insertable Content
58
58
  * @param {string} encodingId Id of the encoding.
59
59
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
60
60
  * @throws {BitmovinError}
@@ -11,7 +11,7 @@ import ScheduledInsertableContent from '../../../../../models/ScheduledInsertabl
11
11
  export default class ScheduleApi extends BaseAPI {
12
12
  constructor(configuration: Configuration);
13
13
  /**
14
- * @summary Schedule Insertable Content For a Live Encoding
14
+ * @summary Schedule Insertable Content
15
15
  * @param {string} encodingId Id of the encoding.
16
16
  * @param {string} contentId Id of the insertable content.
17
17
  * @param {ScheduledInsertableContent} scheduledInsertableContent The scheduled insertable content to be created
@@ -31,7 +31,7 @@ var ScheduleApi = /** @class */ (function (_super) {
31
31
  return _super.call(this, configuration) || this;
32
32
  }
33
33
  /**
34
- * @summary Schedule Insertable Content For a Live Encoding
34
+ * @summary Schedule Insertable Content
35
35
  * @param {string} encodingId Id of the encoding.
36
36
  * @param {string} contentId Id of the insertable content.
37
37
  * @param {ScheduledInsertableContent} scheduledInsertableContent The scheduled insertable content to be created
@@ -12,7 +12,7 @@ import { ScheduledInsertableContentListQueryParams, ScheduledInsertableContentLi
12
12
  export default class ScheduledApi extends BaseAPI {
13
13
  constructor(configuration: Configuration);
14
14
  /**
15
- * @summary List All Scheduled Insertable Content For A Live Encoding
15
+ * @summary List Scheduled Insertable Content
16
16
  * @param {string} encodingId Id of the encoding.
17
17
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
18
18
  * @throws {BitmovinError}
@@ -31,7 +31,7 @@ var ScheduledApi = /** @class */ (function (_super) {
31
31
  return _super.call(this, configuration) || this;
32
32
  }
33
33
  /**
34
- * @summary List All Scheduled Insertable Content For A Live Encoding
34
+ * @summary List Scheduled Insertable Content
35
35
  * @param {string} encodingId Id of the encoding.
36
36
  * @param {*} [queryParameters] query parameters for filtering, sorting and pagination
37
37
  * @throws {BitmovinError}
@@ -21,7 +21,7 @@ export default class Mp4Api extends BaseAPI {
21
21
  /**
22
22
  * @summary Add MP4 muxing
23
23
  * @param {string} encodingId Id of the encoding.
24
- * @param {Mp4Muxing} mp4Muxing The MP4 muxing to be created
24
+ * @param {Mp4Muxing} mp4Muxing The progressive MP4 muxing to be created
25
25
  * @throws {BitmovinError}
26
26
  * @memberof Mp4Api
27
27
  */
@@ -42,7 +42,7 @@ var Mp4Api = /** @class */ (function (_super) {
42
42
  /**
43
43
  * @summary Add MP4 muxing
44
44
  * @param {string} encodingId Id of the encoding.
45
- * @param {Mp4Muxing} mp4Muxing The MP4 muxing to be created
45
+ * @param {Mp4Muxing} mp4Muxing The progressive MP4 muxing to be created
46
46
  * @throws {BitmovinError}
47
47
  * @memberof Mp4Api
48
48
  */
@@ -13,7 +13,7 @@ import { PsnrQualityMetricListQueryParams, PsnrQualityMetricListQueryParamsBuild
13
13
  export default class PsnrApi extends BaseAPI {
14
14
  constructor(configuration: Configuration);
15
15
  /**
16
- * @summary Activate PSNR quality metrics for the selected stream
16
+ * @summary PSNR quality metrics
17
17
  * @param {string} encodingId Id of the encoding.
18
18
  * @param {string} streamId Id of the stream.
19
19
  * @throws {BitmovinError}
@@ -33,7 +33,7 @@ var PsnrApi = /** @class */ (function (_super) {
33
33
  return _super.call(this, configuration) || this;
34
34
  }
35
35
  /**
36
- * @summary Activate PSNR quality metrics for the selected stream
36
+ * @summary PSNR quality metrics
37
37
  * @param {string} encodingId Id of the encoding.
38
38
  * @param {string} streamId Id of the stream.
39
39
  * @throws {BitmovinError}
@@ -12,7 +12,7 @@ import { TransferRetryListQueryParams, TransferRetryListQueryParamsBuilder } fro
12
12
  export default class TransferRetriesApi extends BaseAPI {
13
13
  constructor(configuration: Configuration);
14
14
  /**
15
- * @summary Starts transfer retry. A transfer retry is only possible within 72 hours.
15
+ * @summary Transfer retry
16
16
  * @param {string} encodingId Id of the encoding.
17
17
  * @throws {BitmovinError}
18
18
  * @memberof TransferRetriesApi
@@ -32,7 +32,7 @@ var TransferRetriesApi = /** @class */ (function (_super) {
32
32
  return _super.call(this, configuration) || this;
33
33
  }
34
34
  /**
35
- * @summary Starts transfer retry. A transfer retry is only possible within 72 hours.
35
+ * @summary Transfer retry
36
36
  * @param {string} encodingId Id of the encoding.
37
37
  * @throws {BitmovinError}
38
38
  * @memberof TransferRetriesApi
@@ -15,7 +15,7 @@ export default class ConformApi extends BaseAPI {
15
15
  customdata: CustomdataApi;
16
16
  constructor(configuration: Configuration);
17
17
  /**
18
- * @summary Create Conform Filter. Keeps all the frames of the input. The playback time of the output will be slower or faster.
18
+ * @summary Create Conform Filter
19
19
  * @param {ConformFilter} conformFilter The Conform Filter to be created
20
20
  * @throws {BitmovinError}
21
21
  * @memberof ConformApi
@@ -36,7 +36,7 @@ var ConformApi = /** @class */ (function (_super) {
36
36
  return _this;
37
37
  }
38
38
  /**
39
- * @summary Create Conform Filter. Keeps all the frames of the input. The playback time of the output will be slower or faster.
39
+ * @summary Create Conform Filter
40
40
  * @param {ConformFilter} conformFilter The Conform Filter to be created
41
41
  * @throws {BitmovinError}
42
42
  * @memberof ConformApi
@@ -22,7 +22,7 @@ export default class DashApi extends BaseAPI {
22
22
  constructor(configuration: Configuration);
23
23
  /**
24
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
25
+ * @param {DashManifest} dashManifest The Custom DASH Manifest to be created.
26
26
  * @throws {BitmovinError}
27
27
  * @memberof DashApi
28
28
  */
@@ -43,7 +43,7 @@ var DashApi = /** @class */ (function (_super) {
43
43
  }
44
44
  /**
45
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
46
+ * @param {DashManifest} dashManifest The Custom DASH Manifest to be created.
47
47
  * @throws {BitmovinError}
48
48
  * @memberof DashApi
49
49
  */
@@ -11,7 +11,7 @@ export default class DefaultApi extends BaseAPI {
11
11
  constructor(configuration: Configuration);
12
12
  /**
13
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
14
+ * @param {DashManifestDefault} dashManifestDefault The Default DASH Manifest to be created.
15
15
  * @throws {BitmovinError}
16
16
  * @memberof DefaultApi
17
17
  */
@@ -31,7 +31,7 @@ var DefaultApi = /** @class */ (function (_super) {
31
31
  }
32
32
  /**
33
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
34
+ * @param {DashManifestDefault} dashManifestDefault The Default DASH Manifest to be created.
35
35
  * @throws {BitmovinError}
36
36
  * @memberof DefaultApi
37
37
  */
@@ -24,7 +24,7 @@ export default class HlsApi extends BaseAPI {
24
24
  constructor(configuration: Configuration);
25
25
  /**
26
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
27
+ * @param {HlsManifest} hlsManifest The Custom HLS Manifest to be created.
28
28
  * @throws {BitmovinError}
29
29
  * @memberof HlsApi
30
30
  */
@@ -45,7 +45,7 @@ var HlsApi = /** @class */ (function (_super) {
45
45
  }
46
46
  /**
47
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
48
+ * @param {HlsManifest} hlsManifest The Custom HLS Manifest to be created.
49
49
  * @throws {BitmovinError}
50
50
  * @memberof HlsApi
51
51
  */
@@ -11,7 +11,7 @@ export default class DefaultApi extends BaseAPI {
11
11
  constructor(configuration: Configuration);
12
12
  /**
13
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
14
+ * @param {HlsManifestDefault} hlsManifestDefault The Default HLS Manifest to be created.
15
15
  * @throws {BitmovinError}
16
16
  * @memberof DefaultApi
17
17
  */
@@ -31,7 +31,7 @@ var DefaultApi = /** @class */ (function (_super) {
31
31
  }
32
32
  /**
33
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
34
+ * @param {HlsManifestDefault} hlsManifestDefault The Default HLS Manifest to be created.
35
35
  * @throws {BitmovinError}
36
36
  * @memberof DefaultApi
37
37
  */
@@ -24,7 +24,7 @@ export default class SmoothApi extends BaseAPI {
24
24
  constructor(configuration: Configuration);
25
25
  /**
26
26
  * @summary Create Smooth Streaming Manifest
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
27
+ * @param {SmoothStreamingManifest} smoothStreamingManifest The Custom Smooth Streaming Manifest to be created.
28
28
  * @throws {BitmovinError}
29
29
  * @memberof SmoothApi
30
30
  */
@@ -45,7 +45,7 @@ var SmoothApi = /** @class */ (function (_super) {
45
45
  }
46
46
  /**
47
47
  * @summary Create Smooth Streaming Manifest
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
48
+ * @param {SmoothStreamingManifest} smoothStreamingManifest The Custom Smooth Streaming Manifest to be created.
49
49
  * @throws {BitmovinError}
50
50
  * @memberof SmoothApi
51
51
  */
@@ -11,7 +11,7 @@ export default class DefaultApi extends BaseAPI {
11
11
  constructor(configuration: Configuration);
12
12
  /**
13
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
14
+ * @param {SmoothManifestDefault} smoothManifestDefault The Default Smooth Streaming Manifest to be created.
15
15
  * @throws {BitmovinError}
16
16
  * @memberof DefaultApi
17
17
  */
@@ -31,7 +31,7 @@ var DefaultApi = /** @class */ (function (_super) {
31
31
  }
32
32
  /**
33
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 resource instead. See [documentation](https://developer.bitmovin.com/encoding/docs/default-vs-custom-manifest) page for a comparison
34
+ * @param {SmoothManifestDefault} smoothManifestDefault The Default Smooth Streaming Manifest to be created.
35
35
  * @throws {BitmovinError}
36
36
  * @memberof DefaultApi
37
37
  */
@@ -12,7 +12,7 @@ export default class LiveApi extends BaseAPI {
12
12
  constructor(configuration: Configuration);
13
13
  /**
14
14
  * @summary Create a Simple Encoding Live Job
15
- * @param {SimpleEncodingLiveJobRequest} simpleEncodingLiveJobRequest The Simple Encoding Live Job to be created. Check out our [Simple Encoding API Live Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api-live) for additional information about the Simple Encoding API Live.
15
+ * @param {SimpleEncodingLiveJobRequest} simpleEncodingLiveJobRequest The Simple Encoding Live Job to be created.
16
16
  * @throws {BitmovinError}
17
17
  * @memberof LiveApi
18
18
  */
@@ -31,7 +31,7 @@ var LiveApi = /** @class */ (function (_super) {
31
31
  }
32
32
  /**
33
33
  * @summary Create a Simple Encoding Live Job
34
- * @param {SimpleEncodingLiveJobRequest} simpleEncodingLiveJobRequest The Simple Encoding Live Job to be created. Check out our [Simple Encoding API Live Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api-live) for additional information about the Simple Encoding API Live.
34
+ * @param {SimpleEncodingLiveJobRequest} simpleEncodingLiveJobRequest The Simple Encoding Live Job to be created.
35
35
  * @throws {BitmovinError}
36
36
  * @memberof LiveApi
37
37
  */
@@ -14,7 +14,7 @@ export default class VodApi extends BaseAPI {
14
14
  constructor(configuration: Configuration);
15
15
  /**
16
16
  * @summary Create a Simple Encoding VOD Job
17
- * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created. Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
17
+ * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created.
18
18
  * @throws {BitmovinError}
19
19
  * @memberof VodApi
20
20
  */
@@ -33,7 +33,7 @@ var VodApi = /** @class */ (function (_super) {
33
33
  }
34
34
  /**
35
35
  * @summary Create a Simple Encoding VOD Job
36
- * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created. Check out our [Simple Encoding API Documentation](https://bitmovin.com/docs/encoding/articles/simple-encoding-api) for additional information about the Simple Encoding API.
36
+ * @param {SimpleEncodingVodJobRequest} simpleEncodingVodJobRequest The Simple Encoding VOD Job to be created.
37
37
  * @throws {BitmovinError}
38
38
  * @memberof VodApi
39
39
  */
@@ -13,7 +13,7 @@ export declare class AnalyticsLicense {
13
13
  */
14
14
  id?: string;
15
15
  /**
16
- * Creation date of the Analytics License in UTC format
16
+ * Creation date of the Analytics License, returned as ISO 8601 date-time format
17
17
  * @type {Date}
18
18
  * @memberof AnalyticsLicense
19
19
  */
@@ -121,6 +121,12 @@ export declare class AnalyticsLicense {
121
121
  * @memberof AnalyticsLicense
122
122
  */
123
123
  features?: AnalyticsLicenseFeatures;
124
+ /**
125
+ * The expiration date of the license if applicable, returned as ISO 8601 date-time format
126
+ * @type {Date}
127
+ * @memberof AnalyticsLicense
128
+ */
129
+ planExpiredAt?: Date;
124
130
  constructor(obj?: Partial<AnalyticsLicense>);
125
131
  }
126
132
  export default AnalyticsLicense;
@@ -33,6 +33,7 @@ var AnalyticsLicense = /** @class */ (function () {
33
33
  this.orderIndex = (0, Mapper_1.map)(obj.orderIndex);
34
34
  this.rateLimit = (0, Mapper_1.map)(obj.rateLimit);
35
35
  this.features = (0, Mapper_1.map)(obj.features, AnalyticsLicenseFeatures_1.default);
36
+ this.planExpiredAt = (0, Mapper_1.map)(obj.planExpiredAt, Date);
36
37
  }
37
38
  return AnalyticsLicense;
38
39
  }());
@@ -47,6 +47,12 @@ export declare class AnalyticsVirtualLicense {
47
47
  * @memberof AnalyticsVirtualLicense
48
48
  */
49
49
  customDataFieldLabels?: AnalyticsLicenseCustomDataFieldLabels;
50
+ /**
51
+ * The expiration date of the license if applicable, returned as ISO 8601 date-time format
52
+ * @type {Date}
53
+ * @memberof AnalyticsVirtualLicense
54
+ */
55
+ planExpiredAt?: Date;
50
56
  constructor(obj?: Partial<AnalyticsVirtualLicense>);
51
57
  }
52
58
  export default AnalyticsVirtualLicense;
@@ -20,6 +20,7 @@ var AnalyticsVirtualLicense = /** @class */ (function () {
20
20
  this.licenses = (0, Mapper_1.mapArray)(obj.licenses, AnalyticsVirtualLicenseLicensesListItem_1.default);
21
21
  this.customDataFieldsCount = (0, Mapper_1.map)(obj.customDataFieldsCount);
22
22
  this.customDataFieldLabels = (0, Mapper_1.map)(obj.customDataFieldLabels, AnalyticsLicenseCustomDataFieldLabels_1.default);
23
+ this.planExpiredAt = (0, Mapper_1.map)(obj.planExpiredAt, Date);
23
24
  }
24
25
  return AnalyticsVirtualLicense;
25
26
  }());
@@ -3,6 +3,7 @@ import CloudRegion from './CloudRegion';
3
3
  import EncodingMode from './EncodingMode';
4
4
  import EncodingType from './EncodingType';
5
5
  import InfrastructureSettings from './InfrastructureSettings';
6
+ import LiveOptionsType from './LiveOptionsType';
6
7
  import Status from './Status';
7
8
  /**
8
9
  * @export
@@ -86,7 +87,7 @@ export declare class Encoding extends BitmovinResource {
86
87
  */
87
88
  selectedEncoderVersion?: string;
88
89
  /**
89
- * After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when starting an encoding with encoding mode STANDARD.
90
+ * After the encoding has been started, this will contain the encoding mode that was actually used. Especially useful when `encodingMode` was not set explicitly or set to STANDARD (which translates to one of the other possible values on encoding start).
90
91
  * @type {EncodingMode}
91
92
  * @memberof Encoding
92
93
  */
@@ -109,6 +110,12 @@ export declare class Encoding extends BitmovinResource {
109
110
  * @memberof Encoding
110
111
  */
111
112
  labels?: string[];
113
+ /**
114
+ * The chosen live option type of the live encoding
115
+ * @type {LiveOptionsType}
116
+ * @memberof Encoding
117
+ */
118
+ liveOptionsType?: LiveOptionsType;
112
119
  constructor(obj?: Partial<Encoding>);
113
120
  }
114
121
  export default Encoding;