@bitmovin/api-sdk 1.281.0 → 1.282.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.
- package/README.md +1 -1
- package/dist/bitmovin-api-sdk.browser.js +180 -1
- package/dist/bitmovin-api-sdk.browser.min.js +1 -1
- package/dist/common/RestClient.js +1 -1
- package/dist/encoding/encodings/live/LiveApi.d.ts +2 -0
- package/dist/encoding/encodings/live/LiveApi.js +2 -0
- package/dist/encoding/encodings/live/updateAutoshutdownConfig/UpdateAutoshutdownConfigApi.d.ts +21 -0
- package/dist/encoding/encodings/live/updateAutoshutdownConfig/UpdateAutoshutdownConfigApi.js +32 -0
- package/dist/models/AiSceneAnalysisLiveResult.d.ts +6 -0
- package/dist/models/AiSceneAnalysisLiveResult.js +1 -0
- package/dist/models/Av1DynamicRangeFormat.d.ts +12 -0
- package/dist/models/Av1DynamicRangeFormat.js +16 -0
- package/dist/models/Av1VideoConfiguration.d.ts +14 -0
- package/dist/models/Av1VideoConfiguration.js +2 -0
- package/dist/models/LevelAv1.d.ts +22 -0
- package/dist/models/LevelAv1.js +26 -0
- package/dist/models/LiveAutoShutdownConfigurationUpdateRequest.d.ts +10 -0
- package/dist/models/LiveAutoShutdownConfigurationUpdateRequest.js +19 -0
- package/dist/models/LiveAutoShutdownConfigurationUpdateResponse.d.ts +16 -0
- package/dist/models/LiveAutoShutdownConfigurationUpdateResponse.js +21 -0
- package/dist/models/StreamMetadata.d.ts +8 -2
- package/dist/models/StreamMetadata.js +1 -0
- package/dist/models/index.d.ts +4 -0
- package/dist/models/index.js +4 -0
- package/package.json +1 -1
|
@@ -165,7 +165,7 @@ class HeaderHandler extends DelegatingHandler {
|
|
|
165
165
|
const headers = {
|
|
166
166
|
'X-Api-Key': apiKey,
|
|
167
167
|
'X-Api-Client': 'bitmovin-api-sdk-javascript',
|
|
168
|
-
'X-Api-Client-Version': '1.
|
|
168
|
+
'X-Api-Client-Version': '1.282.0',
|
|
169
169
|
'Content-Type': 'application/json'
|
|
170
170
|
};
|
|
171
171
|
if (tenantOrgId) {
|
|
@@ -2,6 +2,7 @@ import { BaseAPI } from '../../../common/BaseAPI';
|
|
|
2
2
|
import Configuration from '../../../common/Configuration';
|
|
3
3
|
import EsamApi from './esam/EsamApi';
|
|
4
4
|
import ResetLiveManifestTimeshiftApi from './resetLiveManifestTimeshift/ResetLiveManifestTimeshiftApi';
|
|
5
|
+
import UpdateAutoshutdownConfigApi from './updateAutoshutdownConfig/UpdateAutoshutdownConfigApi';
|
|
5
6
|
import HeartbeatApi from './heartbeat/HeartbeatApi';
|
|
6
7
|
import HeartbeatFinalApi from './heartbeatFinal/HeartbeatFinalApi';
|
|
7
8
|
import HdApi from './hd/HdApi';
|
|
@@ -19,6 +20,7 @@ import StartLiveEncodingRequest from '../../../models/StartLiveEncodingRequest';
|
|
|
19
20
|
export default class LiveApi extends BaseAPI {
|
|
20
21
|
esam: EsamApi;
|
|
21
22
|
resetLiveManifestTimeshift: ResetLiveManifestTimeshiftApi;
|
|
23
|
+
updateAutoshutdownConfig: UpdateAutoshutdownConfigApi;
|
|
22
24
|
heartbeat: HeartbeatApi;
|
|
23
25
|
heartbeatFinal: HeartbeatFinalApi;
|
|
24
26
|
hd: HdApi;
|
|
@@ -4,6 +4,7 @@ const BaseAPI_1 = require("../../../common/BaseAPI");
|
|
|
4
4
|
const Mapper_1 = require("../../../common/Mapper");
|
|
5
5
|
const EsamApi_1 = require("./esam/EsamApi");
|
|
6
6
|
const ResetLiveManifestTimeshiftApi_1 = require("./resetLiveManifestTimeshift/ResetLiveManifestTimeshiftApi");
|
|
7
|
+
const UpdateAutoshutdownConfigApi_1 = require("./updateAutoshutdownConfig/UpdateAutoshutdownConfigApi");
|
|
7
8
|
const HeartbeatApi_1 = require("./heartbeat/HeartbeatApi");
|
|
8
9
|
const HeartbeatFinalApi_1 = require("./heartbeatFinal/HeartbeatFinalApi");
|
|
9
10
|
const HdApi_1 = require("./hd/HdApi");
|
|
@@ -23,6 +24,7 @@ class LiveApi extends BaseAPI_1.BaseAPI {
|
|
|
23
24
|
super(configuration);
|
|
24
25
|
this.esam = new EsamApi_1.default(configuration);
|
|
25
26
|
this.resetLiveManifestTimeshift = new ResetLiveManifestTimeshiftApi_1.default(configuration);
|
|
27
|
+
this.updateAutoshutdownConfig = new UpdateAutoshutdownConfigApi_1.default(configuration);
|
|
26
28
|
this.heartbeat = new HeartbeatApi_1.default(configuration);
|
|
27
29
|
this.heartbeatFinal = new HeartbeatFinalApi_1.default(configuration);
|
|
28
30
|
this.hd = new HdApi_1.default(configuration);
|
package/dist/encoding/encodings/live/updateAutoshutdownConfig/UpdateAutoshutdownConfigApi.d.ts
ADDED
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
import { BaseAPI } from '../../../../common/BaseAPI';
|
|
2
|
+
import Configuration from '../../../../common/Configuration';
|
|
3
|
+
import LiveAutoShutdownConfigurationUpdateRequest from '../../../../models/LiveAutoShutdownConfigurationUpdateRequest';
|
|
4
|
+
import LiveAutoShutdownConfigurationUpdateResponse from '../../../../models/LiveAutoShutdownConfigurationUpdateResponse';
|
|
5
|
+
/**
|
|
6
|
+
* UpdateAutoshutdownConfigApi - object-oriented interface
|
|
7
|
+
* @export
|
|
8
|
+
* @class UpdateAutoshutdownConfigApi
|
|
9
|
+
* @extends {BaseAPI}
|
|
10
|
+
*/
|
|
11
|
+
export default class UpdateAutoshutdownConfigApi extends BaseAPI {
|
|
12
|
+
constructor(configuration: Configuration);
|
|
13
|
+
/**
|
|
14
|
+
* @summary Replace Live Auto Shutdown Configuration
|
|
15
|
+
* @param {string} encodingId Id of the encoding.
|
|
16
|
+
* @param {LiveAutoShutdownConfigurationUpdateRequest} liveAutoShutdownConfigurationUpdateRequest Applies a new auto shutdown configuration to a Live Encoding that is already running, without interrupting the stream. **The body is a full replacement, not a partial update.** Every field that is omitted or set to `null` disarms the corresponding timer, and an empty body `{}` disarms all timers. Always send the complete configuration you want the encoding to run with, including the values you want to keep. **`streamTimeoutMinutes` is counted from this call, not from the start of the encoding.** The encoding is stopped that many minutes after the update is accepted, whereas in the start request the same field is counted from when the encoding started. An encoding started at 12:00 with `streamTimeoutMinutes` of 120 is scheduled to stop at 14:00; updating it at 13:30 with `streamTimeoutMinutes` of 150 moves the shutdown to 16:00, not to 14:30. `bytesReadTimeoutSeconds` is relative by nature, as it always counts from the last byte received, and `waitingForFirstConnectTimeoutMinutes` has no effect once the input is connected. The organization's maximum live encoding runtime still bounds the total runtime of the encoding, measured from the start of the encoding. An update that would push the shutdown past that limit is rejected rather than extending the encoding beyond it. **Do not leave the call to the last few seconds.** The update is rejected with `409` when any armed shutdown timer is within 10 seconds of firing, because at that point the shutdown sequence is effectively already in flight.
|
|
17
|
+
* @throws {BitmovinError}
|
|
18
|
+
* @memberof UpdateAutoshutdownConfigApi
|
|
19
|
+
*/
|
|
20
|
+
create(encodingId: string, liveAutoShutdownConfigurationUpdateRequest?: LiveAutoShutdownConfigurationUpdateRequest): Promise<LiveAutoShutdownConfigurationUpdateResponse>;
|
|
21
|
+
}
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
const BaseAPI_1 = require("../../../../common/BaseAPI");
|
|
4
|
+
const Mapper_1 = require("../../../../common/Mapper");
|
|
5
|
+
const LiveAutoShutdownConfigurationUpdateResponse_1 = require("../../../../models/LiveAutoShutdownConfigurationUpdateResponse");
|
|
6
|
+
/**
|
|
7
|
+
* UpdateAutoshutdownConfigApi - object-oriented interface
|
|
8
|
+
* @export
|
|
9
|
+
* @class UpdateAutoshutdownConfigApi
|
|
10
|
+
* @extends {BaseAPI}
|
|
11
|
+
*/
|
|
12
|
+
class UpdateAutoshutdownConfigApi extends BaseAPI_1.BaseAPI {
|
|
13
|
+
constructor(configuration) {
|
|
14
|
+
super(configuration);
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* @summary Replace Live Auto Shutdown Configuration
|
|
18
|
+
* @param {string} encodingId Id of the encoding.
|
|
19
|
+
* @param {LiveAutoShutdownConfigurationUpdateRequest} liveAutoShutdownConfigurationUpdateRequest Applies a new auto shutdown configuration to a Live Encoding that is already running, without interrupting the stream. **The body is a full replacement, not a partial update.** Every field that is omitted or set to `null` disarms the corresponding timer, and an empty body `{}` disarms all timers. Always send the complete configuration you want the encoding to run with, including the values you want to keep. **`streamTimeoutMinutes` is counted from this call, not from the start of the encoding.** The encoding is stopped that many minutes after the update is accepted, whereas in the start request the same field is counted from when the encoding started. An encoding started at 12:00 with `streamTimeoutMinutes` of 120 is scheduled to stop at 14:00; updating it at 13:30 with `streamTimeoutMinutes` of 150 moves the shutdown to 16:00, not to 14:30. `bytesReadTimeoutSeconds` is relative by nature, as it always counts from the last byte received, and `waitingForFirstConnectTimeoutMinutes` has no effect once the input is connected. The organization's maximum live encoding runtime still bounds the total runtime of the encoding, measured from the start of the encoding. An update that would push the shutdown past that limit is rejected rather than extending the encoding beyond it. **Do not leave the call to the last few seconds.** The update is rejected with `409` when any armed shutdown timer is within 10 seconds of firing, because at that point the shutdown sequence is effectively already in flight.
|
|
20
|
+
* @throws {BitmovinError}
|
|
21
|
+
* @memberof UpdateAutoshutdownConfigApi
|
|
22
|
+
*/
|
|
23
|
+
create(encodingId, liveAutoShutdownConfigurationUpdateRequest) {
|
|
24
|
+
const pathParamMap = {
|
|
25
|
+
encoding_id: encodingId
|
|
26
|
+
};
|
|
27
|
+
return this.restClient.post('/encoding/encodings/{encoding_id}/live/update-autoshutdown-config', pathParamMap, liveAutoShutdownConfigurationUpdateRequest).then((response) => {
|
|
28
|
+
return (0, Mapper_1.map)(response, LiveAutoShutdownConfigurationUpdateResponse_1.default);
|
|
29
|
+
});
|
|
30
|
+
}
|
|
31
|
+
}
|
|
32
|
+
exports.default = UpdateAutoshutdownConfigApi;
|
|
@@ -31,6 +31,12 @@ export declare class AiSceneAnalysisLiveResult {
|
|
|
31
31
|
* @memberof AiSceneAnalysisLiveResult
|
|
32
32
|
*/
|
|
33
33
|
producedAt?: Date;
|
|
34
|
+
/**
|
|
35
|
+
* UTC presentation-clock time in Unix milliseconds corresponding to media time zero. This origin is fixed for the Live Analysis; coverage, observation, and source-gap times remain relative to it. It is not the source capture time or result publication time. (required)
|
|
36
|
+
* @type {number}
|
|
37
|
+
* @memberof AiSceneAnalysisLiveResult
|
|
38
|
+
*/
|
|
39
|
+
mediaTimeOriginUnixMs?: number;
|
|
34
40
|
/**
|
|
35
41
|
* Whether AI analysis produced this as the final result generation. This does not by itself imply that the Analysis completed successfully. (required)
|
|
36
42
|
* @type {boolean}
|
|
@@ -19,6 +19,7 @@ class AiSceneAnalysisLiveResult {
|
|
|
19
19
|
this.encodingId = (0, Mapper_1.map)(obj.encodingId);
|
|
20
20
|
this.sequence = (0, Mapper_1.map)(obj.sequence);
|
|
21
21
|
this.producedAt = (0, Mapper_1.map)(obj.producedAt, Date);
|
|
22
|
+
this.mediaTimeOriginUnixMs = (0, Mapper_1.map)(obj.mediaTimeOriginUnixMs);
|
|
22
23
|
this.isFinal = (0, Mapper_1.map)(obj.isFinal);
|
|
23
24
|
this.analyzedStartTimeSeconds = (0, Mapper_1.map)(obj.analyzedStartTimeSeconds);
|
|
24
25
|
this.analyzedEndTimeSeconds = (0, Mapper_1.map)(obj.analyzedEndTimeSeconds);
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Configures what kind of dynamic range the output should conform to. Can be used to convert between different HDR formats.
|
|
3
|
+
* @export
|
|
4
|
+
* @enum {string}
|
|
5
|
+
*/
|
|
6
|
+
export declare enum Av1DynamicRangeFormat {
|
|
7
|
+
DOLBY_VISION_PROFILE_10_0 = "DOLBY_VISION_PROFILE_10_0",
|
|
8
|
+
DOLBY_VISION_PROFILE_10_1 = "DOLBY_VISION_PROFILE_10_1",
|
|
9
|
+
HDR10 = "HDR10",
|
|
10
|
+
SDR = "SDR"
|
|
11
|
+
}
|
|
12
|
+
export default Av1DynamicRangeFormat;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.Av1DynamicRangeFormat = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Configures what kind of dynamic range the output should conform to. Can be used to convert between different HDR formats.
|
|
6
|
+
* @export
|
|
7
|
+
* @enum {string}
|
|
8
|
+
*/
|
|
9
|
+
var Av1DynamicRangeFormat;
|
|
10
|
+
(function (Av1DynamicRangeFormat) {
|
|
11
|
+
Av1DynamicRangeFormat["DOLBY_VISION_PROFILE_10_0"] = "DOLBY_VISION_PROFILE_10_0";
|
|
12
|
+
Av1DynamicRangeFormat["DOLBY_VISION_PROFILE_10_1"] = "DOLBY_VISION_PROFILE_10_1";
|
|
13
|
+
Av1DynamicRangeFormat["HDR10"] = "HDR10";
|
|
14
|
+
Av1DynamicRangeFormat["SDR"] = "SDR";
|
|
15
|
+
})(Av1DynamicRangeFormat || (exports.Av1DynamicRangeFormat = Av1DynamicRangeFormat = {}));
|
|
16
|
+
exports.default = Av1DynamicRangeFormat;
|
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import AutoLevelSetup from './AutoLevelSetup';
|
|
2
|
+
import Av1DynamicRangeFormat from './Av1DynamicRangeFormat';
|
|
2
3
|
import Av1PresetConfiguration from './Av1PresetConfiguration';
|
|
3
4
|
import CodecConfigType from './CodecConfigType';
|
|
5
|
+
import LevelAv1 from './LevelAv1';
|
|
4
6
|
import VideoConfiguration from './VideoConfiguration';
|
|
5
7
|
/**
|
|
6
8
|
* @export
|
|
@@ -25,6 +27,18 @@ export declare class Av1VideoConfiguration extends VideoConfiguration {
|
|
|
25
27
|
* @memberof Av1VideoConfiguration
|
|
26
28
|
*/
|
|
27
29
|
autoLevelSetup?: AutoLevelSetup;
|
|
30
|
+
/**
|
|
31
|
+
* Upper bound for the automatically calculated level. The level determined by autoLevelSetup is clamped to this value, so the encoder never signals a level higher than the one given here. If the target bitrate does not fit within this level, the encoder constrains the bitrate distribution to stay conformant rather than raising the level. Has no effect when autoLevelSetup is disabled.
|
|
32
|
+
* @type {LevelAv1}
|
|
33
|
+
* @memberof Av1VideoConfiguration
|
|
34
|
+
*/
|
|
35
|
+
maxLevel?: LevelAv1;
|
|
36
|
+
/**
|
|
37
|
+
* Configures what kind of dynamic range the output should conform to.
|
|
38
|
+
* @type {Av1DynamicRangeFormat}
|
|
39
|
+
* @memberof Av1VideoConfiguration
|
|
40
|
+
*/
|
|
41
|
+
dynamicRangeFormat?: Av1DynamicRangeFormat;
|
|
28
42
|
/**
|
|
29
43
|
* Set the mastering display color volume metadata. The chromaticity coordinates for the green (G), blue (B), red (R) primaries and the white point (WP) are given in increments of 0.00002 (i.e. multiply the actual value by 50000), and the luminance values (L) are given in increments of 0.0001 cd/m² (i.e. multiply the actual value by 10000). For example `G(13250,34500)B(7500,3000)R(34000,16000)WP(15635,16450)L(10000000,1)` describes a P3D65 1000-nits monitor, where G(x=0.265, y=0.690), B(x=0.150, y=0.060), R(x=0.680, y=0.320), WP(x=0.3127, y=0.3290), L(max=1000, min=0.0001). Part of HDR-10 metadata.
|
|
30
44
|
* @type {string}
|
|
@@ -22,6 +22,8 @@ class Av1VideoConfiguration extends VideoConfiguration_1.default {
|
|
|
22
22
|
}
|
|
23
23
|
this.presetConfiguration = (0, Mapper_1.map)(obj.presetConfiguration);
|
|
24
24
|
this.autoLevelSetup = (0, Mapper_1.map)(obj.autoLevelSetup);
|
|
25
|
+
this.maxLevel = (0, Mapper_1.map)(obj.maxLevel);
|
|
26
|
+
this.dynamicRangeFormat = (0, Mapper_1.map)(obj.dynamicRangeFormat);
|
|
25
27
|
this.masterDisplay = (0, Mapper_1.map)(obj.masterDisplay);
|
|
26
28
|
this.maxContentLightLevel = (0, Mapper_1.map)(obj.maxContentLightLevel);
|
|
27
29
|
this.maxPictureAverageLightLevel = (0, Mapper_1.map)(obj.maxPictureAverageLightLevel);
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Specified set of constraints that indicate a degree of required decoder performance for a profile, see: https://aomediacodec.github.io/av1-spec/av1-spec.pdf (Annex A.3)
|
|
3
|
+
* @export
|
|
4
|
+
* @enum {string}
|
|
5
|
+
*/
|
|
6
|
+
export declare enum LevelAv1 {
|
|
7
|
+
L2_0 = "2.0",
|
|
8
|
+
L2_1 = "2.1",
|
|
9
|
+
L3_0 = "3.0",
|
|
10
|
+
L3_1 = "3.1",
|
|
11
|
+
L4_0 = "4.0",
|
|
12
|
+
L4_1 = "4.1",
|
|
13
|
+
L5_0 = "5.0",
|
|
14
|
+
L5_1 = "5.1",
|
|
15
|
+
L5_2 = "5.2",
|
|
16
|
+
L5_3 = "5.3",
|
|
17
|
+
L6_0 = "6.0",
|
|
18
|
+
L6_1 = "6.1",
|
|
19
|
+
L6_2 = "6.2",
|
|
20
|
+
L6_3 = "6.3"
|
|
21
|
+
}
|
|
22
|
+
export default LevelAv1;
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LevelAv1 = void 0;
|
|
4
|
+
/**
|
|
5
|
+
* Specified set of constraints that indicate a degree of required decoder performance for a profile, see: https://aomediacodec.github.io/av1-spec/av1-spec.pdf (Annex A.3)
|
|
6
|
+
* @export
|
|
7
|
+
* @enum {string}
|
|
8
|
+
*/
|
|
9
|
+
var LevelAv1;
|
|
10
|
+
(function (LevelAv1) {
|
|
11
|
+
LevelAv1["L2_0"] = "2.0";
|
|
12
|
+
LevelAv1["L2_1"] = "2.1";
|
|
13
|
+
LevelAv1["L3_0"] = "3.0";
|
|
14
|
+
LevelAv1["L3_1"] = "3.1";
|
|
15
|
+
LevelAv1["L4_0"] = "4.0";
|
|
16
|
+
LevelAv1["L4_1"] = "4.1";
|
|
17
|
+
LevelAv1["L5_0"] = "5.0";
|
|
18
|
+
LevelAv1["L5_1"] = "5.1";
|
|
19
|
+
LevelAv1["L5_2"] = "5.2";
|
|
20
|
+
LevelAv1["L5_3"] = "5.3";
|
|
21
|
+
LevelAv1["L6_0"] = "6.0";
|
|
22
|
+
LevelAv1["L6_1"] = "6.1";
|
|
23
|
+
LevelAv1["L6_2"] = "6.2";
|
|
24
|
+
LevelAv1["L6_3"] = "6.3";
|
|
25
|
+
})(LevelAv1 || (exports.LevelAv1 = LevelAv1 = {}));
|
|
26
|
+
exports.default = LevelAv1;
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
import LiveAutoShutdownConfiguration from './LiveAutoShutdownConfiguration';
|
|
2
|
+
/**
|
|
3
|
+
* The auto shutdown configuration to set on a running Live Encoding. Any auto shutdown configuration the encoding currently has is overwritten. Every timer that is omitted or `null` is disarmed. An empty object disarms all timers, so always send the complete configuration the encoding should run with, including the values that should stay unchanged.
|
|
4
|
+
* @export
|
|
5
|
+
* @class LiveAutoShutdownConfigurationUpdateRequest
|
|
6
|
+
*/
|
|
7
|
+
export declare class LiveAutoShutdownConfigurationUpdateRequest extends LiveAutoShutdownConfiguration {
|
|
8
|
+
constructor(obj?: Partial<LiveAutoShutdownConfigurationUpdateRequest>);
|
|
9
|
+
}
|
|
10
|
+
export default LiveAutoShutdownConfigurationUpdateRequest;
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LiveAutoShutdownConfigurationUpdateRequest = void 0;
|
|
4
|
+
const LiveAutoShutdownConfiguration_1 = require("./LiveAutoShutdownConfiguration");
|
|
5
|
+
/**
|
|
6
|
+
* The auto shutdown configuration to set on a running Live Encoding. Any auto shutdown configuration the encoding currently has is overwritten. Every timer that is omitted or `null` is disarmed. An empty object disarms all timers, so always send the complete configuration the encoding should run with, including the values that should stay unchanged.
|
|
7
|
+
* @export
|
|
8
|
+
* @class LiveAutoShutdownConfigurationUpdateRequest
|
|
9
|
+
*/
|
|
10
|
+
class LiveAutoShutdownConfigurationUpdateRequest extends LiveAutoShutdownConfiguration_1.default {
|
|
11
|
+
constructor(obj) {
|
|
12
|
+
super(obj);
|
|
13
|
+
if (!obj) {
|
|
14
|
+
return;
|
|
15
|
+
}
|
|
16
|
+
}
|
|
17
|
+
}
|
|
18
|
+
exports.LiveAutoShutdownConfigurationUpdateRequest = LiveAutoShutdownConfigurationUpdateRequest;
|
|
19
|
+
exports.default = LiveAutoShutdownConfigurationUpdateRequest;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import LiveAutoShutdownConfiguration from './LiveAutoShutdownConfiguration';
|
|
2
|
+
/**
|
|
3
|
+
* The auto shutdown configuration that was accepted and applied to the running Live Encoding, together with the instant the encoder armed the shutdown for. `streamTimeoutMinutes` was applied from the moment the encoder accepted the update, not from the start of the encoding, so `scheduledShutdownAt` rather than the timeout value is what says when this encoding stops.
|
|
4
|
+
* @export
|
|
5
|
+
* @class LiveAutoShutdownConfigurationUpdateResponse
|
|
6
|
+
*/
|
|
7
|
+
export declare class LiveAutoShutdownConfigurationUpdateResponse extends LiveAutoShutdownConfiguration {
|
|
8
|
+
/**
|
|
9
|
+
* The instant at which the Live Encoding is currently scheduled to shut down, as reported by the encoder. `null` means no shutdown is scheduled. `bytesReadTimeoutSeconds` is not reflected here, as it only arms once the input stops flowing, so the encoding can still shut down earlier than this.
|
|
10
|
+
* @type {Date}
|
|
11
|
+
* @memberof LiveAutoShutdownConfigurationUpdateResponse
|
|
12
|
+
*/
|
|
13
|
+
scheduledShutdownAt?: Date;
|
|
14
|
+
constructor(obj?: Partial<LiveAutoShutdownConfigurationUpdateResponse>);
|
|
15
|
+
}
|
|
16
|
+
export default LiveAutoShutdownConfigurationUpdateResponse;
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
|
+
exports.LiveAutoShutdownConfigurationUpdateResponse = void 0;
|
|
4
|
+
const Mapper_1 = require("../common/Mapper");
|
|
5
|
+
const LiveAutoShutdownConfiguration_1 = require("./LiveAutoShutdownConfiguration");
|
|
6
|
+
/**
|
|
7
|
+
* The auto shutdown configuration that was accepted and applied to the running Live Encoding, together with the instant the encoder armed the shutdown for. `streamTimeoutMinutes` was applied from the moment the encoder accepted the update, not from the start of the encoding, so `scheduledShutdownAt` rather than the timeout value is what says when this encoding stops.
|
|
8
|
+
* @export
|
|
9
|
+
* @class LiveAutoShutdownConfigurationUpdateResponse
|
|
10
|
+
*/
|
|
11
|
+
class LiveAutoShutdownConfigurationUpdateResponse extends LiveAutoShutdownConfiguration_1.default {
|
|
12
|
+
constructor(obj) {
|
|
13
|
+
super(obj);
|
|
14
|
+
if (!obj) {
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
this.scheduledShutdownAt = (0, Mapper_1.map)(obj.scheduledShutdownAt, Date);
|
|
18
|
+
}
|
|
19
|
+
}
|
|
20
|
+
exports.LiveAutoShutdownConfigurationUpdateResponse = LiveAutoShutdownConfigurationUpdateResponse;
|
|
21
|
+
exports.default = LiveAutoShutdownConfigurationUpdateResponse;
|
|
@@ -4,17 +4,23 @@
|
|
|
4
4
|
*/
|
|
5
5
|
export declare class StreamMetadata {
|
|
6
6
|
/**
|
|
7
|
-
* Language of the media contained in the stream. If the value is not set, then no metadata tag is set for the media stream.
|
|
7
|
+
* Language of the media contained in the stream, given as an ISO 639-2 code or a BCP 47 tag, for example 'eng' or 'en-US'. If the value is not set, then no metadata tag is set for the media stream.
|
|
8
8
|
* @type {string}
|
|
9
9
|
* @memberof StreamMetadata
|
|
10
10
|
*/
|
|
11
11
|
language?: string;
|
|
12
12
|
/**
|
|
13
|
-
* Display name of the Stream, for example to tell apart multiple audio tracks that share the same language. For CMAF muxings it is written as a 'labl' box (ISO/IEC 14496-12) into the user data of the track. Downstream packagers use it for the Label element in DASH manifests and the NAME attribute of EXT-X-MEDIA tags in HLS playlists. If the value is not set, no label is written.
|
|
13
|
+
* Display name of the Stream, for example to tell apart multiple audio tracks that share the same language. For CMAF muxings it is written as a 'labl' box (ISO/IEC 14496-12) into the user data of the track. Downstream packagers use it for the Label element in DASH manifests and the NAME attribute of EXT-X-MEDIA tags in HLS playlists. If the value is not set, no label is written. Use 'labelLanguage' to declare which language the label itself is written in.
|
|
14
14
|
* @type {string}
|
|
15
15
|
* @memberof StreamMetadata
|
|
16
16
|
*/
|
|
17
17
|
label?: string;
|
|
18
|
+
/**
|
|
19
|
+
* Language the 'label' itself is written in, which is not necessarily the language of the media. A Spanish audio track can carry an English label, for example. For CMAF muxings it is written into the 'labl' box next to the label, and downstream packagers use it for the lang attribute of the Label element in DASH manifests. The value is written as given and downstream packagers expose it unchanged, so set a BCP 47 tag such as 'en' when the manifest should carry that form. The value has to be shaped like a BCP 47 tag: a primary subtag of two or three letters, optionally followed by subtags of up to eight letters or digits, each separated by a hyphen, for example 'en', 'en-US' or 'es-419'. If the value is not set and a label is set, 'language' is used as given, for example 'eng'. Without either, the label language is written as 'und' (undetermined). HLS playlists are not affected, as EXT-X-MEDIA has no equivalent attribute.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof StreamMetadata
|
|
22
|
+
*/
|
|
23
|
+
labelLanguage?: string;
|
|
18
24
|
/**
|
|
19
25
|
* Identifier of the switching set the Stream belongs to. For CMAF muxings it is written as a 'kind' box with schemeURI urn:dashif:ingest:switchingset_id (DASH-IF Live Media Ingest) into the user data of the track. Downstream packagers group tracks with the same identifier into one switching set and use it in segment URLs. Only letters, digits, hyphens and underscores are allowed. If the value is not set and a label is set, an identifier is derived from the properties of the Stream, including the label. Without a label, no identifier is written. Set it explicitly when segment URLs have to stay stable across configuration updates.
|
|
20
26
|
* @type {string}
|
package/dist/models/index.d.ts
CHANGED
|
@@ -178,6 +178,7 @@ export * from './AutoLevelSetup';
|
|
|
178
178
|
export * from './AutoRepresentation';
|
|
179
179
|
export * from './AutoRestartConfiguration';
|
|
180
180
|
export * from './AutomaticAdPlacementPosition';
|
|
181
|
+
export * from './Av1DynamicRangeFormat';
|
|
181
182
|
export * from './Av1PerTitleConfiguration';
|
|
182
183
|
export * from './Av1PresetConfiguration';
|
|
183
184
|
export * from './Av1VideoConfiguration';
|
|
@@ -537,6 +538,7 @@ export * from './IvSize';
|
|
|
537
538
|
export * from './KantarWatermark';
|
|
538
539
|
export * from './Keyframe';
|
|
539
540
|
export * from './Label';
|
|
541
|
+
export * from './LevelAv1';
|
|
540
542
|
export * from './LevelH262';
|
|
541
543
|
export * from './LevelH264';
|
|
542
544
|
export * from './LevelH265';
|
|
@@ -544,6 +546,8 @@ export * from './LimitReferences';
|
|
|
544
546
|
export * from './LimitTransformUnitDepthRecursionMode';
|
|
545
547
|
export * from './Link';
|
|
546
548
|
export * from './LiveAutoShutdownConfiguration';
|
|
549
|
+
export * from './LiveAutoShutdownConfigurationUpdateRequest';
|
|
550
|
+
export * from './LiveAutoShutdownConfigurationUpdateResponse';
|
|
547
551
|
export * from './LiveDashManifest';
|
|
548
552
|
export * from './LiveEncoding';
|
|
549
553
|
export * from './LiveEncodingCodec';
|
package/dist/models/index.js
CHANGED
|
@@ -194,6 +194,7 @@ __exportStar(require("./AutoLevelSetup"), exports);
|
|
|
194
194
|
__exportStar(require("./AutoRepresentation"), exports);
|
|
195
195
|
__exportStar(require("./AutoRestartConfiguration"), exports);
|
|
196
196
|
__exportStar(require("./AutomaticAdPlacementPosition"), exports);
|
|
197
|
+
__exportStar(require("./Av1DynamicRangeFormat"), exports);
|
|
197
198
|
__exportStar(require("./Av1PerTitleConfiguration"), exports);
|
|
198
199
|
__exportStar(require("./Av1PresetConfiguration"), exports);
|
|
199
200
|
__exportStar(require("./Av1VideoConfiguration"), exports);
|
|
@@ -553,6 +554,7 @@ __exportStar(require("./IvSize"), exports);
|
|
|
553
554
|
__exportStar(require("./KantarWatermark"), exports);
|
|
554
555
|
__exportStar(require("./Keyframe"), exports);
|
|
555
556
|
__exportStar(require("./Label"), exports);
|
|
557
|
+
__exportStar(require("./LevelAv1"), exports);
|
|
556
558
|
__exportStar(require("./LevelH262"), exports);
|
|
557
559
|
__exportStar(require("./LevelH264"), exports);
|
|
558
560
|
__exportStar(require("./LevelH265"), exports);
|
|
@@ -560,6 +562,8 @@ __exportStar(require("./LimitReferences"), exports);
|
|
|
560
562
|
__exportStar(require("./LimitTransformUnitDepthRecursionMode"), exports);
|
|
561
563
|
__exportStar(require("./Link"), exports);
|
|
562
564
|
__exportStar(require("./LiveAutoShutdownConfiguration"), exports);
|
|
565
|
+
__exportStar(require("./LiveAutoShutdownConfigurationUpdateRequest"), exports);
|
|
566
|
+
__exportStar(require("./LiveAutoShutdownConfigurationUpdateResponse"), exports);
|
|
563
567
|
__exportStar(require("./LiveDashManifest"), exports);
|
|
564
568
|
__exportStar(require("./LiveEncoding"), exports);
|
|
565
569
|
__exportStar(require("./LiveEncodingCodec"), exports);
|