@vonage/ml-transformers 3.1.1 → 3.2.0

package/dist/types/main.d.ts

@@ -1,8 +1,8 @@
-import { EventDataMap, MediaProcessorConnectorInterface } from '@vonage/media-processor';
-import { BlurRadius, BackgroundBlurConfig, VirtualBackgroundConfig, AssetBackgroundConfig, VideoBackgroundConfig, MediaProcessorBaseConfig, SilueteBlurConfig, MediapipeConfig, MediaPipeResults, MediaPipeResultsListener, MediaPipeModelType, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, PoseResults, PoseOptions, SelfieSegmentationResults, SelfieSegmentationOptions, MediaPipeModelConfig } from './src/types';
-import { isSupported } from './src/utils/utils';
-import Emittery from 'emittery';
-import MediapipeHelper from './src/transformers/MediapipeHelper';
+import { EventDataMap, MediaProcessorConnectorInterface } from "@vonage/media-processor";
+import { BlurRadius, BackgroundBlurConfig, VirtualBackgroundConfig, AssetBackgroundConfig, VideoBackgroundConfig, MediaProcessorBaseConfig, SilueteBlurConfig, MediapipeConfig, MediaPipeResults, MediaPipeResultsListener, MediaPipeModelType, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, PoseResults, PoseOptions, SelfieSegmentationResults, SelfieSegmentationOptions, MediaPipeModelConfig } from "./src/types";
+import { isSupported } from "./src/utils/utils";
+import Emittery from "emittery";
+import MediapipeHelper from "./src/transformers/MediapipeHelper";
 /**
  * Vonage Mediapipe objects info (it will be used by the @mediapipe/drawing_utils package which is not included by this library).
  * @param VonageSelfiesegmentation:
@@ -64,13 +64,14 @@ import MediapipeHelper from './src/transformers/MediapipeHelper';
  * - POSE_LANDMARKS_RIGHT
  * - POSE_LANDMARKS_NEUTRAL
  */
-import VonageSelfiesegmentation from './src/transformers/SelfieSegmentationHelper';
-import VonageHands from './src/transformers/HandsHelper';
-import VonageHolistic from './src/transformers/HolisticHelper';
-import VonageFacedetection from './src/transformers/FaceDetectionHelper';
-import VonageFacemash from './src/transformers/FaceMashHelper';
-import VonageObjectron from './src/transformers/ObjectronHelper';
-import VonagePose from './src/transformers/PoseHelper';
+import VonageSelfiesegmentation from "./src/transformers/SelfieSegmentationHelper";
+import VonageHands from "./src/transformers/HandsHelper";
+import VonageHolistic from "./src/transformers/HolisticHelper";
+import VonageFacedetection from "./src/transformers/FaceDetectionHelper";
+import VonageFacemash from "./src/transformers/FaceMashHelper";
+import VonageObjectron from "./src/transformers/ObjectronHelper";
+import VonagePose from "./src/transformers/PoseHelper";
+import { VonageMediaProcessor } from "./src/vonage/VonageMediaProcessor";
 /**
  * BackgroundOptions background options
  */
@@ -110,37 +111,42 @@ declare type BackgroundOptions = BackgroundBlurConfig | ((VirtualBackgroundConfi
  * ```
  */
 declare type MediaProcessorConfig = MediaProcessorBaseConfig & BackgroundOptions;
+export declare function createVonageMediaProcessor(config: MediaProcessorConfig): Promise<VonageMediaProcessor>;
 /**
  * Registers for error and warn events that come from the library on run time.
  * see @EventDataMap for more info.
+ * @deprecated Use the function {@link createMediaProcessor} to instantiate a processor directly.
  */
 declare function getVonageEventEmitter(): Emittery<EventDataMap>;
 /**
-  * Sets the expected rate of the track per second.
-  * The media processor will use this number for calculating drops in the rate.
-  * This could happen when the transformation will take more time than expected.
-  * This will not cause an error, just warning to the client.
-  * Mostly:
-  * Video: 30 frames per second
-  * Audio: 50 audio data per second for OPUS
-  * @param trackExpectedRate - number holds the predicted track rate. -1 for disable this monitor.
-  */
+ * Sets the expected rate of the track per second.
+ * The media processor will use this number for calculating drops in the rate.
+ * This could happen when the transformation will take more time than expected.
+ * This will not cause an error, just warning to the client.
+ * Mostly:
+ * Video: 30 frames per second
+ * Audio: 50 audio data per second for OPUS
+ * @deprecated Use the function {@link createMediaProcessor} to instantiate a processor directly.
+ * @param trackExpectedRate - number holds the predicted track rate. -1 for disable this monitor.
+ */
 declare function setTrackExpectedRate(trackExpectedRate: number): void;
 /**
-* builder function to create MediaProcessorConnectorInterface
-* This function hides all the functionality of the @vonage/media-processor library.
-* using this create function promises the user the best performance of background operations.
-* @param config - see `MediaProcessorConfig` definition
-* @returns - `MediaProcessorConnectorInterface` feed this return value to any vonage SDK that supports this API
-*/
+ * builder function to create MediaProcessorConnectorInterface
+ * This function hides all the functionality of the @vonage/media-processor library.
+ * using this create function promises the user the best performance of background operations.
+ * @deprecated Use the function {@link createMediaProcessor} to instantiate a processor directly.
+ * @param config - see `MediaProcessorConfig` definition
+ * @returns - `MediaProcessorConnectorInterface` feed this return value to any vonage SDK that supports this API
+ */
 declare function createVonageMediaProcessorConnector(config: MediaProcessorConfig): Promise<MediaProcessorConnectorInterface>;
 /**
-* change the background option during run time using this function.
-* while using this function the media-processor will not be destroyed.
-* while using this function the library promise a full resource cleanup.
-* @param backgroundOptions - see `BackgroundOptions` definition
-* @returns - Promise<void>
-*/
+ * change the background option during run time using this function.
+ * while using this function the media-processor will not be destroyed.
+ * while using this function the library promise a full resource cleanup.
+ * @deprecated Use the function {@link createMediaProcessor} to instantiate a processor directly.
+ * @param backgroundOptions - see `BackgroundOptions` definition
+ * @returns - Promise<void>
+ */
 declare function setBackgroundOptions(backgroundOptions: BackgroundOptions): Promise<void>;
-export type { MediaProcessorBaseConfig, BackgroundBlurConfig, VirtualBackgroundConfig, VideoBackgroundConfig, AssetBackgroundConfig, SilueteBlurConfig, MediaProcessorConfig, BackgroundOptions, MediapipeConfig, MediaPipeResults, MediaPipeModelType, MediaPipeResultsListener, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, SelfieSegmentationOptions, SelfieSegmentationResults, PoseResults, PoseOptions, MediaPipeModelConfig };
-export { BlurRadius, createVonageMediaProcessorConnector, getVonageEventEmitter, setTrackExpectedRate, isSupported, MediapipeHelper, setBackgroundOptions, VonageSelfiesegmentation, VonageFacedetection, VonageFacemash, VonageHands, VonageHolistic, VonageObjectron, VonagePose };
+export type { MediaProcessorBaseConfig, BackgroundBlurConfig, VirtualBackgroundConfig, VideoBackgroundConfig, AssetBackgroundConfig, SilueteBlurConfig, MediaProcessorConfig, BackgroundOptions, MediapipeConfig, MediaPipeResults, MediaPipeModelType, MediaPipeResultsListener, FaceDetectionResults, FaceDetectionOptions, FaceMeshResults, FaceMeshOptions, HandsResults, HandsOptions, HolisticResults, HolisticOptions, ObjectronResults, ObjectronOptions, SelfieSegmentationOptions, SelfieSegmentationResults, PoseResults, PoseOptions, MediaPipeModelConfig, };
+export { VonageMediaProcessor, BlurRadius, createVonageMediaProcessorConnector, getVonageEventEmitter, setTrackExpectedRate, isSupported, MediapipeHelper, setBackgroundOptions, VonageSelfiesegmentation, VonageFacedetection, VonageFacemash, VonageHands, VonageHolistic, VonageObjectron, VonagePose, };

package/dist/types/src/vonage/VonageMediaProcessor.d.ts

@@ -0,0 +1,59 @@
+import { EventDataMap, MediaProcessorConnector } from "@vonage/media-processor";
+import Emittery from "emittery";
+import { BackgroundOptions, MediaProcessorConfig } from "../../main";
+/**
+ * Class wrapping features provided by ml-transformers.
+ */
+export declare class VonageMediaProcessor extends Emittery<EventDataMap> {
+    /**
+     * Web worker wrapper used to run the transformers
+     * @internal
+     */
+    private worker;
+    /**
+     * Usable connector for media-processor lib
+     * @internal
+     */
+    private connector;
+    /**
+     * Private constructor
+     * Use {@link create} to instantiate the class
+     * @internal
+     */
+    private constructor();
+    /**
+     * Initialize the processor worker an events
+     * @param config Configuration to initialize with
+     * @internal
+     */
+    private init;
+    /**
+     * change the background option during run time using this function.
+     * while using this function the media-processor will not be destroyed.
+     * while using this function the library promise a full resource cleanup.
+     * @param backgroundOptions - see `BackgroundOptions` definition
+     */
+    setBackgroundOptions(options: BackgroundOptions): Promise<void>;
+    /**
+     * Sets the expected rate of the track per second.
+     * The media processor will use this number for calculating drops in the rate.
+     * This could happen when the transformation will take more time than expected.
+     * This will not cause an error, just warning to the client.
+     * Mostly:
+     * Video: 30 frames per second
+     * Audio: 50 audio data per second for OPUS
+     * @param rate - number holds the predicted track rate. -1 for disable this monitor.
+     */
+    setTrackExpectedRate(rate: number): void;
+    /**
+     * Getter for MediaProcessorConnectorInterface connector attribute.
+     * @returns - `MediaProcessorConnectorInterface` feed this return value to any vonage SDK that supports this API
+     */
+    getConnector(): MediaProcessorConnector;
+    /**
+     * Asynchronous constructor of VonageMediaProcessor
+     * @param config Initial MediaProcessorConfig to use
+     * @returns Promise resolved with an initialized MediaProcessorConfig
+     */
+    static create(config: MediaProcessorConfig): Promise<VonageMediaProcessor>;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vonage/ml-transformers",
-  "version": "3.1.1",
+  "version": "3.2.0",
   "author": "Guy Mininberg <guy.mininberg@vonage.com>",
   "contributors": [
     "Guy Mininberg <guy.mininberg@vonage.com>",