@osaas/client-transcode - npm Package Compare versions

Comparing version 0.14.2 to 0.14.3

lib/pool.d.ts

 /// <reference types="node" />
 import { Context } from '@osaas/client-core';
-export type TranscodeOptions = {
+export type PoolTranscodeOptions = {
     profile?: string;
@@ -35,3 +35,3 @@ duration?: number;
     /**
-     * @typedef TranscodeOptions
+     * @typedef PoolTranscodeOptions
      * @type object
@@ -74,3 +74,3 @@ * @property {string?} profile - Transcoding profile to use (default: program)
      * @param {URL} destination - Destination URL of the transcoded media files (supported protocols: s3)
-     * @param {TranscodeOptions} options - Transcode options
+     * @param {PoolTranscodeOptions} options - Transcode options
      * @example
@@ -86,4 +86,4 @@ * const source = new URL('https://example.com/video.mp4');
      */
-    transcode(source: URL, destination: URL, { profile, duration, packageDestination }: TranscodeOptions): Promise<void>;
+    transcode(source: URL, destination: URL, { profile, duration, packageDestination }: PoolTranscodeOptions): Promise<void>;
 }
 //# sourceMappingURL=pool.d.ts.map

lib/pool.js

@@ -34,3 +34,3 @@ "use strict";
     /**
-     * @typedef TranscodeOptions
+     * @typedef PoolTranscodeOptions
      * @type object
@@ -151,3 +151,3 @@ * @property {string?} profile - Transcoding profile to use (default: program)
      * @param {URL} destination - Destination URL of the transcoded media files (supported protocols: s3)
-     * @param {TranscodeOptions} options - Transcode options
+     * @param {PoolTranscodeOptions} options - Transcode options
      * @example
@@ -154,0 +154,0 @@ * const source = new URL('https://example.com/video.mp4');

lib/transcode.d.ts

@@ -6,41 +6,11 @@ /// <reference types="node" />
 }
-/**
- * @memberof module:@osaas/client-transcode
- */
 export interface TranscodeOptions {
-    /**
-     * The name of the Encore instance
-     */
     encoreInstanceName: string;
-    /**
-     * External Id for external backreference
-     */
     externalId: string;
-    /**
-     * URL to the input file (S3 and HTTPS supported)
-     */
     inputUrl: URL;
-    /**
-     * URL to the output folder (S3 supported)
-     */
     outputUrl: URL;
-    /**
-     * Callback URL to receive progress
-     */
     callBackUrl?: URL;
-    /**
-     * Base name for the output files (prefix)
-     */
     baseName?: string;
-    /**
-     * Profile to use for transcoding
-     */
     profile?: string;
-    /**
-     * Frame rate of the input video (required when injecting IDR key frames)
-     */
     frameRate?: number;
-    /**
-     * List of SMPTE timecodes for IDR key frames
-     */
     injectIDRKeyFrames?: IDRKeyFrame[];
@@ -50,2 +20,14 @@ }
 /**
+ * @typedef {object} TranscodeOptions
+ * @property {string} encoreInstanceName - The name of the Encore instance
+ * @property {string} externalId - External Id for external backreference
+ * @property {URL} inputUrl - URL to the input file (S3 and HTTPS supported)
+ * @property {URL} outputUrl - URL to the output folder (S3 supported)
+ * @property {URL} [callBackUrl] - Callback URL to receive progress
+ * @property {string} [baseName] - Base name for the output files (prefix)
+ * @property {string} [profile] - Profile to use for transcoding
+ * @property {number} [frameRate] - Frame rate of the input video (required when injecting IDR key frames)
+ * @property {IDRKeyFrame[]} [injectIDRKeyFrames] - List of SMPTE timecodes for IDR key frames
+ */
+/**
  * Transcode a video file using SVT Encore in Eyevinn Open Source Cloud
@@ -55,3 +37,3 @@ *
  * @param ctx - Eyevinn OSC context
- * @param opts - Transcode options
+ * @param {TranscodeOptions} opts - Transcode options
  * @returns {Job} - The created Encore job
@@ -58,0 +40,0 @@ *

lib/transcode.js

@@ -19,2 +19,14 @@ "use strict";
 /**
+ * @typedef {object} TranscodeOptions
+ * @property {string} encoreInstanceName - The name of the Encore instance
+ * @property {string} externalId - External Id for external backreference
+ * @property {URL} inputUrl - URL to the input file (S3 and HTTPS supported)
+ * @property {URL} outputUrl - URL to the output folder (S3 supported)
+ * @property {URL} [callBackUrl] - Callback URL to receive progress
+ * @property {string} [baseName] - Base name for the output files (prefix)
+ * @property {string} [profile] - Profile to use for transcoding
+ * @property {number} [frameRate] - Frame rate of the input video (required when injecting IDR key frames)
+ * @property {IDRKeyFrame[]} [injectIDRKeyFrames] - List of SMPTE timecodes for IDR key frames
+ */
+/**
  * Transcode a video file using SVT Encore in Eyevinn Open Source Cloud
@@ -24,3 +36,3 @@ *
  * @param ctx - Eyevinn OSC context
- * @param opts - Transcode options
+ * @param {TranscodeOptions} opts - Transcode options
  * @returns {Job} - The created Encore job
@@ -27,0 +39,0 @@ *

package.json

 {
   "name": "@osaas/client-transcode",
-  "version": "0.14.2",
+  "version": "0.14.3",
   "description": "Open Source Cloud Client SDK transcode library",
@@ -29,4 +29,4 @@ "author": "Eyevinn Open Source Cloud <[e-mail]>",
     "@osaas/client-core": "^0.15.1",
-    "@osaas/client-db": "^0.4.3",
-    "@osaas/client-services": "^0.6.1",
+    "@osaas/client-db": "^0.4.4",
+    "@osaas/client-services": "^0.6.2",
     "chalk": "4.1.2",
@@ -38,3 +38,3 @@ "minio": "^8.0.2"
   },
-  "gitHead": "8ff7947a478aa3052f23ec886ba7b07439d111ea"
+  "gitHead": "056fbc930bdad5de16ee6ac83b4e4b529b4b6b1e"
 }

No alert changes

Improved metrics

Total package byte prevSize

124634

increased by0.7%

Worsened metrics

Lines of code

1777

decreased by-0.34%

Dependency changes

• Updated@osaas/client-db@^0.4.4

• Updated@osaas/client-services@^0.6.2