@bitmovin/api-sdk 1.246.0 → 1.248.0

package/dist/common/RestClient.js

@@ -240,7 +240,7 @@ var HeaderHandler = /** @class */ (function (_super) {
         var headers = {
             'X-Api-Key': apiKey,
             'X-Api-Client': 'bitmovin-api-sdk-javascript',
-            'X-Api-Client-Version': '1.246.0',
+            'X-Api-Client-Version': '1.248.0',
             'Content-Type': 'application/json'
         };
         if (tenantOrgId) {

package/dist/models/AnalyticsLicense.d.ts

@@ -86,6 +86,12 @@ export declare class AnalyticsLicense {
      * @memberof AnalyticsLicense
      */
     compressedRetentionTime?: string;
+    /**
+     * The date and time up until which the compressed data is available. Returned as ISO 8601 date-time format
+     * @type {Date}
+     * @memberof AnalyticsLicense
+     */
+    compressionAvailableTo?: Date;
     /**
      * Whitelisted domains
      * @type {AnalyticsLicenseDomain[]}

package/dist/models/AnalyticsLicense.js

@@ -27,6 +27,7 @@ var AnalyticsLicense = /** @class */ (function () {
         this.timeZone = (0, Mapper_1.map)(obj.timeZone);
         this.retentionTime = (0, Mapper_1.map)(obj.retentionTime);
         this.compressedRetentionTime = (0, Mapper_1.map)(obj.compressedRetentionTime);
+        this.compressionAvailableTo = (0, Mapper_1.map)(obj.compressionAvailableTo, Date);
         this.domains = (0, Mapper_1.mapArray)(obj.domains, AnalyticsLicenseDomain_1.default);
         this.playerDomains = (0, Mapper_1.mapArray)(obj.playerDomains);
         this.includeInInsights = (0, Mapper_1.map)(obj.includeInInsights);

package/dist/models/MainSubject.d.ts

@@ -0,0 +1,39 @@
+/**
+ * Represents a main subject or object detected within a shot, including its classification, spatial position, and appearance timing
+ * @export
+ * @class MainSubject
+ */
+export declare class MainSubject {
+    /**
+     * The category or type of the detected subject based on the YOLOv8 OIv7 (Open Images V7) object detection model (e.g., 'person', 'vehicle', 'building') (required)
+     * @type {string}
+     * @memberof MainSubject
+     */
+    classification?: string;
+    /**
+     * A detailed textual description of the subject's appearance and characteristics (required)
+     * @type {string}
+     * @memberof MainSubject
+     */
+    description?: string;
+    /**
+     * The timestamp in seconds when this subject first appears or is most prominently visible in the shot (required)
+     * @type {number}
+     * @memberof MainSubject
+     */
+    appearanceTimeInSeconds?: number;
+    /**
+     * The horizontal center position of the subject as a percentage from the left edge (0-100, where 0 is the left edge and 100 is the right edge) (required)
+     * @type {number}
+     * @memberof MainSubject
+     */
+    centerX?: number;
+    /**
+     * The vertical center position of the subject as a percentage from the top edge (0-100, where 0 is the top edge and 100 is the bottom edge) (required)
+     * @type {number}
+     * @memberof MainSubject
+     */
+    centerY?: number;
+    constructor(obj?: Partial<MainSubject>);
+}
+export default MainSubject;

package/dist/models/MainSubject.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MainSubject = void 0;
+var Mapper_1 = require("../common/Mapper");
+/**
+ * Represents a main subject or object detected within a shot, including its classification, spatial position, and appearance timing
+ * @export
+ * @class MainSubject
+ */
+var MainSubject = /** @class */ (function () {
+    function MainSubject(obj) {
+        if (!obj) {
+            return;
+        }
+        this.classification = (0, Mapper_1.map)(obj.classification);
+        this.description = (0, Mapper_1.map)(obj.description);
+        this.appearanceTimeInSeconds = (0, Mapper_1.map)(obj.appearanceTimeInSeconds);
+        this.centerX = (0, Mapper_1.map)(obj.centerX);
+        this.centerY = (0, Mapper_1.map)(obj.centerY);
+    }
+    return MainSubject;
+}());
+exports.MainSubject = MainSubject;
+exports.default = MainSubject;

package/dist/models/Scene.d.ts

@@ -1,6 +1,7 @@
 import Content from './Content';
 import IABTaxonomy from './IABTaxonomy';
 import SceneType from './SceneType';
+import Shot from './Shot';
 /**
  * @export
  * @class Scene
@@ -62,6 +63,12 @@ export declare class Scene {
      * @memberof Scene
      */
     type?: SceneType;
+    /**
+     * A detailed breakdown of individual camera shots within this scene, providing granular analysis of visual content and subjects
+     * @type {Shot[]}
+     * @memberof Scene
+     */
+    shots?: Shot[];
     constructor(obj?: Partial<Scene>);
 }
 export default Scene;

package/dist/models/Scene.js

@@ -4,6 +4,7 @@ exports.Scene = void 0;
 var Mapper_1 = require("../common/Mapper");
 var Content_1 = require("./Content");
 var IABTaxonomy_1 = require("./IABTaxonomy");
+var Shot_1 = require("./Shot");
 /**
  * @export
  * @class Scene
@@ -24,6 +25,7 @@ var Scene = /** @class */ (function () {
         this.keywords = (0, Mapper_1.mapArray)(obj.keywords);
         this.iab = (0, Mapper_1.map)(obj.iab, IABTaxonomy_1.default);
         this.type = (0, Mapper_1.map)(obj.type);
+        this.shots = (0, Mapper_1.mapArray)(obj.shots, Shot_1.default);
     }
     return Scene;
 }());

package/dist/models/Shot.d.ts

@@ -0,0 +1,40 @@
+import MainSubject from './MainSubject';
+/**
+ * Represents a continuous camera shot within a scene, containing detailed visual analysis including subjects, timing, and descriptive metadata
+ * @export
+ * @class Shot
+ */
+export declare class Shot {
+    /**
+     * The start time of the shot in seconds from the beginning of the video (required)
+     * @type {number}
+     * @memberof Shot
+     */
+    startInSeconds?: number;
+    /**
+     * The end time of the shot in seconds from the beginning of the video (required)
+     * @type {number}
+     * @memberof Shot
+     */
+    endInSeconds?: number;
+    /**
+     * A comprehensive textual description of the visual content, action, and context within this shot
+     * @type {string}
+     * @memberof Shot
+     */
+    detailedDescription?: string;
+    /**
+     * A list of relevant keywords and tags that describe the content, themes, or notable elements in this shot
+     * @type {string[]}
+     * @memberof Shot
+     */
+    keywords?: string[];
+    /**
+     * A collection of the primary subjects or objects detected and tracked within this shot, including their positions and characteristics
+     * @type {MainSubject[]}
+     * @memberof Shot
+     */
+    mainSubjects?: MainSubject[];
+    constructor(obj?: Partial<Shot>);
+}
+export default Shot;

package/dist/models/Shot.js

@@ -0,0 +1,25 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Shot = void 0;
+var Mapper_1 = require("../common/Mapper");
+var MainSubject_1 = require("./MainSubject");
+/**
+ * Represents a continuous camera shot within a scene, containing detailed visual analysis including subjects, timing, and descriptive metadata
+ * @export
+ * @class Shot
+ */
+var Shot = /** @class */ (function () {
+    function Shot(obj) {
+        if (!obj) {
+            return;
+        }
+        this.startInSeconds = (0, Mapper_1.map)(obj.startInSeconds);
+        this.endInSeconds = (0, Mapper_1.map)(obj.endInSeconds);
+        this.detailedDescription = (0, Mapper_1.map)(obj.detailedDescription);
+        this.keywords = (0, Mapper_1.mapArray)(obj.keywords);
+        this.mainSubjects = (0, Mapper_1.mapArray)(obj.mainSubjects, MainSubject_1.default);
+    }
+    return Shot;
+}());
+exports.Shot = Shot;
+exports.default = Shot;

package/dist/models/Subtask.d.ts

@@ -1,6 +1,7 @@
 import BitmovinResponse from './BitmovinResponse';
 import Message from './Message';
 import Status from './Status';
+import SubtaskMetadata from './SubtaskMetadata';
 /**
  * @export
  * @class Subtask
@@ -30,6 +31,12 @@ export declare class Subtask extends BitmovinResponse {
      * @memberof Subtask
      */
     messages?: Message[];
+    /**
+     * Task specific metadata
+     * @type {SubtaskMetadata[]}
+     * @memberof Subtask
+     */
+    metadata?: SubtaskMetadata[];
     /**
      * Timestamp when the subtask was created, returned as UTC expressed in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ
      * @type {Date}

package/dist/models/Subtask.js

@@ -19,6 +19,7 @@ exports.Subtask = void 0;
 var Mapper_1 = require("../common/Mapper");
 var BitmovinResponse_1 = require("./BitmovinResponse");
 var Message_1 = require("./Message");
+var SubtaskMetadata_1 = require("./SubtaskMetadata");
 /**
  * @export
  * @class Subtask
@@ -34,6 +35,7 @@ var Subtask = /** @class */ (function (_super) {
         _this.progress = (0, Mapper_1.map)(obj.progress);
         _this.name = (0, Mapper_1.map)(obj.name);
         _this.messages = (0, Mapper_1.mapArray)(obj.messages, Message_1.default);
+        _this.metadata = (0, Mapper_1.mapArray)(obj.metadata, SubtaskMetadata_1.default);
         _this.createdAt = (0, Mapper_1.map)(obj.createdAt, Date);
         _this.updatedAt = (0, Mapper_1.map)(obj.updatedAt, Date);
         _this.startedAt = (0, Mapper_1.map)(obj.startedAt, Date);

package/dist/models/SubtaskMetadata.d.ts

@@ -0,0 +1,20 @@
+import SubtaskMetadataData from './SubtaskMetadataData';
+/**
+ * @export
+ * @class SubtaskMetadata
+ */
+export declare class SubtaskMetadata {
+    /**
+     * The timestamp of the metadata record (required)
+     * @type {Date}
+     * @memberof SubtaskMetadata
+     */
+    date?: Date;
+    /**
+     * @type {SubtaskMetadataData}
+     * @memberof SubtaskMetadata
+     */
+    data?: SubtaskMetadataData;
+    constructor(obj?: Partial<SubtaskMetadata>);
+}
+export default SubtaskMetadata;

package/dist/models/SubtaskMetadata.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubtaskMetadata = void 0;
+var Mapper_1 = require("../common/Mapper");
+var SubtaskMetadataData_1 = require("./SubtaskMetadataData");
+/**
+ * @export
+ * @class SubtaskMetadata
+ */
+var SubtaskMetadata = /** @class */ (function () {
+    function SubtaskMetadata(obj) {
+        if (!obj) {
+            return;
+        }
+        this.date = (0, Mapper_1.map)(obj.date, Date);
+        this.data = (0, Mapper_1.map)(obj.data, SubtaskMetadataData_1.default);
+    }
+    return SubtaskMetadata;
+}());
+exports.SubtaskMetadata = SubtaskMetadata;
+exports.default = SubtaskMetadata;

package/dist/models/SubtaskMetadataData.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @export
+ * @class SubtaskMetadataData
+ */
+export declare class SubtaskMetadataData {
+    /**
+     * @type {number}
+     * @memberof SubtaskMetadataData
+     */
+    avgFramesEncodedPerSecond?: number;
+    /**
+     * @type {number}
+     * @memberof SubtaskMetadataData
+     */
+    bytesEncoded?: number;
+    /**
+     * @type {number}
+     * @memberof SubtaskMetadataData
+     */
+    framesAnalysed?: number;
+    /**
+     * @type {number}
+     * @memberof SubtaskMetadataData
+     */
+    framesEncoded?: number;
+    /**
+     * @type {number}
+     * @memberof SubtaskMetadataData
+     */
+    realtimeFactor?: number;
+    /**
+     * @type {number}
+     * @memberof SubtaskMetadataData
+     */
+    size?: number;
+    constructor(obj?: Partial<SubtaskMetadataData>);
+}
+export default SubtaskMetadataData;

package/dist/models/SubtaskMetadataData.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SubtaskMetadataData = void 0;
+var Mapper_1 = require("../common/Mapper");
+/**
+ * @export
+ * @class SubtaskMetadataData
+ */
+var SubtaskMetadataData = /** @class */ (function () {
+    function SubtaskMetadataData(obj) {
+        if (!obj) {
+            return;
+        }
+        this.avgFramesEncodedPerSecond = (0, Mapper_1.map)(obj.avgFramesEncodedPerSecond);
+        this.bytesEncoded = (0, Mapper_1.map)(obj.bytesEncoded);
+        this.framesAnalysed = (0, Mapper_1.map)(obj.framesAnalysed);
+        this.framesEncoded = (0, Mapper_1.map)(obj.framesEncoded);
+        this.realtimeFactor = (0, Mapper_1.map)(obj.realtimeFactor);
+        this.size = (0, Mapper_1.map)(obj.size);
+    }
+    return SubtaskMetadataData;
+}());
+exports.SubtaskMetadataData = SubtaskMetadataData;
+exports.default = SubtaskMetadataData;

package/dist/models/index.d.ts

@@ -520,6 +520,7 @@ export * from './LiveStandbyPoolUpdate';
 export * from './LocalInput';
 export * from './LocalOutput';
 export * from './Location';
+export * from './MainSubject';
 export * from './Manifest';
 export * from './ManifestGenerator';
 export * from './ManifestResource';
@@ -682,6 +683,7 @@ export * from './SegmentsMediaInfo';
 export * from './Setting';
 export * from './SftpInput';
 export * from './SftpOutput';
+export * from './Shot';
 export * from './SidecarErrorMode';
 export * from './SidecarFile';
 export * from './SidecarFileType';
@@ -771,6 +773,8 @@ export * from './StreamsVideoResponse';
 export * from './StreamsVideoStatus';
 export * from './StreamsVideoUpdateRequest';
 export * from './Subtask';
+export * from './SubtaskMetadata';
+export * from './SubtaskMetadataData';
 export * from './SubtitleAdaptationSet';
 export * from './SubtitleConfiguration';
 export * from './SubtitleStream';

package/dist/models/index.js

@@ -536,6 +536,7 @@ __exportStar(require("./LiveStandbyPoolUpdate"), exports);
 __exportStar(require("./LocalInput"), exports);
 __exportStar(require("./LocalOutput"), exports);
 __exportStar(require("./Location"), exports);
+__exportStar(require("./MainSubject"), exports);
 __exportStar(require("./Manifest"), exports);
 __exportStar(require("./ManifestGenerator"), exports);
 __exportStar(require("./ManifestResource"), exports);
@@ -698,6 +699,7 @@ __exportStar(require("./SegmentsMediaInfo"), exports);
 __exportStar(require("./Setting"), exports);
 __exportStar(require("./SftpInput"), exports);
 __exportStar(require("./SftpOutput"), exports);
+__exportStar(require("./Shot"), exports);
 __exportStar(require("./SidecarErrorMode"), exports);
 __exportStar(require("./SidecarFile"), exports);
 __exportStar(require("./SidecarFileType"), exports);
@@ -787,6 +789,8 @@ __exportStar(require("./StreamsVideoResponse"), exports);
 __exportStar(require("./StreamsVideoStatus"), exports);
 __exportStar(require("./StreamsVideoUpdateRequest"), exports);
 __exportStar(require("./Subtask"), exports);
+__exportStar(require("./SubtaskMetadata"), exports);
+__exportStar(require("./SubtaskMetadataData"), exports);
 __exportStar(require("./SubtitleAdaptationSet"), exports);
 __exportStar(require("./SubtitleConfiguration"), exports);
 __exportStar(require("./SubtitleStream"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitmovin/api-sdk",
-  "version": "1.246.0",
+  "version": "1.248.0",
   "description": "Bitmovin JS/TS API SDK",
   "author": "Bitmovin Inc",
   "keywords": [