2.1.5 update (#64)

dist/types/common.d.ts

@@ -588,17 +588,77 @@ export enum MeetingQueryStatus {
    */
   Default = '',
 }
+/**
+ * The parent class of all source video stream processors.
+ * > ***Note***: It is only available in the video processor worker.
+ *
+ * @category Global
+ */
+export abstract class VideoProcessor {
+  /**
+   * constructor
+   * @param port message port
+   * @param options customised options
+   */
+  public constructor(port: MessagePort, options?: any);
+  /**
+   * The communication port used for messaging between the processor and the main thread.
+   */
+  protected port: MessagePort;
+  /**
+   * Function to retrieve an OffscreenCanvas that renders the current output frame or processed result.
+   */
+  public getOutput(): OffscreenCanvas | null;
+  /**
+   * Callback triggered during the initialization of the processor.
+   */
+  public onInit(): void;
+  /**
+   * Callback triggered during the uninitialization of the processor.
+   */
+  public onUninit(): void;
+  /**
+   * Processes a video frame and optionally applies effects or modifications.
+   */
+  public abstract processFrame(
+    /**
+     * The input video frame to be processed.
+     */
+    input: VideoFrame,
+    /**
+     * The canvas where the processed frame is rendered.
+     */
+    output: OffscreenCanvas,
+  ): boolean | Promise<boolean>;
+}
+/**
+ * Registers a custom video processor class.
+ *> ***Note***: It is only available in the processor worker.
+ * @param name The name of the processor
+ * @param processor The processor class
+ *
+ * @category Global
+ */
+export function registerProcessor(
+  name: string,
+  processor: typeof VideoProcessor,
+): void;
 /**
  * Custom web component for video render
+ *
+ * @category Global
  */
 export declare class VideoPlayer extends HTMLElement {
   ['node-id']: string;
   ['video-quality']: string;
 }
 /**
  * Custom web component for video render container
+ *
+ * @category Global
  */
 export declare class VideoPlayerContainer extends HTMLElement {}
+
 /**
  * CRC device call out return code
  */
@@ -703,3 +763,48 @@ export enum ActiveMediaFailedCode {
    */
   SharingStreamFailed = 301,
 }
+
+/**
+ * Processor type
+ */
+type MediaType = 'audio' | 'video' | 'share';
+
+/**
+ * Processor instance
+ */
+export interface Processor {
+  /**
+   * Processor name
+   */
+  name: string;
+  /**
+   * Processor type, currently only supports video
+   */
+  type: MediaType;
+  /**
+   * Communication interface with processor
+   */
+  port: MessagePort;
+}
+
+/**
+ * Processor construction parameters
+ */
+export interface ProcessorParams {
+  /**
+   * Load the processor script from the absolute URL (the processor script must be from the same origin or CORS must be enabled).
+   */
+  url: string;
+  /**
+   * Processor name
+   */
+  name: string;
+  /**
+   * Processor type, currently only supports video
+   */
+  type: MediaType;
+  /**
+   * Parameters to pass into the processor constructor
+   */
+  options?: any;
+}

dist/types/event-callback.d.ts

@@ -1726,6 +1726,7 @@ export declare function event_chat_file_download_progress(payload: {
 }): void;
 
 /**
+ * @ignore
  * Occurs when the smart summary status changes.
  * @param payload
  */
@@ -1735,8 +1736,10 @@ export declare function event_smart_summary_change(payload: {
 }): void;
 
 /**
+ * @ignore
  * Occurs when the meeting query status changes.
  * @param payload
+ *
  */
 export declare function event_meeting_query_change(payload: {
   support?: boolean;

dist/types/media.d.ts

@@ -10,6 +10,8 @@ import {
   VideoPlayer,
   ExecutedFailure,
   CRCProtocol,
+  ProcessorParams,
+  Processor,
 } from './common';
 
 /**
@@ -703,6 +705,7 @@ export interface CallInInfo {
    */
   tollNumbers: Array<DialInNumber>;
 }
+
 /**
  * The stream interface provides methods that define the behaviors of a stream object, such as mute audio or capture video.
  *
@@ -1096,6 +1099,15 @@ export declare namespace Stream {
    * @category Audio
    */
   function muteAudioUponStartAudio(enable?: boolean): ExecutedResult;
+  /**
+   * The host can set to allow users to unmute themselves.
+   * - Only the **host** or **manager** can do this.
+   * @param enable
+   *
+   * @return executed promise.
+   * @category Audio
+   */
+  function allowAudioUnmutedBySelf(enable: boolean): ExecutedResult;
   /**
    * Determines whether the user is muted.
    * - If the user ID is not specified, gets the muted status of the current user.
@@ -1206,6 +1218,12 @@ export declare namespace Stream {
         playback: boolean;
       })
     | null;
+  /**
+   * Determines whether users are allowed to unmute their audio themselves.
+   * @returns Boolean.
+   * @category Audio
+   */
+  function isAllowAudioUnmutedBySelf(): boolean;
 
   // -------------------------------------------------[video]-----------------------------------------------------------
 
@@ -2448,4 +2466,41 @@ export declare namespace Stream {
    * @ignore
    */
   function isRemoteControlEnabled(): boolean;
+  /**
+   * Create a processor.
+   *
+   * @param param Required. Processor parameters.
+   *
+   * @returns
+   * - `Processor`: Processor instance.
+   * @category Processor
+   */
+  function createProcessor(param: ProcessorParams): Promise<Processor>;
+  /**
+   * Add the processor to the current media stream.
+   *
+   * @param processor required. The processor instance you want to add.
+   *
+   * @returns
+   * - `''`: Success
+   * @category Processor
+   */
+  function addProcessor(processor: Processor): Promise<''>;
+  /**
+   * Remove the current media stream processor.
+   *
+   * @param processor required. The processor instance you want to remove.
+   *
+   * @returns
+   * - `''`: Success
+   * @category Processor
+   */
+  function removeProcessor(processor: Processor): Promise<''>;
+  /**
+   * Determines whether the current platform supports the video processor.
+   *
+   * @returns Whether the current platform supports the video processor.
+   * @category Processor
+   */
+  function isSupportVideoProcessor(): boolean;
 }

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoom/videosdk",
-  "version": "2.1.0",
+  "version": "2.1.5",
   "description": "Zoom Web Video SDK",
   "main": "dist/index.js",
   "module": "dist/index.esm.js",