@bitmovin/api-sdk 1.163.0 → 1.165.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 (41) hide show
  1. package/README.md +1 -1
  2. package/dist/bitmovin-api-sdk.browser.js +97 -21
  3. package/dist/bitmovin-api-sdk.browser.min.js +1 -1
  4. package/dist/common/RestClient.js +2 -2
  5. package/dist/encoding/encodings/EncodingsApi.d.ts +1 -1
  6. package/dist/encoding/encodings/EncodingsApi.js +1 -1
  7. package/dist/encoding/manifests/dash/DashApi.d.ts +4 -4
  8. package/dist/encoding/manifests/dash/DashApi.js +4 -4
  9. package/dist/encoding/manifests/dash/default/DefaultApi.d.ts +1 -1
  10. package/dist/encoding/manifests/dash/default/DefaultApi.js +1 -1
  11. package/dist/encoding/manifests/hls/HlsApi.d.ts +4 -4
  12. package/dist/encoding/manifests/hls/HlsApi.js +4 -4
  13. package/dist/encoding/manifests/hls/default/DefaultApi.d.ts +1 -1
  14. package/dist/encoding/manifests/hls/default/DefaultApi.js +1 -1
  15. package/dist/encoding/manifests/smooth/SmoothApi.d.ts +4 -4
  16. package/dist/encoding/manifests/smooth/SmoothApi.js +4 -4
  17. package/dist/encoding/manifests/smooth/default/DefaultApi.d.ts +1 -1
  18. package/dist/encoding/manifests/smooth/default/DefaultApi.js +1 -1
  19. package/dist/models/DashManifestDefault.d.ts +2 -2
  20. package/dist/models/HlsManifestDefault.d.ts +2 -2
  21. package/dist/models/SmoothManifestDefault.d.ts +2 -2
  22. package/dist/models/StartEncodingRequest.d.ts +6 -6
  23. package/dist/models/StartLiveEncodingRequest.d.ts +3 -3
  24. package/dist/models/StartManifestRequest.d.ts +1 -1
  25. package/dist/models/StreamsConfigPlayerStyle.d.ts +51 -0
  26. package/dist/models/StreamsConfigPlayerStyle.js +26 -0
  27. package/dist/models/StreamsConfigResponse.d.ts +3 -3
  28. package/dist/models/StreamsConfigResponse.js +2 -1
  29. package/dist/models/StreamsContentProtectionResponse.d.ts +26 -0
  30. package/dist/models/StreamsContentProtectionResponse.js +21 -0
  31. package/dist/models/StreamsLiveResponse.d.ts +6 -0
  32. package/dist/models/StreamsLiveResponse.js +2 -0
  33. package/dist/models/StreamsVideoResponse.d.ts +6 -0
  34. package/dist/models/StreamsVideoResponse.js +2 -0
  35. package/dist/models/index.d.ts +2 -0
  36. package/dist/models/index.js +2 -0
  37. package/dist/notifications/webhooks/encoding/manifest/error/ErrorApi.d.ts +1 -1
  38. package/dist/notifications/webhooks/encoding/manifest/error/ErrorApi.js +1 -1
  39. package/dist/notifications/webhooks/encoding/manifest/finished/FinishedApi.d.ts +1 -1
  40. package/dist/notifications/webhooks/encoding/manifest/finished/FinishedApi.js +1 -1
  41. package/package.json +1 -1
@@ -74,7 +74,7 @@ function queryParams(params) {
74
74
  var addSeperator = false;
75
75
  for (var _i = 0, _a = Object.keys(params); _i < _a.length; _i++) {
76
76
  var key = _a[_i];
77
- if (params[key] && typeof params[key] !== 'function') {
77
+ if (params[key] != null && typeof params[key] !== 'function' && params[key] !== "") {
78
78
  queryParameterString += (addSeperator ? '&' : '') + encodeURIComponent(key) + '=' + encodeURIComponent(prepareUrlParameterValue(params[key]));
79
79
  addSeperator = true;
80
80
  }
@@ -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.163.0',
243
+ 'X-Api-Client-Version': '1.165.0',
244
244
  'Content-Type': 'application/json'
245
245
  };
246
246
  if (tenantOrgId) {
@@ -88,7 +88,7 @@ export default class EncodingsApi extends BaseAPI {
88
88
  */
89
89
  reschedule(encodingId: string, rescheduleEncodingRequest?: RescheduleEncodingRequest): Promise<BitmovinResponse>;
90
90
  /**
91
- * @summary Start Encoding
91
+ * @summary Start VoD Encoding
92
92
  * @param {string} encodingId Id of the encoding
93
93
  * @param {StartEncodingRequest} [startEncodingRequest] Encoding Startup Options
94
94
  * @throws {BitmovinError}
@@ -157,7 +157,7 @@ var EncodingsApi = /** @class */ (function (_super) {
157
157
  });
158
158
  };
159
159
  /**
160
- * @summary Start Encoding
160
+ * @summary Start VoD Encoding
161
161
  * @param {string} encodingId Id of the encoding
162
162
  * @param {StartEncodingRequest} [startEncodingRequest] Encoding Startup Options
163
163
  * @throws {BitmovinError}
@@ -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 instead. See TODO: link
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
26
26
  * @throws {BitmovinError}
27
27
  * @memberof DashApi
28
28
  */
@@ -56,7 +56,7 @@ export default class DashApi extends BaseAPI {
56
56
  */
57
57
  list(queryParameters?: DashManifestListQueryParams | ((q: DashManifestListQueryParamsBuilder) => DashManifestListQueryParamsBuilder)): Promise<PaginationResponse<DashManifest>>;
58
58
  /**
59
- * @summary Start DASH Manifest Creation
59
+ * @summary Start DASH manifest generation
60
60
  * @param {string} manifestId Id of the DASH Manifest.
61
61
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
62
62
  * @throws {BitmovinError}
@@ -64,14 +64,14 @@ export default class DashApi extends BaseAPI {
64
64
  */
65
65
  start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
66
66
  /**
67
- * @summary DASH Manifest Creation Status
67
+ * @summary DASH manifest generation status
68
68
  * @param {string} manifestId Id of the DASH Manifest.
69
69
  * @throws {BitmovinError}
70
70
  * @memberof DashApi
71
71
  */
72
72
  status(manifestId: string): Promise<Task>;
73
73
  /**
74
- * @summary Stop DASH Manifest Creation
74
+ * @summary Stop DASH manifest generation
75
75
  * @param {string} manifestId Id of the DASH Manifest.
76
76
  * @throws {BitmovinError}
77
77
  * @memberof DashApi
@@ -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 instead. See TODO: link
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
47
47
  * @throws {BitmovinError}
48
48
  * @memberof DashApi
49
49
  */
@@ -113,7 +113,7 @@ var DashApi = /** @class */ (function (_super) {
113
113
  });
114
114
  };
115
115
  /**
116
- * @summary Start DASH Manifest Creation
116
+ * @summary Start DASH manifest generation
117
117
  * @param {string} manifestId Id of the DASH Manifest.
118
118
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
119
119
  * @throws {BitmovinError}
@@ -128,7 +128,7 @@ var DashApi = /** @class */ (function (_super) {
128
128
  });
129
129
  };
130
130
  /**
131
- * @summary DASH Manifest Creation Status
131
+ * @summary DASH manifest generation status
132
132
  * @param {string} manifestId Id of the DASH Manifest.
133
133
  * @throws {BitmovinError}
134
134
  * @memberof DashApi
@@ -142,7 +142,7 @@ var DashApi = /** @class */ (function (_super) {
142
142
  });
143
143
  };
144
144
  /**
145
- * @summary Stop DASH Manifest Creation
145
+ * @summary Stop DASH manifest generation
146
146
  * @param {string} manifestId Id of the DASH Manifest.
147
147
  * @throws {BitmovinError}
148
148
  * @memberof DashApi
@@ -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 instead. See TODO: link
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
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 instead. See TODO: link
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
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 instead. See TODO: link
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
28
28
  * @throws {BitmovinError}
29
29
  * @memberof HlsApi
30
30
  */
@@ -58,7 +58,7 @@ export default class HlsApi extends BaseAPI {
58
58
  */
59
59
  list(queryParameters?: HlsManifestListQueryParams | ((q: HlsManifestListQueryParamsBuilder) => HlsManifestListQueryParamsBuilder)): Promise<PaginationResponse<HlsManifest>>;
60
60
  /**
61
- * @summary Start HLS Manifest Creation
61
+ * @summary Start HLS manifest generation
62
62
  * @param {string} manifestId Id of the HLS Manifest.
63
63
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
64
64
  * @throws {BitmovinError}
@@ -66,14 +66,14 @@ export default class HlsApi extends BaseAPI {
66
66
  */
67
67
  start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
68
68
  /**
69
- * @summary HLS Manifest Creation Status
69
+ * @summary HLS manifest generation status
70
70
  * @param {string} manifestId Id of the HLS Manifest.
71
71
  * @throws {BitmovinError}
72
72
  * @memberof HlsApi
73
73
  */
74
74
  status(manifestId: string): Promise<Task>;
75
75
  /**
76
- * @summary Stop HLS Manifest Creation
76
+ * @summary Stop HLS manifest generation
77
77
  * @param {string} manifestId Id of the HLS Manifest.
78
78
  * @throws {BitmovinError}
79
79
  * @memberof HlsApi
@@ -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 instead. See TODO: link
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
49
49
  * @throws {BitmovinError}
50
50
  * @memberof HlsApi
51
51
  */
@@ -115,7 +115,7 @@ var HlsApi = /** @class */ (function (_super) {
115
115
  });
116
116
  };
117
117
  /**
118
- * @summary Start HLS Manifest Creation
118
+ * @summary Start HLS manifest generation
119
119
  * @param {string} manifestId Id of the HLS Manifest.
120
120
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
121
121
  * @throws {BitmovinError}
@@ -130,7 +130,7 @@ var HlsApi = /** @class */ (function (_super) {
130
130
  });
131
131
  };
132
132
  /**
133
- * @summary HLS Manifest Creation Status
133
+ * @summary HLS manifest generation status
134
134
  * @param {string} manifestId Id of the HLS Manifest.
135
135
  * @throws {BitmovinError}
136
136
  * @memberof HlsApi
@@ -144,7 +144,7 @@ var HlsApi = /** @class */ (function (_super) {
144
144
  });
145
145
  };
146
146
  /**
147
- * @summary Stop HLS Manifest Creation
147
+ * @summary Stop HLS manifest generation
148
148
  * @param {string} manifestId Id of the HLS Manifest.
149
149
  * @throws {BitmovinError}
150
150
  * @memberof HlsApi
@@ -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 instead. See TODO: link
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
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 instead. See TODO: link
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
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 instead. See TODO: link
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
28
28
  * @throws {BitmovinError}
29
29
  * @memberof SmoothApi
30
30
  */
@@ -58,7 +58,7 @@ export default class SmoothApi extends BaseAPI {
58
58
  */
59
59
  list(queryParameters?: SmoothStreamingManifestListQueryParams | ((q: SmoothStreamingManifestListQueryParamsBuilder) => SmoothStreamingManifestListQueryParamsBuilder)): Promise<PaginationResponse<SmoothStreamingManifest>>;
60
60
  /**
61
- * @summary Start Smooth Streaming Manifest Creation
61
+ * @summary Start Smooth Streaming manifest generation
62
62
  * @param {string} manifestId Id of the Smooth Streaming Manifest.
63
63
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
64
64
  * @throws {BitmovinError}
@@ -66,14 +66,14 @@ export default class SmoothApi extends BaseAPI {
66
66
  */
67
67
  start(manifestId: string, startManifestRequest?: StartManifestRequest): Promise<BitmovinResponse>;
68
68
  /**
69
- * @summary Smooth Streaming Manifest Creation Status
69
+ * @summary Smooth Streaming manifest generation status
70
70
  * @param {string} manifestId Id of the Smooth Streaming Manifest.
71
71
  * @throws {BitmovinError}
72
72
  * @memberof SmoothApi
73
73
  */
74
74
  status(manifestId: string): Promise<Task>;
75
75
  /**
76
- * @summary Stop Smooth Streaming Manifest Creation
76
+ * @summary Stop Smooth Streaming manifest generation
77
77
  * @param {string} manifestId Id of the Smooth Streaming Manifest.
78
78
  * @throws {BitmovinError}
79
79
  * @memberof SmoothApi
@@ -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 instead. See TODO: link
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
49
49
  * @throws {BitmovinError}
50
50
  * @memberof SmoothApi
51
51
  */
@@ -115,7 +115,7 @@ var SmoothApi = /** @class */ (function (_super) {
115
115
  });
116
116
  };
117
117
  /**
118
- * @summary Start Smooth Streaming Manifest Creation
118
+ * @summary Start Smooth Streaming manifest generation
119
119
  * @param {string} manifestId Id of the Smooth Streaming Manifest.
120
120
  * @param {StartManifestRequest} [startManifestRequest] Manifest Startup Options
121
121
  * @throws {BitmovinError}
@@ -130,7 +130,7 @@ var SmoothApi = /** @class */ (function (_super) {
130
130
  });
131
131
  };
132
132
  /**
133
- * @summary Smooth Streaming Manifest Creation Status
133
+ * @summary Smooth Streaming manifest generation status
134
134
  * @param {string} manifestId Id of the Smooth Streaming Manifest.
135
135
  * @throws {BitmovinError}
136
136
  * @memberof SmoothApi
@@ -144,7 +144,7 @@ var SmoothApi = /** @class */ (function (_super) {
144
144
  });
145
145
  };
146
146
  /**
147
- * @summary Stop Smooth Streaming Manifest Creation
147
+ * @summary Stop Smooth Streaming manifest generation
148
148
  * @param {string} manifestId Id of the Smooth Streaming Manifest.
149
149
  * @throws {BitmovinError}
150
150
  * @memberof SmoothApi
@@ -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 instead. See TODO: link
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
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 instead. See TODO: link
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
35
35
  * @throws {BitmovinError}
36
36
  * @memberof DefaultApi
37
37
  */
@@ -7,7 +7,7 @@ import DefaultDashManifestPeriod from './DefaultDashManifestPeriod';
7
7
  */
8
8
  export declare class DashManifestDefault extends DashManifest {
9
9
  /**
10
- * The id of the encoding to create a default manifest from. Either \"encodingId\" or \"periods\" is required.
10
+ * The id of the encoding to create a default manifest for. Either \"encodingId\" or \"periods\" is required.
11
11
  * @type {string}
12
12
  * @memberof DashManifestDefault
13
13
  */
@@ -19,7 +19,7 @@ export declare class DashManifestDefault extends DashManifest {
19
19
  */
20
20
  version?: DashManifestDefaultVersion;
21
21
  /**
22
- * Adds a period for every item. Either \"periods\" or \"encodingId\" is required.
22
+ * Adds a period for every item. Can only be used when setting \"version\" to \"V2\". Either \"periods\" or \"encodingId\" is required.
23
23
  * @type {DefaultDashManifestPeriod[]}
24
24
  * @memberof DashManifestDefault
25
25
  */
@@ -6,13 +6,13 @@ import HlsManifestDefaultVersion from './HlsManifestDefaultVersion';
6
6
  */
7
7
  export declare class HlsManifestDefault extends HlsManifest {
8
8
  /**
9
- * The id of the encoding to create a default manifest from. (required)
9
+ * The id of the encoding to create a default manifest for (required)
10
10
  * @type {string}
11
11
  * @memberof HlsManifestDefault
12
12
  */
13
13
  encodingId?: string;
14
14
  /**
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.
15
+ * Currently not in use
16
16
  * @type {HlsManifestDefaultVersion}
17
17
  * @memberof HlsManifestDefault
18
18
  */
@@ -6,13 +6,13 @@ import SmoothStreamingManifest from './SmoothStreamingManifest';
6
6
  */
7
7
  export declare class SmoothManifestDefault extends SmoothStreamingManifest {
8
8
  /**
9
- * The id of the encoding to create a default manifest from. (required)
9
+ * The id of the encoding to create a default manifest for (required)
10
10
  * @type {string}
11
11
  * @memberof SmoothManifestDefault
12
12
  */
13
13
  encodingId?: string;
14
14
  /**
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.
15
+ * Currently not in use
16
16
  * @type {SmoothManifestDefaultVersion}
17
17
  * @memberof SmoothManifestDefault
18
18
  */
@@ -41,37 +41,37 @@ export declare class StartEncodingRequest {
41
41
  */
42
42
  encodingMode?: EncodingMode;
43
43
  /**
44
- * List of preview DASH manifests to be created
44
+ * DASH manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
45
45
  * @type {ManifestResource[]}
46
46
  * @memberof StartEncodingRequest
47
47
  */
48
48
  previewDashManifests?: ManifestResource[];
49
49
  /**
50
- * List of preview HLS manifests to be created
50
+ * HLS manifests to be generated for previewing while the encoding is still running. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
51
51
  * @type {ManifestResource[]}
52
52
  * @memberof StartEncodingRequest
53
53
  */
54
54
  previewHlsManifests?: ManifestResource[];
55
55
  /**
56
- * List of VoD DASH manifests to be created after encoding finished successfully
56
+ * DASH manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
57
57
  * @type {ManifestResource[]}
58
58
  * @memberof StartEncodingRequest
59
59
  */
60
60
  vodDashManifests?: ManifestResource[];
61
61
  /**
62
- * List of VoD HLS manifests to be created after encoding finished successfully
62
+ * HLS manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
63
63
  * @type {ManifestResource[]}
64
64
  * @memberof StartEncodingRequest
65
65
  */
66
66
  vodHlsManifests?: ManifestResource[];
67
67
  /**
68
- * List of VoD SMOOTH manifests to be created after encoding finished successfully
68
+ * Smooth Streaming manifests to be generated right after encoding (just-in-time). See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
69
69
  * @type {ManifestResource[]}
70
70
  * @memberof StartEncodingRequest
71
71
  */
72
72
  vodSmoothManifests?: ManifestResource[];
73
73
  /**
74
- * Version of the manifest generation engine to be used
74
+ * Major version of the manifest generator to be used for manifests referenced in this request (by properties vodDashManifests, vodHlsManifests, vodSmoothManifests, previewDashManifests, previewHlsManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
75
75
  * @type {ManifestGenerator}
76
76
  * @memberof StartEncodingRequest
77
77
  */
@@ -17,13 +17,13 @@ export declare class StartLiveEncodingRequest {
17
17
  */
18
18
  streamKey?: string;
19
19
  /**
20
- * List of Hls manifests to use for this live encoding
20
+ * HLS manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
21
21
  * @type {LiveHlsManifest[]}
22
22
  * @memberof StartLiveEncodingRequest
23
23
  */
24
24
  hlsManifests?: LiveHlsManifest[];
25
25
  /**
26
- * List of Dash manifests to use for this live encoding
26
+ * DASH manifests to be generated during the encoding. See [documentation](https://developer.bitmovin.com/encoding/docs/how-to-create-manifests-for-your-encodings#just-in-time-jit)
27
27
  * @type {LiveDashManifest[]}
28
28
  * @memberof StartLiveEncodingRequest
29
29
  */
@@ -41,7 +41,7 @@ export declare class StartLiveEncodingRequest {
41
41
  */
42
42
  reuploadSettings?: ReuploadSettings;
43
43
  /**
44
- * Version of the manifest generation engine to be used
44
+ * Major version of the manifest generator to be used for manifests referenced in this request (by properties dashManifests, dashManifests). `V2` is available for encoder versions 2.70.0 and above and is the recommended option. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
45
45
  * @type {ManifestGenerator}
46
46
  * @memberof StartLiveEncodingRequest
47
47
  */
@@ -5,7 +5,7 @@ import ManifestGenerator from './ManifestGenerator';
5
5
  */
6
6
  export declare class StartManifestRequest {
7
7
  /**
8
- * Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions: 2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization.
8
+ * Major version of the manifest generator to be used. `V2` is the recommended option and requires the following minimum encoder versions: 2.121.0 for DASH, 2.111.0 for HLS, 2.108.0 for SMOOTH. The default value depends on the sign-up date of your organization. See [documentation](https://developer.bitmovin.com/encoding/docs/manifest-generator-v2) page for a detailed explanation.
9
9
  * @type {ManifestGenerator}
10
10
  * @memberof StartManifestRequest
11
11
  */
@@ -0,0 +1,51 @@
1
+ /**
2
+ * Player style config
3
+ * @export
4
+ * @class StreamsConfigPlayerStyle
5
+ */
6
+ export declare class StreamsConfigPlayerStyle {
7
+ /**
8
+ * Playback marker background color
9
+ * @type {string}
10
+ * @memberof StreamsConfigPlayerStyle
11
+ */
12
+ playbackMarkerBgColor?: string;
13
+ /**
14
+ * Playback marker border color
15
+ * @type {string}
16
+ * @memberof StreamsConfigPlayerStyle
17
+ */
18
+ playbackMarkerBorderColor?: string;
19
+ /**
20
+ * Playback track played color
21
+ * @type {string}
22
+ * @memberof StreamsConfigPlayerStyle
23
+ */
24
+ playbackTrackPlayedColor?: string;
25
+ /**
26
+ * Playback track buffered color
27
+ * @type {string}
28
+ * @memberof StreamsConfigPlayerStyle
29
+ */
30
+ playbackTrackBufferedColor?: string;
31
+ /**
32
+ * Playback track background color
33
+ * @type {string}
34
+ * @memberof StreamsConfigPlayerStyle
35
+ */
36
+ playbackTrackBgColor?: string;
37
+ /**
38
+ * Text color
39
+ * @type {string}
40
+ * @memberof StreamsConfigPlayerStyle
41
+ */
42
+ textColor?: string;
43
+ /**
44
+ * Background color
45
+ * @type {string}
46
+ * @memberof StreamsConfigPlayerStyle
47
+ */
48
+ backgroundColor?: string;
49
+ constructor(obj?: Partial<StreamsConfigPlayerStyle>);
50
+ }
51
+ export default StreamsConfigPlayerStyle;
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StreamsConfigPlayerStyle = void 0;
4
+ var Mapper_1 = require("../common/Mapper");
5
+ /**
6
+ * Player style config
7
+ * @export
8
+ * @class StreamsConfigPlayerStyle
9
+ */
10
+ var StreamsConfigPlayerStyle = /** @class */ (function () {
11
+ function StreamsConfigPlayerStyle(obj) {
12
+ if (!obj) {
13
+ return;
14
+ }
15
+ this.playbackMarkerBgColor = (0, Mapper_1.map)(obj.playbackMarkerBgColor);
16
+ this.playbackMarkerBorderColor = (0, Mapper_1.map)(obj.playbackMarkerBorderColor);
17
+ this.playbackTrackPlayedColor = (0, Mapper_1.map)(obj.playbackTrackPlayedColor);
18
+ this.playbackTrackBufferedColor = (0, Mapper_1.map)(obj.playbackTrackBufferedColor);
19
+ this.playbackTrackBgColor = (0, Mapper_1.map)(obj.playbackTrackBgColor);
20
+ this.textColor = (0, Mapper_1.map)(obj.textColor);
21
+ this.backgroundColor = (0, Mapper_1.map)(obj.backgroundColor);
22
+ }
23
+ return StreamsConfigPlayerStyle;
24
+ }());
25
+ exports.StreamsConfigPlayerStyle = StreamsConfigPlayerStyle;
26
+ exports.default = StreamsConfigPlayerStyle;
@@ -1,3 +1,4 @@
1
+ import StreamsConfigPlayerStyle from './StreamsConfigPlayerStyle';
1
2
  /**
2
3
  * @export
3
4
  * @class StreamsConfigResponse
@@ -16,11 +17,10 @@ export declare class StreamsConfigResponse {
16
17
  */
17
18
  orgId?: string;
18
19
  /**
19
- * Player style config
20
- * @type {any}
20
+ * @type {StreamsConfigPlayerStyle}
21
21
  * @memberof StreamsConfigResponse
22
22
  */
23
- playerStyle?: any;
23
+ playerStyle?: StreamsConfigPlayerStyle;
24
24
  /**
25
25
  * URL of the watermark image
26
26
  * @type {string}
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.StreamsConfigResponse = void 0;
4
4
  var Mapper_1 = require("../common/Mapper");
5
+ var StreamsConfigPlayerStyle_1 = require("./StreamsConfigPlayerStyle");
5
6
  /**
6
7
  * @export
7
8
  * @class StreamsConfigResponse
@@ -13,7 +14,7 @@ var StreamsConfigResponse = /** @class */ (function () {
13
14
  }
14
15
  this.id = (0, Mapper_1.map)(obj.id);
15
16
  this.orgId = (0, Mapper_1.map)(obj.orgId);
16
- this.playerStyle = (0, Mapper_1.map)(obj.playerStyle);
17
+ this.playerStyle = (0, Mapper_1.map)(obj.playerStyle, StreamsConfigPlayerStyle_1.default);
17
18
  this.watermarkUrl = (0, Mapper_1.map)(obj.watermarkUrl);
18
19
  this.watermarkTargetLink = (0, Mapper_1.map)(obj.watermarkTargetLink);
19
20
  }
@@ -0,0 +1,26 @@
1
+ /**
2
+ * @export
3
+ * @class StreamsContentProtectionResponse
4
+ */
5
+ export declare class StreamsContentProtectionResponse {
6
+ /**
7
+ * The identifier of the streams content protection entity
8
+ * @type {string}
9
+ * @memberof StreamsContentProtectionResponse
10
+ */
11
+ id?: string;
12
+ /**
13
+ * The list of allowed domains
14
+ * @type {string[]}
15
+ * @memberof StreamsContentProtectionResponse
16
+ */
17
+ allowedDomains?: string[];
18
+ /**
19
+ * Controls if requests to content protected streams without referer header should be allowed or denied
20
+ * @type {boolean}
21
+ * @memberof StreamsContentProtectionResponse
22
+ */
23
+ allowNoReferer?: boolean;
24
+ constructor(obj?: Partial<StreamsContentProtectionResponse>);
25
+ }
26
+ export default StreamsContentProtectionResponse;
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StreamsContentProtectionResponse = void 0;
4
+ var Mapper_1 = require("../common/Mapper");
5
+ /**
6
+ * @export
7
+ * @class StreamsContentProtectionResponse
8
+ */
9
+ var StreamsContentProtectionResponse = /** @class */ (function () {
10
+ function StreamsContentProtectionResponse(obj) {
11
+ if (!obj) {
12
+ return;
13
+ }
14
+ this.id = (0, Mapper_1.map)(obj.id);
15
+ this.allowedDomains = (0, Mapper_1.mapArray)(obj.allowedDomains);
16
+ this.allowNoReferer = (0, Mapper_1.map)(obj.allowNoReferer);
17
+ }
18
+ return StreamsContentProtectionResponse;
19
+ }());
20
+ exports.StreamsContentProtectionResponse = StreamsContentProtectionResponse;
21
+ exports.default = StreamsContentProtectionResponse;