@bitmovin/api-sdk 1.277.0 → 1.279.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 (50) hide show
  1. package/README.md +1 -1
  2. package/dist/bitmovin-api-sdk.browser.js +280 -77
  3. package/dist/bitmovin-api-sdk.browser.min.js +1 -1
  4. package/dist/common/RestClient.js +1 -1
  5. package/dist/models/AdAnalyticsQueryRequest.d.ts +6 -0
  6. package/dist/models/AdAnalyticsQueryRequest.js +1 -0
  7. package/dist/models/AdvisoryAnalysisStatus.d.ts +9 -0
  8. package/dist/models/AdvisoryAnalysisStatus.js +13 -0
  9. package/dist/models/AdvisoryCategory.d.ts +9 -0
  10. package/dist/models/AdvisoryCategory.js +13 -0
  11. package/dist/models/AdvisoryConfidence.d.ts +11 -0
  12. package/dist/models/AdvisoryConfidence.js +15 -0
  13. package/dist/models/AiSceneAnalysisFeatures.d.ts +7 -0
  14. package/dist/models/AiSceneAnalysisFeatures.js +2 -0
  15. package/dist/models/AiSceneAnalysisRegulatoryAdvisories.d.ts +15 -0
  16. package/dist/models/AiSceneAnalysisRegulatoryAdvisories.js +18 -0
  17. package/dist/models/AkamaiMslOutput.d.ts +8 -1
  18. package/dist/models/AkamaiMslOutput.js +2 -0
  19. package/dist/models/AkamaiMslVersion.d.ts +2 -1
  20. package/dist/models/AkamaiMslVersion.js +1 -0
  21. package/dist/models/Condition.d.ts +1 -1
  22. package/dist/models/ConditionAttribute.d.ts +2 -1
  23. package/dist/models/ConditionAttribute.js +1 -0
  24. package/dist/models/ContentAdvisory.d.ts +29 -0
  25. package/dist/models/ContentAdvisory.js +21 -0
  26. package/dist/models/H265V2PerTitleConfiguration.d.ts +0 -6
  27. package/dist/models/H265V2PerTitleConfiguration.js +0 -1
  28. package/dist/models/H265V2RateControlModeConfig.d.ts +2 -3
  29. package/dist/models/H265V2RateControlModeConfig.js +2 -3
  30. package/dist/models/H265V2RateControlModeConfigType.d.ts +1 -2
  31. package/dist/models/H265V2RateControlModeConfigType.js +0 -1
  32. package/dist/models/MslPublishingAuthentication.d.ts +27 -0
  33. package/dist/models/MslPublishingAuthentication.js +21 -0
  34. package/dist/models/RegulatoryAdvisoryTopic.d.ts +8 -0
  35. package/dist/models/RegulatoryAdvisoryTopic.js +12 -0
  36. package/dist/models/SceneAnalysisListItem.d.ts +7 -0
  37. package/dist/models/SceneAnalysisListItem.js +2 -0
  38. package/dist/models/SceneAnalysisMatchingSegment.d.ts +46 -0
  39. package/dist/models/SceneAnalysisMatchingSegment.js +24 -0
  40. package/dist/models/Shot.d.ts +7 -0
  41. package/dist/models/Shot.js +2 -0
  42. package/dist/models/ShotAdvisories.d.ts +23 -0
  43. package/dist/models/ShotAdvisories.js +21 -0
  44. package/dist/models/index.d.ts +9 -2
  45. package/dist/models/index.js +9 -2
  46. package/package.json +1 -1
  47. package/dist/models/H265V2ConstantBitrateModeConfig.d.ts +0 -22
  48. package/dist/models/H265V2ConstantBitrateModeConfig.js +0 -27
  49. package/dist/models/MediaConfigBitrate.d.ts +0 -16
  50. package/dist/models/MediaConfigBitrate.js +0 -20
@@ -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.277.0',
168
+ 'X-Api-Client-Version': '1.279.0',
169
169
  'Content-Type': 'application/json'
170
170
  };
171
171
  if (tenantOrgId) {
@@ -40,6 +40,12 @@ export declare class AdAnalyticsQueryRequest extends AnalyticsQueryTimeframe {
40
40
  * @memberof AdAnalyticsQueryRequest
41
41
  */
42
42
  groupBy?: AdAnalyticsAttribute[];
43
+ /**
44
+ * Whether context data should be included in the response
45
+ * @type {boolean}
46
+ * @memberof AdAnalyticsQueryRequest
47
+ */
48
+ includeContext?: boolean;
43
49
  /**
44
50
  * Maximum number of rows returned (max. 200)
45
51
  * @type {number}
@@ -21,6 +21,7 @@ class AdAnalyticsQueryRequest extends AnalyticsQueryTimeframe_1.default {
21
21
  this.dimension = (0, Mapper_1.map)(obj.dimension);
22
22
  this.interval = (0, Mapper_1.map)(obj.interval);
23
23
  this.groupBy = (0, Mapper_1.mapArray)(obj.groupBy);
24
+ this.includeContext = (0, Mapper_1.map)(obj.includeContext);
24
25
  this.limit = (0, Mapper_1.map)(obj.limit);
25
26
  this.offset = (0, Mapper_1.map)(obj.offset);
26
27
  }
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @export
3
+ * @enum {string}
4
+ */
5
+ export declare enum AdvisoryAnalysisStatus {
6
+ ANALYZED = "ANALYZED",
7
+ BLOCKED = "BLOCKED"
8
+ }
9
+ export default AdvisoryAnalysisStatus;
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AdvisoryAnalysisStatus = void 0;
4
+ /**
5
+ * @export
6
+ * @enum {string}
7
+ */
8
+ var AdvisoryAnalysisStatus;
9
+ (function (AdvisoryAnalysisStatus) {
10
+ AdvisoryAnalysisStatus["ANALYZED"] = "ANALYZED";
11
+ AdvisoryAnalysisStatus["BLOCKED"] = "BLOCKED";
12
+ })(AdvisoryAnalysisStatus || (exports.AdvisoryAnalysisStatus = AdvisoryAnalysisStatus = {}));
13
+ exports.default = AdvisoryAnalysisStatus;
@@ -0,0 +1,9 @@
1
+ /**
2
+ * @export
3
+ * @enum {string}
4
+ */
5
+ export declare enum AdvisoryCategory {
6
+ TOBACCO = "TOBACCO",
7
+ VAPE = "VAPE"
8
+ }
9
+ export default AdvisoryCategory;
@@ -0,0 +1,13 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AdvisoryCategory = void 0;
4
+ /**
5
+ * @export
6
+ * @enum {string}
7
+ */
8
+ var AdvisoryCategory;
9
+ (function (AdvisoryCategory) {
10
+ AdvisoryCategory["TOBACCO"] = "TOBACCO";
11
+ AdvisoryCategory["VAPE"] = "VAPE";
12
+ })(AdvisoryCategory || (exports.AdvisoryCategory = AdvisoryCategory = {}));
13
+ exports.default = AdvisoryCategory;
@@ -0,0 +1,11 @@
1
+ /**
2
+ * @export
3
+ * @enum {string}
4
+ */
5
+ export declare enum AdvisoryConfidence {
6
+ HIGH = "HIGH",
7
+ MEDIUM = "MEDIUM",
8
+ LOW = "LOW",
9
+ UNKNOWN = "UNKNOWN"
10
+ }
11
+ export default AdvisoryConfidence;
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AdvisoryConfidence = void 0;
4
+ /**
5
+ * @export
6
+ * @enum {string}
7
+ */
8
+ var AdvisoryConfidence;
9
+ (function (AdvisoryConfidence) {
10
+ AdvisoryConfidence["HIGH"] = "HIGH";
11
+ AdvisoryConfidence["MEDIUM"] = "MEDIUM";
12
+ AdvisoryConfidence["LOW"] = "LOW";
13
+ AdvisoryConfidence["UNKNOWN"] = "UNKNOWN";
14
+ })(AdvisoryConfidence || (exports.AdvisoryConfidence = AdvisoryConfidence = {}));
15
+ exports.default = AdvisoryConfidence;
@@ -1,6 +1,7 @@
1
1
  import AiSceneAnalysisAssetDescription from './AiSceneAnalysisAssetDescription';
2
2
  import AiSceneAnalysisAutomaticAdPlacement from './AiSceneAnalysisAutomaticAdPlacement';
3
3
  import AiSceneAnalysisOutputLanguageCodes from './AiSceneAnalysisOutputLanguageCodes';
4
+ import AiSceneAnalysisRegulatoryAdvisories from './AiSceneAnalysisRegulatoryAdvisories';
4
5
  /**
5
6
  * @export
6
7
  * @class AiSceneAnalysisFeatures
@@ -24,6 +25,12 @@ export declare class AiSceneAnalysisFeatures {
24
25
  * @memberof AiSceneAnalysisFeatures
25
26
  */
26
27
  outputLanguageCodes?: AiSceneAnalysisOutputLanguageCodes;
28
+ /**
29
+ * AI scene analysis will screen the asset for content requiring a statutory on-screen advisory and report the findings per shot in the asset description. Requires assetDescription. Contact support to enable this feature for your organization.
30
+ * @type {AiSceneAnalysisRegulatoryAdvisories}
31
+ * @memberof AiSceneAnalysisFeatures
32
+ */
33
+ regulatoryAdvisories?: AiSceneAnalysisRegulatoryAdvisories;
27
34
  constructor(obj?: Partial<AiSceneAnalysisFeatures>);
28
35
  }
29
36
  export default AiSceneAnalysisFeatures;
@@ -5,6 +5,7 @@ const Mapper_1 = require("../common/Mapper");
5
5
  const AiSceneAnalysisAssetDescription_1 = require("./AiSceneAnalysisAssetDescription");
6
6
  const AiSceneAnalysisAutomaticAdPlacement_1 = require("./AiSceneAnalysisAutomaticAdPlacement");
7
7
  const AiSceneAnalysisOutputLanguageCodes_1 = require("./AiSceneAnalysisOutputLanguageCodes");
8
+ const AiSceneAnalysisRegulatoryAdvisories_1 = require("./AiSceneAnalysisRegulatoryAdvisories");
8
9
  /**
9
10
  * @export
10
11
  * @class AiSceneAnalysisFeatures
@@ -17,6 +18,7 @@ class AiSceneAnalysisFeatures {
17
18
  this.assetDescription = (0, Mapper_1.map)(obj.assetDescription, AiSceneAnalysisAssetDescription_1.default);
18
19
  this.automaticAdPlacement = (0, Mapper_1.map)(obj.automaticAdPlacement, AiSceneAnalysisAutomaticAdPlacement_1.default);
19
20
  this.outputLanguageCodes = (0, Mapper_1.map)(obj.outputLanguageCodes, AiSceneAnalysisOutputLanguageCodes_1.default);
21
+ this.regulatoryAdvisories = (0, Mapper_1.map)(obj.regulatoryAdvisories, AiSceneAnalysisRegulatoryAdvisories_1.default);
20
22
  }
21
23
  }
22
24
  exports.AiSceneAnalysisFeatures = AiSceneAnalysisFeatures;
@@ -0,0 +1,15 @@
1
+ import RegulatoryAdvisoryTopic from './RegulatoryAdvisoryTopic';
2
+ /**
3
+ * @export
4
+ * @class AiSceneAnalysisRegulatoryAdvisories
5
+ */
6
+ export declare class AiSceneAnalysisRegulatoryAdvisories {
7
+ /**
8
+ * The regulatory advisory topics to screen the asset for. At least one topic must be set. (required)
9
+ * @type {RegulatoryAdvisoryTopic[]}
10
+ * @memberof AiSceneAnalysisRegulatoryAdvisories
11
+ */
12
+ topics?: RegulatoryAdvisoryTopic[];
13
+ constructor(obj?: Partial<AiSceneAnalysisRegulatoryAdvisories>);
14
+ }
15
+ export default AiSceneAnalysisRegulatoryAdvisories;
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.AiSceneAnalysisRegulatoryAdvisories = void 0;
4
+ const Mapper_1 = require("../common/Mapper");
5
+ /**
6
+ * @export
7
+ * @class AiSceneAnalysisRegulatoryAdvisories
8
+ */
9
+ class AiSceneAnalysisRegulatoryAdvisories {
10
+ constructor(obj) {
11
+ if (!obj) {
12
+ return;
13
+ }
14
+ this.topics = (0, Mapper_1.mapArray)(obj.topics);
15
+ }
16
+ }
17
+ exports.AiSceneAnalysisRegulatoryAdvisories = AiSceneAnalysisRegulatoryAdvisories;
18
+ exports.default = AiSceneAnalysisRegulatoryAdvisories;
@@ -1,5 +1,6 @@
1
1
  import AkamaiMslStreamFormat from './AkamaiMslStreamFormat';
2
2
  import AkamaiMslVersion from './AkamaiMslVersion';
3
+ import MslPublishingAuthentication from './MslPublishingAuthentication';
3
4
  import Output from './Output';
4
5
  import OutputType from './OutputType';
5
6
  /**
@@ -32,11 +33,17 @@ export declare class AkamaiMslOutput extends Output {
32
33
  */
33
34
  streamFormat?: AkamaiMslStreamFormat;
34
35
  /**
35
- * The Akamai MSL Version. Only MSL4 is supported at the moment. (required)
36
+ * The Akamai MSL Version. MSL4 and MSL5 are supported. (required)
36
37
  * @type {AkamaiMslVersion}
37
38
  * @memberof AkamaiMslOutput
38
39
  */
39
40
  mslVersion?: AkamaiMslVersion;
41
+ /**
42
+ * MSL5 only. HTTP Digest publishing credentials. Sending this field with `mslVersion: MSL4` is rejected. Credentials (username, password) are write-only and not returned in responses.
43
+ * @type {MslPublishingAuthentication}
44
+ * @memberof AkamaiMslOutput
45
+ */
46
+ publishingAuthentication?: MslPublishingAuthentication;
40
47
  constructor(obj?: Partial<AkamaiMslOutput>);
41
48
  }
42
49
  export default AkamaiMslOutput;
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.AkamaiMslOutput = void 0;
4
4
  const Mapper_1 = require("../common/Mapper");
5
+ const MslPublishingAuthentication_1 = require("./MslPublishingAuthentication");
5
6
  const Output_1 = require("./Output");
6
7
  const OutputType_1 = require("./OutputType");
7
8
  /**
@@ -24,6 +25,7 @@ class AkamaiMslOutput extends Output_1.default {
24
25
  this.eventName = (0, Mapper_1.map)(obj.eventName);
25
26
  this.streamFormat = (0, Mapper_1.map)(obj.streamFormat);
26
27
  this.mslVersion = (0, Mapper_1.map)(obj.mslVersion);
28
+ this.publishingAuthentication = (0, Mapper_1.map)(obj.publishingAuthentication, MslPublishingAuthentication_1.default);
27
29
  }
28
30
  }
29
31
  exports.AkamaiMslOutput = AkamaiMslOutput;
@@ -3,6 +3,7 @@
3
3
  * @enum {string}
4
4
  */
5
5
  export declare enum AkamaiMslVersion {
6
- MSL4 = "MSL4"
6
+ MSL4 = "MSL4",
7
+ MSL5 = "MSL5"
7
8
  }
8
9
  export default AkamaiMslVersion;
@@ -8,5 +8,6 @@ exports.AkamaiMslVersion = void 0;
8
8
  var AkamaiMslVersion;
9
9
  (function (AkamaiMslVersion) {
10
10
  AkamaiMslVersion["MSL4"] = "MSL4";
11
+ AkamaiMslVersion["MSL5"] = "MSL5";
11
12
  })(AkamaiMslVersion || (exports.AkamaiMslVersion = AkamaiMslVersion = {}));
12
13
  exports.default = AkamaiMslVersion;
@@ -13,7 +13,7 @@ export declare class Condition extends AbstractCondition {
13
13
  */
14
14
  readonly type: ConditionType;
15
15
  /**
16
- * The attribute that should be used for the evaluation. Valid values include, depending on the context: - HEIGHT - WIDTH - BITRATE - FPS - ASPECTRATIO - INPUTSTREAM - LANGUAGE - CHANNELFORMAT - CHANNELLAYOUT - STREAMCOUNT - AUDIOSTREAMCOUNT - VIDEOSTREAMCOUNT - DURATION - ROTATION (required)
16
+ * The attribute that should be used for the evaluation. Valid values include, depending on the context: - HEIGHT - WIDTH - BITRATE - FPS - ASPECTRATIO - INPUTSTREAM - LANGUAGE - CHANNELFORMAT - CHANNELLAYOUT - STREAMCOUNT - AUDIOSTREAMCOUNT - VIDEOSTREAMCOUNT - DURATION - ROTATION - STREAMID (required)
17
17
  * @type {string}
18
18
  * @memberof Condition
19
19
  */
@@ -19,6 +19,7 @@ export declare enum ConditionAttribute {
19
19
  DURATION = "DURATION",
20
20
  ROTATION = "ROTATION",
21
21
  CONNECTION_STATUS = "CONNECTION_STATUS",
22
- CONNECTION_STATUS_JUST_CHANGED = "CONNECTION_STATUS_JUST_CHANGED"
22
+ CONNECTION_STATUS_JUST_CHANGED = "CONNECTION_STATUS_JUST_CHANGED",
23
+ STREAMID = "STREAMID"
23
24
  }
24
25
  export default ConditionAttribute;
@@ -24,5 +24,6 @@ var ConditionAttribute;
24
24
  ConditionAttribute["ROTATION"] = "ROTATION";
25
25
  ConditionAttribute["CONNECTION_STATUS"] = "CONNECTION_STATUS";
26
26
  ConditionAttribute["CONNECTION_STATUS_JUST_CHANGED"] = "CONNECTION_STATUS_JUST_CHANGED";
27
+ ConditionAttribute["STREAMID"] = "STREAMID";
27
28
  })(ConditionAttribute || (exports.ConditionAttribute = ConditionAttribute = {}));
28
29
  exports.default = ConditionAttribute;
@@ -0,0 +1,29 @@
1
+ import AdvisoryCategory from './AdvisoryCategory';
2
+ import AdvisoryConfidence from './AdvisoryConfidence';
3
+ /**
4
+ * A single piece of advisory-relevant imagery detected within a shot, for example for regulatory on-screen disclaimers
5
+ * @export
6
+ * @class ContentAdvisory
7
+ */
8
+ export declare class ContentAdvisory {
9
+ /**
10
+ * The kind of advisory-relevant imagery that was detected (required)
11
+ * @type {AdvisoryCategory}
12
+ * @memberof ContentAdvisory
13
+ */
14
+ category?: AdvisoryCategory;
15
+ /**
16
+ * The model's own certainty in this detection. Intended to help prioritise human review rather than as a threshold for discarding advisories: detection is tuned to flag uncertain cases rather than miss them, and shots that could not be analysed are reported with LOW confidence (required)
17
+ * @type {AdvisoryConfidence}
18
+ * @memberof ContentAdvisory
19
+ */
20
+ confidence?: AdvisoryConfidence;
21
+ /**
22
+ * A short explanation of what was seen in the shot
23
+ * @type {string}
24
+ * @memberof ContentAdvisory
25
+ */
26
+ reason?: string;
27
+ constructor(obj?: Partial<ContentAdvisory>);
28
+ }
29
+ export default ContentAdvisory;
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.ContentAdvisory = void 0;
4
+ const Mapper_1 = require("../common/Mapper");
5
+ /**
6
+ * A single piece of advisory-relevant imagery detected within a shot, for example for regulatory on-screen disclaimers
7
+ * @export
8
+ * @class ContentAdvisory
9
+ */
10
+ class ContentAdvisory {
11
+ constructor(obj) {
12
+ if (!obj) {
13
+ return;
14
+ }
15
+ this.category = (0, Mapper_1.map)(obj.category);
16
+ this.confidence = (0, Mapper_1.map)(obj.confidence);
17
+ this.reason = (0, Mapper_1.map)(obj.reason);
18
+ }
19
+ }
20
+ exports.ContentAdvisory = ContentAdvisory;
21
+ exports.default = ContentAdvisory;
@@ -16,12 +16,6 @@ export declare class H265V2PerTitleConfiguration extends PerTitleConfiguration {
16
16
  * @memberof H265V2PerTitleConfiguration
17
17
  */
18
18
  codecMaxBitrateFactor?: number;
19
- /**
20
- * This factor is used to calculate the bufsize of the codec configuration for the generated representations as a multiple of the targetBitrate
21
- * @type {number}
22
- * @memberof H265V2PerTitleConfiguration
23
- */
24
- codecBufsizeFactor?: number;
25
19
  /**
26
20
  * Desired target quality of the highest representation expressed as QP value used for the CQP probe encode
27
21
  * @type {number}
@@ -15,7 +15,6 @@ class H265V2PerTitleConfiguration extends PerTitleConfiguration_1.default {
15
15
  }
16
16
  this.codecMinBitrateFactor = (0, Mapper_1.map)(obj.codecMinBitrateFactor);
17
17
  this.codecMaxBitrateFactor = (0, Mapper_1.map)(obj.codecMaxBitrateFactor);
18
- this.codecBufsizeFactor = (0, Mapper_1.map)(obj.codecBufsizeFactor);
19
18
  this.targetQualityQp = (0, Mapper_1.map)(obj.targetQualityQp);
20
19
  }
21
20
  }
@@ -1,9 +1,8 @@
1
- import H265V2ConstantBitrateModeConfig from './H265V2ConstantBitrateModeConfig';
2
1
  import H265V2PerceptualQualityModeConfig from './H265V2PerceptualQualityModeConfig';
3
2
  import H265V2RateControlModeConfigType from './H265V2RateControlModeConfigType';
4
- export type H265V2RateControlModeConfigUnion = H265V2PerceptualQualityModeConfig | H265V2ConstantBitrateModeConfig;
3
+ export type H265V2RateControlModeConfigUnion = H265V2PerceptualQualityModeConfig;
5
4
  /**
6
- * Rate control mode configuration. Use H265V2PerceptualQualityModeConfig for PQP mode or H265V2ConstantBitrateModeConfig for CBR mode.
5
+ * Rate control mode configuration. Use H265V2PerceptualQualityModeConfig for PQP mode.
7
6
  * @export
8
7
  * @class H265V2RateControlModeConfig
9
8
  */
@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.H265V2RateControlModeConfig = void 0;
4
4
  const Mapper_1 = require("../common/Mapper");
5
5
  /**
6
- * Rate control mode configuration. Use H265V2PerceptualQualityModeConfig for PQP mode or H265V2ConstantBitrateModeConfig for CBR mode.
6
+ * Rate control mode configuration. Use H265V2PerceptualQualityModeConfig for PQP mode.
7
7
  * @export
8
8
  * @class H265V2RateControlModeConfig
9
9
  */
@@ -18,7 +18,6 @@ class H265V2RateControlModeConfig {
18
18
  exports.H265V2RateControlModeConfig = H265V2RateControlModeConfig;
19
19
  H265V2RateControlModeConfig._discriminatorName = 'type';
20
20
  H265V2RateControlModeConfig._discriminatorMapping = {
21
- "PERCEPTUAL_QUALITY_MODE": 'H265V2PerceptualQualityModeConfig',
22
- "CONSTANT_BITRATE_MODE": 'H265V2ConstantBitrateModeConfig'
21
+ "PERCEPTUAL_QUALITY_MODE": 'H265V2PerceptualQualityModeConfig'
23
22
  };
24
23
  exports.default = H265V2RateControlModeConfig;
@@ -3,7 +3,6 @@
3
3
  * @enum {string}
4
4
  */
5
5
  export declare enum H265V2RateControlModeConfigType {
6
- PERCEPTUAL_QUALITY_MODE = "PERCEPTUAL_QUALITY_MODE",
7
- CONSTANT_BITRATE_MODE = "CONSTANT_BITRATE_MODE"
6
+ PERCEPTUAL_QUALITY_MODE = "PERCEPTUAL_QUALITY_MODE"
8
7
  }
9
8
  export default H265V2RateControlModeConfigType;
@@ -8,6 +8,5 @@ exports.H265V2RateControlModeConfigType = void 0;
8
8
  var H265V2RateControlModeConfigType;
9
9
  (function (H265V2RateControlModeConfigType) {
10
10
  H265V2RateControlModeConfigType["PERCEPTUAL_QUALITY_MODE"] = "PERCEPTUAL_QUALITY_MODE";
11
- H265V2RateControlModeConfigType["CONSTANT_BITRATE_MODE"] = "CONSTANT_BITRATE_MODE";
12
11
  })(H265V2RateControlModeConfigType || (exports.H265V2RateControlModeConfigType = H265V2RateControlModeConfigType = {}));
13
12
  exports.default = H265V2RateControlModeConfigType;
@@ -0,0 +1,27 @@
1
+ /**
2
+ * MSL5 publishing-side authentication. When enabled, the encoder sends HTTP Digest Authentication headers with every segment upload. When `enabled` is `true`, `username` and `password` are required; the API rejects the request otherwise. When `enabled` is `false` (or this object is omitted), credentials are ignored.
3
+ * @export
4
+ * @class MslPublishingAuthentication
5
+ */
6
+ export declare class MslPublishingAuthentication {
7
+ /**
8
+ * Whether HTTP Digest publishing authentication is enabled. (required)
9
+ * @type {boolean}
10
+ * @memberof MslPublishingAuthentication
11
+ */
12
+ enabled?: boolean;
13
+ /**
14
+ * HTTP Digest username for publishing MSL5 segments. Required when `enabled` is `true`.
15
+ * @type {string}
16
+ * @memberof MslPublishingAuthentication
17
+ */
18
+ username?: string;
19
+ /**
20
+ * HTTP Digest password for publishing MSL5 segments. Required when `enabled` is `true`.
21
+ * @type {string}
22
+ * @memberof MslPublishingAuthentication
23
+ */
24
+ password?: string;
25
+ constructor(obj?: Partial<MslPublishingAuthentication>);
26
+ }
27
+ export default MslPublishingAuthentication;
@@ -0,0 +1,21 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.MslPublishingAuthentication = void 0;
4
+ const Mapper_1 = require("../common/Mapper");
5
+ /**
6
+ * MSL5 publishing-side authentication. When enabled, the encoder sends HTTP Digest Authentication headers with every segment upload. When `enabled` is `true`, `username` and `password` are required; the API rejects the request otherwise. When `enabled` is `false` (or this object is omitted), credentials are ignored.
7
+ * @export
8
+ * @class MslPublishingAuthentication
9
+ */
10
+ class MslPublishingAuthentication {
11
+ constructor(obj) {
12
+ if (!obj) {
13
+ return;
14
+ }
15
+ this.enabled = (0, Mapper_1.map)(obj.enabled);
16
+ this.username = (0, Mapper_1.map)(obj.username);
17
+ this.password = (0, Mapper_1.map)(obj.password);
18
+ }
19
+ }
20
+ exports.MslPublishingAuthentication = MslPublishingAuthentication;
21
+ exports.default = MslPublishingAuthentication;
@@ -0,0 +1,8 @@
1
+ /**
2
+ * @export
3
+ * @enum {string}
4
+ */
5
+ export declare enum RegulatoryAdvisoryTopic {
6
+ TOBACCO = "TOBACCO"
7
+ }
8
+ export default RegulatoryAdvisoryTopic;
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.RegulatoryAdvisoryTopic = void 0;
4
+ /**
5
+ * @export
6
+ * @enum {string}
7
+ */
8
+ var RegulatoryAdvisoryTopic;
9
+ (function (RegulatoryAdvisoryTopic) {
10
+ RegulatoryAdvisoryTopic["TOBACCO"] = "TOBACCO";
11
+ })(RegulatoryAdvisoryTopic || (exports.RegulatoryAdvisoryTopic = RegulatoryAdvisoryTopic = {}));
12
+ exports.default = RegulatoryAdvisoryTopic;
@@ -1,3 +1,4 @@
1
+ import SceneAnalysisMatchingSegment from './SceneAnalysisMatchingSegment';
1
2
  /**
2
3
  * @export
3
4
  * @class SceneAnalysisListItem
@@ -51,6 +52,12 @@ export declare class SceneAnalysisListItem {
51
52
  * @memberof SceneAnalysisListItem
52
53
  */
53
54
  outputLanguageCodes?: string[];
55
+ /**
56
+ * The scene segment that best matches searchText. Present only for semantic-search requests with a non-blank searchText; omitted from ordinary list results.
57
+ * @type {SceneAnalysisMatchingSegment}
58
+ * @memberof SceneAnalysisListItem
59
+ */
60
+ matchingSegment?: SceneAnalysisMatchingSegment;
54
61
  constructor(obj?: Partial<SceneAnalysisListItem>);
55
62
  }
56
63
  export default SceneAnalysisListItem;
@@ -2,6 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.SceneAnalysisListItem = void 0;
4
4
  const Mapper_1 = require("../common/Mapper");
5
+ const SceneAnalysisMatchingSegment_1 = require("./SceneAnalysisMatchingSegment");
5
6
  /**
6
7
  * @export
7
8
  * @class SceneAnalysisListItem
@@ -19,6 +20,7 @@ class SceneAnalysisListItem {
19
20
  this.keywords = (0, Mapper_1.mapArray)(obj.keywords);
20
21
  this.sceneCount = (0, Mapper_1.map)(obj.sceneCount);
21
22
  this.outputLanguageCodes = (0, Mapper_1.mapArray)(obj.outputLanguageCodes);
23
+ this.matchingSegment = (0, Mapper_1.map)(obj.matchingSegment, SceneAnalysisMatchingSegment_1.default);
22
24
  }
23
25
  }
24
26
  exports.SceneAnalysisListItem = SceneAnalysisListItem;
@@ -0,0 +1,46 @@
1
+ import SceneType from './SceneType';
2
+ /**
3
+ * The scene segment that best matches a semantic-search query
4
+ * @export
5
+ * @class SceneAnalysisMatchingSegment
6
+ */
7
+ export declare class SceneAnalysisMatchingSegment {
8
+ /**
9
+ * ID of the matching scene (required)
10
+ * @type {string}
11
+ * @memberof SceneAnalysisMatchingSegment
12
+ */
13
+ sceneId?: string;
14
+ /**
15
+ * The detected type of the matching scene
16
+ * @type {SceneType}
17
+ * @memberof SceneAnalysisMatchingSegment
18
+ */
19
+ sceneType?: SceneType;
20
+ /**
21
+ * The title of the matching scene
22
+ * @type {string}
23
+ * @memberof SceneAnalysisMatchingSegment
24
+ */
25
+ sceneTitle?: string;
26
+ /**
27
+ * A description of the matching scene
28
+ * @type {string}
29
+ * @memberof SceneAnalysisMatchingSegment
30
+ */
31
+ sceneDescription?: string;
32
+ /**
33
+ * The start time of the matching segment in seconds from the beginning of the video (required)
34
+ * @type {number}
35
+ * @memberof SceneAnalysisMatchingSegment
36
+ */
37
+ startInSeconds?: number;
38
+ /**
39
+ * The end time of the matching segment in seconds from the beginning of the video (required)
40
+ * @type {number}
41
+ * @memberof SceneAnalysisMatchingSegment
42
+ */
43
+ endInSeconds?: number;
44
+ constructor(obj?: Partial<SceneAnalysisMatchingSegment>);
45
+ }
46
+ export default SceneAnalysisMatchingSegment;
@@ -0,0 +1,24 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.SceneAnalysisMatchingSegment = void 0;
4
+ const Mapper_1 = require("../common/Mapper");
5
+ /**
6
+ * The scene segment that best matches a semantic-search query
7
+ * @export
8
+ * @class SceneAnalysisMatchingSegment
9
+ */
10
+ class SceneAnalysisMatchingSegment {
11
+ constructor(obj) {
12
+ if (!obj) {
13
+ return;
14
+ }
15
+ this.sceneId = (0, Mapper_1.map)(obj.sceneId);
16
+ this.sceneType = (0, Mapper_1.map)(obj.sceneType);
17
+ this.sceneTitle = (0, Mapper_1.map)(obj.sceneTitle);
18
+ this.sceneDescription = (0, Mapper_1.map)(obj.sceneDescription);
19
+ this.startInSeconds = (0, Mapper_1.map)(obj.startInSeconds);
20
+ this.endInSeconds = (0, Mapper_1.map)(obj.endInSeconds);
21
+ }
22
+ }
23
+ exports.SceneAnalysisMatchingSegment = SceneAnalysisMatchingSegment;
24
+ exports.default = SceneAnalysisMatchingSegment;
@@ -1,4 +1,5 @@
1
1
  import MainSubject from './MainSubject';
2
+ import ShotAdvisories from './ShotAdvisories';
2
3
  /**
3
4
  * Represents a continuous camera shot within a scene, containing detailed visual analysis including subjects, timing, and descriptive metadata
4
5
  * @export
@@ -35,6 +36,12 @@ export declare class Shot {
35
36
  * @memberof Shot
36
37
  */
37
38
  mainSubjects?: MainSubject[];
39
+ /**
40
+ * Content advisory detection results for this shot, such as tobacco or vaping imagery
41
+ * @type {ShotAdvisories}
42
+ * @memberof Shot
43
+ */
44
+ shotAdvisories?: ShotAdvisories;
38
45
  constructor(obj?: Partial<Shot>);
39
46
  }
40
47
  export default Shot;
@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Shot = void 0;
4
4
  const Mapper_1 = require("../common/Mapper");
5
5
  const MainSubject_1 = require("./MainSubject");
6
+ const ShotAdvisories_1 = require("./ShotAdvisories");
6
7
  /**
7
8
  * Represents a continuous camera shot within a scene, containing detailed visual analysis including subjects, timing, and descriptive metadata
8
9
  * @export
@@ -18,6 +19,7 @@ class Shot {
18
19
  this.detailedDescription = (0, Mapper_1.map)(obj.detailedDescription);
19
20
  this.keywords = (0, Mapper_1.mapArray)(obj.keywords);
20
21
  this.mainSubjects = (0, Mapper_1.mapArray)(obj.mainSubjects, MainSubject_1.default);
22
+ this.shotAdvisories = (0, Mapper_1.map)(obj.shotAdvisories, ShotAdvisories_1.default);
21
23
  }
22
24
  }
23
25
  exports.Shot = Shot;
@@ -0,0 +1,23 @@
1
+ import AdvisoryAnalysisStatus from './AdvisoryAnalysisStatus';
2
+ import ContentAdvisory from './ContentAdvisory';
3
+ /**
4
+ * The result of content advisory detection for a shot, covering both what was detected and whether the shot was assessed at all
5
+ * @export
6
+ * @class ShotAdvisories
7
+ */
8
+ export declare class ShotAdvisories {
9
+ /**
10
+ * Whether and how the shot was assessed for content advisories (required)
11
+ * @type {AdvisoryAnalysisStatus}
12
+ * @memberof ShotAdvisories
13
+ */
14
+ status?: AdvisoryAnalysisStatus;
15
+ /**
16
+ * The advisory-relevant imagery detected in this shot. Empty when the shot was assessed and nothing was found, or when it was not assessed at all (required)
17
+ * @type {ContentAdvisory[]}
18
+ * @memberof ShotAdvisories
19
+ */
20
+ advisories?: ContentAdvisory[];
21
+ constructor(obj?: Partial<ShotAdvisories>);
22
+ }
23
+ export default ShotAdvisories;