agora-electron-sdk 4.5.2 → 4.5.3-dev.2

package/ts/Renderer/YUVCanvasRenderer/index.ts

@@ -1,4 +1,5 @@
 import { VideoFrame } from '../../Private/AgoraMediaBase';
+import { RendererContext } from '../../Types';
 import { IRenderer } from '../IRenderer';
 
 const YUVBuffer = require('yuv-buffer');
@@ -7,25 +8,28 @@ const YUVCanvas = require('yuv-canvas');
 export class YUVCanvasRenderer extends IRenderer {
   private frameSink?: any;
 
-  public override bind(element: HTMLElement) {
-    super.bind(element);
+  public override bind(context: RendererContext) {
+    super.bind(context);
     this.frameSink = YUVCanvas.attach(this.canvas, {
       webGL: false,
     });
   }
 
-  public override drawFrame({
-    width,
-    height,
-    yStride,
-    uStride,
-    vStride,
-    yBuffer,
-    uBuffer,
-    vBuffer,
-    rotation,
-    alphaBuffer,
-  }: VideoFrame) {
+  public override drawFrame(
+    uid: number,
+    {
+      width,
+      height,
+      yStride,
+      uStride,
+      vStride,
+      yBuffer,
+      uBuffer,
+      vBuffer,
+      rotation,
+      alphaBuffer,
+    }: VideoFrame
+  ) {
     this.rotateCanvas({ width, height, rotation });
     this.updateRenderMode();
 
@@ -52,10 +56,19 @@ export class YUVCanvasRenderer extends IRenderer {
         stride: vStride,
       }
     );
-    frame.a = alphaBuffer;
+    if (
+      alphaBuffer &&
+      alphaBuffer.length > 0 &&
+      alphaBuffer.length === width! * height!
+    ) {
+      frame.a =
+        alphaBuffer instanceof Uint8Array
+          ? alphaBuffer
+          : new Uint8Array(alphaBuffer);
+    }
     this.frameSink.drawFrame(frame);
 
-    super.drawFrame();
+    super.drawFrame(uid);
   }
 
   protected override rotateCanvas({ width, height, rotation }: VideoFrame) {

package/ts/Types.ts

@@ -1,8 +1,4 @@
-import {
-  AdvanceOptions,
-  VideoCanvas,
-  VideoCodecType,
-} from './Private/AgoraBase';
+import { VideoCanvas, VideoCodecType } from './Private/AgoraBase';
 import { VideoFrame } from './Private/AgoraMediaBase';
 import { RtcConnection } from './Private/IAgoraRtcEngineEx';
 import { CapabilityManager } from './Renderer/CapabilityManager';
@@ -51,11 +47,11 @@ export interface AgoraEnvOptions {
   /**
    * @ignore
    */
-  encodeAlpha: boolean;
+  maxDecodeRetryCount: number;
   /**
    * @ignore
    */
-  maxDecodeRetryCount: number;
+  enableArgusCounters: boolean;
 }
 
 /**
@@ -104,6 +100,7 @@ export type RendererCacheContext = Pick<
   | 'useWebCodecsDecoder'
   | 'enableFps'
   | 'position'
+  | 'enableAlphaMask'
 >;
 
 /**
@@ -162,10 +159,18 @@ export interface IAgoraElectronBridge {
   GetVideoFrame(
     context: RendererCacheContext,
     videoFrame: VideoFrame,
-    advanceOptions: AdvanceOptions
+    advanceOptions: {
+      renderAlpha: boolean;
+      /**
+       * @ignore
+       */
+    }
   ): {
     ret: number;
-    isNewFrame: boolean;
+    /**
+     * @ignore
+     */
+    hasMoreFrame: boolean;
   };
 
   sendMsg: (

package/ts/Utils.ts

@@ -100,14 +100,14 @@ export function classMix(...mixins: any[]): any {
   class MixClass {
     constructor() {
       for (let mixin of mixins) {
-        copyProperties(this, new mixin()); // 拷贝实例属性
+        copyProperties(this, new mixin()); // Copy instance properties
       }
     }
   }
 
   for (let mixin of mixins) {
-    copyProperties(MixClass, mixin); // 拷贝静态属性
-    copyProperties(MixClass.prototype, mixin.prototype); // 拷贝原型属性
+    copyProperties(MixClass, mixin); // Copy static properties
+    copyProperties(MixClass.prototype, mixin.prototype); // Copy prototype properties
   }
 
   return MixClass;
@@ -158,7 +158,8 @@ export function isSupportWebGL(): boolean {
  */
 export function getContextByCanvas(
   // eslint-disable-next-line auto-import/auto-import
-  canvas: OffscreenCanvas
+  canvas: OffscreenCanvas,
+  enableAlphaMask: boolean = false
 ): WebGLRenderingContext | WebGL2RenderingContext | null {
   const contextNames = ['webgl2', 'webgl', 'experimental-webgl'];
 
@@ -167,10 +168,10 @@ export function getContextByCanvas(
     const context = canvas.getContext(contextName, {
       depth: true,
       stencil: true,
-      alpha: false,
+      alpha: enableAlphaMask,
       antialias: false,
       premultipliedAlpha: true,
-      preserveDrawingBuffer: true,
+      preserveDrawingBuffer: !enableAlphaMask,
       powerPreference: 'default',
       failIfMajorPerformanceCaveat: false,
     }) as WebGLRenderingContext | WebGL2RenderingContext | null;
@@ -191,7 +192,7 @@ export const AgoraEnv: AgoraEnvType = {
   enableDebugLogging: false,
   webEnvReady: true,
   enableWebCodecsDecoder: false,
-  encodeAlpha: false,
   videoFallbackStrategy: VideoFallbackStrategy.PerformancePriority,
   maxDecodeRetryCount: 50,
+  enableArgusCounters: true,
 };

package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts

@@ -0,0 +1,168 @@
+import { MediaSourceType } from 'agora-electron-sdk';
+export declare const CUSTOM_VIDEO_EFFECT_BUNDLE_RELATIVE_PATH = "AgoraBeautyMaterial/beauty_material_functional";
+export declare const CLEAR_VISION_EXTENSION_PROVIDER = "agora_video_filters_clear_vision";
+export declare const CLEAR_VISION_EXTENSION_NAME = "clear_vision";
+export declare const DEFAULT_VIDEO_EFFECT_BUNDLE_RELATIVE_PATH = "beauty_agora/beauty_material.bundle/beauty_material_v2.0.0";
+export declare const VIDEO_EFFECT_BUNDLE_RELATIVE_PATH_CANDIDATES: string[];
+export interface VideoEffectOperation {
+    kind: 'bool' | 'int' | 'float';
+    option: string;
+    key: string;
+    value: boolean | number;
+}
+export interface MakeupOptions {
+    enable_mu: boolean;
+    browStyle: number;
+    browColor: number;
+    browStrength: number;
+    lashStyle: number;
+    lashColor: number;
+    lashStrength: number;
+    shadowStyle: number;
+    shadowStrength: number;
+    pupilStyle: number;
+    pupilStrength: number;
+    blushStyle: number;
+    blushColor: number;
+    blushStrength: number;
+    lipStyle: number;
+    lipColor: number;
+    lipStrength: number;
+}
+export interface FaceShapeOptions {
+    shapeArea: number;
+    shapeIntensity: number;
+    shapeStyle: number;
+    styleIntensity: number;
+}
+export interface SdkDrivenBeautyOptions {
+    smoothness: number;
+    lightness: number;
+    redness: number;
+    eyePouch: number;
+    faceStyle: number;
+    faceIntensity: number;
+}
+export declare const BEAUTY_TEMPLATES: {
+    readonly basic: {
+        readonly label: "Basic (基础)";
+        readonly templateName: "Beauty-Basic";
+    };
+};
+export declare const STYLE_MAKEUP_TEMPLATES: {
+    readonly none: {
+        readonly label: "None";
+        readonly templateName: null;
+    };
+    readonly natural: {
+        readonly label: "Natural (百熙)";
+        readonly templateName: "Makeup-Natural";
+    };
+};
+export declare const FILTER_TEMPLATES: {
+    readonly none: {
+        readonly label: "None";
+        readonly templateName: null;
+    };
+    readonly whiteTea: {
+        readonly label: "Whitetea (白茶)";
+        readonly templateName: "Filter-Whitetea";
+    };
+};
+export declare const DEFAULT_MAKEUP_OPTIONS: MakeupOptions;
+export declare const FACE_SHAPE_AREAS: {
+    readonly FaceShapeAreaNone: -1;
+    readonly FaceShapeAreaHeadscale: 100;
+    readonly FaceShapeAreaForehead: 101;
+    readonly FaceShapeAreaFacecontour: 102;
+    readonly FaceShapeAreaFacelength: 103;
+    readonly FaceShapeAreaFacewidth: 104;
+    readonly FaceShapeAreaCheekbone: 105;
+    readonly FaceShapeAreaCheek: 106;
+    readonly FaceShapeAreaChin: 108;
+    readonly FaceShapeAreaEyescale: 200;
+    readonly FaceShapeAreaNoselength: 300;
+    readonly FaceShapeAreaNosewidth: 301;
+    readonly FaceShapeAreaMouthscale: 400;
+};
+export declare const FACE_SHAPE_BEAUTY_STYLES: {
+    readonly FaceShapeBeautyStyleFemale: 0;
+    readonly FaceShapeBeautyStyleMale: 1;
+};
+export declare const DEFAULT_FACE_SHAPE_OPTIONS: FaceShapeOptions;
+export declare const DEFAULT_SDK_DRIVEN_BEAUTY_OPTIONS: SdkDrivenBeautyOptions;
+export declare const MAKEUP_ITEMS: {
+    browStyle: string[];
+    browColor: string[];
+    lashStyle: string[];
+    lashColor: string[];
+    shadowStyle: string[];
+    pupilStyle: string[];
+    blushStyle: string[];
+    blushColor: string[];
+    lipStyle: string[];
+    lipColor: string[];
+};
+export declare function toIndexedItems(labels: string[]): {
+    label: string;
+    value: number;
+}[];
+export declare const FACE_SHAPE_AREA_ITEMS: ({
+    label: string;
+    value: -1;
+} | {
+    label: string;
+    value: 100;
+} | {
+    label: string;
+    value: 101;
+} | {
+    label: string;
+    value: 102;
+} | {
+    label: string;
+    value: 103;
+} | {
+    label: string;
+    value: 104;
+} | {
+    label: string;
+    value: 105;
+} | {
+    label: string;
+    value: 106;
+} | {
+    label: string;
+    value: 108;
+} | {
+    label: string;
+    value: 200;
+} | {
+    label: string;
+    value: 300;
+} | {
+    label: string;
+    value: 301;
+} | {
+    label: string;
+    value: 400;
+})[];
+export declare const FACE_SHAPE_STYLE_ITEMS: ({
+    label: string;
+    value: 0;
+} | {
+    label: string;
+    value: 1;
+})[];
+export declare function mapUiToResourceId(resourceType: string, uiIndex: number): number;
+export declare function getFaceShapeAreaParamName(shapeArea: number): string;
+export declare function resolveVideoEffectBundlePath(resolveAbsolutePath: (relativePath: string) => string, exists: (absolutePath: string) => boolean): string;
+export declare function releaseVideoEffectResources(engine: {
+    destroyVideoEffectObject?: (videoEffectObject: any) => void;
+    enableExtension?: (provider: string, extension: string, enable?: boolean, type?: MediaSourceType) => void;
+} | undefined, videoEffectObject: any): void;
+export declare function buildSdkDrivenBeautyOperations(options: SdkDrivenBeautyOptions): VideoEffectOperation[];
+export declare function buildStyleEffectOperations(option: 'style_effect_option' | 'filter_effect_option', value: number): VideoEffectOperation[];
+export declare function buildMakeupEffectOperations(options: MakeupOptions): VideoEffectOperation[];
+export declare function buildFaceShapeEffectOperations(options: FaceShapeOptions): VideoEffectOperation[];
+//# sourceMappingURL=videoEffectHelpers.d.ts.map

package/types/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"videoEffectHelpers.d.ts","sourceRoot":"","sources":["../../../../../../../example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.tsx"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AAErD,eAAO,MAAM,wCAAwC,mDACH,CAAC;AACnD,eAAO,MAAM,+BAA+B,qCACR,CAAC;AACrC,eAAO,MAAM,2BAA2B,iBAAiB,CAAC;AAC1D,eAAO,MAAM,yCAAyC,+DACQ,CAAC;AAC/D,eAAO,MAAM,4CAA4C,UAKxD,CAAC;AAEF,MAAM,WAAW,oBAAoB;IACnC,IAAI,EAAE,MAAM,GAAG,KAAK,GAAG,OAAO,CAAC;IAC/B,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,OAAO,GAAG,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,SAAS,EAAE,OAAO,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;IACrB,WAAW,EAAE,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IACnB,UAAU,EAAE,MAAM,CAAC;IACnB,aAAa,EAAE,MAAM,CAAC;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B,SAAS,EAAE,MAAM,CAAC;IAClB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC,UAAU,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,eAAO,MAAM,gBAAgB;;;;;CAKnB,CAAC;AAEX,eAAO,MAAM,sBAAsB;;;;;;;;;CASzB,CAAC;AAEX,eAAO,MAAM,gBAAgB;;;;;;;;;CASnB,CAAC;AAEX,eAAO,MAAM,sBAAsB,EAAE,aAkBpC,CAAC;AAEF,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;CAcnB,CAAC;AAEX,eAAO,MAAM,wBAAwB;;;CAG3B,CAAC;AAEX,eAAO,MAAM,0BAA0B,EAAE,gBAKxC,CAAC;AAEF,eAAO,MAAM,iCAAiC,EAAE,sBAO/C,CAAC;AAEF,eAAO,MAAM,YAAY;;;;;;;;;;;CAWxB,CAAC;AAEF,wBAAgB,cAAc,CAAC,MAAM,EAAE,MAAM,EAAE;;;IAK9C;AAED,eAAO,MAAM,qBAAqB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAqDjC,CAAC;AAEF,eAAO,MAAM,sBAAsB;;;;;;IASlC,CAAC;AAwBF,wBAAgB,iBAAiB,CAAC,YAAY,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,UAMtE;AAED,wBAAgB,yBAAyB,CAAC,SAAS,EAAE,MAAM,UAE1D;AAED,wBAAgB,4BAA4B,CAC1C,mBAAmB,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,MAAM,EACrD,MAAM,EAAE,CAAC,YAAY,EAAE,MAAM,KAAK,OAAO,UAQ1C;AAED,wBAAgB,2BAA2B,CACzC,MAAM,EACF;IACE,wBAAwB,CAAC,EAAE,CAAC,iBAAiB,EAAE,GAAG,KAAK,IAAI,CAAC;IAC5D,eAAe,CAAC,EAAE,CAChB,QAAQ,EAAE,MAAM,EAChB,SAAS,EAAE,MAAM,EACjB,MAAM,CAAC,EAAE,OAAO,EAChB,IAAI,CAAC,EAAE,eAAe,KACnB,IAAI,CAAC;CACX,GACD,SAAS,EACb,iBAAiB,EAAE,GAAG,QAYvB;AAED,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,sBAAsB,GAC9B,oBAAoB,EAAE,CAuCxB;AAED,wBAAgB,0BAA0B,CACxC,MAAM,EAAE,qBAAqB,GAAG,sBAAsB,EACtD,KAAK,EAAE,MAAM,GACZ,oBAAoB,EAAE,CASxB;AAED,wBAAgB,2BAA2B,CACzC,OAAO,EAAE,aAAa,GACrB,oBAAoB,EAAE,CAkHxB;AAED,wBAAgB,8BAA8B,CAC5C,OAAO,EAAE,gBAAgB,GACxB,oBAAoB,EAAE,CAiCxB"}

package/types/{AgoraSdk.d.ts → ts/AgoraSdk.d.ts}

@@ -19,21 +19,11 @@ export * from './Renderer';
 export * from './Types';
 export * from './Utils';
 /**
- * Creates one IRtcEngineEx object.
- *
- * Currently, the Agora RTC SDK v4.x supports creating only one IRtcEngineEx object for each app.
- *
- * @returns
- * One IRtcEngineEx object.
+ * @ignore
  */
 export declare function createAgoraRtcEngine(options?: AgoraEnvOptions): IRtcEngineEx;
 /**
- * Gets one IMediaPlayerCacheManager instance.
- *
- * Before calling any APIs in the IMediaPlayerCacheManager class, you need to call this method to get a cache manager instance of a media player.
- *
- * @returns
- * The IMediaPlayerCacheManager instance.
+ * @ignore
  */
 export declare function getMediaPlayerCacheManager(): IMediaPlayerCacheManager;
 export default createAgoraRtcEngine;

package/types/ts/AgoraSdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AgoraSdk.d.ts","sourceRoot":"","sources":["../../ts/AgoraSdk.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,wBAAwB,EAAE,MAAM,6BAA6B,CAAC;AACvE,OAAO,EAAE,YAAY,EAAE,MAAM,6BAA6B,CAAC;AAE3D,OAAO,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAG1C,cAAc,qBAAqB,CAAC;AACpC,cAAc,0BAA0B,CAAC;AACzC,cAAc,iCAAiC,CAAC;AAChD,cAAc,qBAAqB,CAAC;AACpC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,mCAAmC,CAAC;AAClD,cAAc,+BAA+B,CAAC;AAC9C,cAAc,oCAAoC,CAAC;AACnD,cAAc,8BAA8B,CAAC;AAC7C,cAAc,2BAA2B,CAAC;AAC1C,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,+BAA+B,CAAC;AAC9C,cAAc,YAAY,CAAC;AAC3B,cAAc,SAAS,CAAC;AACxB,cAAc,SAAS,CAAC;AAIxB;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,YAAY,CAG5E;AAED;;GAEG;AACH,wBAAgB,0BAA0B,IAAI,wBAAwB,CAErE;AAED,eAAe,oBAAoB,CAAC"}

package/types/ts/Decoder/gpu-utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"gpu-utils.d.ts","sourceRoot":"","sources":["../../../ts/Decoder/gpu-utils.ts"],"names":[],"mappings":"AAGA;;GAEG;AAEH,MAAM,MAAM,sCAAsC,GAAG;IACnD,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;GAEG;AACH,qBAAa,OAAO;IAClB,sCAAsC,EAAE,sCAAsC,EAAE,CAC3E;CACN;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,aAAc,GAAG,KAAG,IAiElD,CAAC"}

package/types/ts/Decoder/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../ts/Decoder/index.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,qBAAqB,EAAkB,MAAM,sBAAsB,CAAC;AAE7E,OAAO,EAAE,iBAAiB,EAAE,MAAM,qCAAqC,CAAC;AACxE,OAAO,EAAmB,oBAAoB,EAAgB,MAAM,UAAU,CAAC;AAS/E,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAe;IAC/B,OAAO,CAAC,SAAS,CAA2B;IAC5C,OAAO,CAAC,aAAa,CAAuB;IAE5C,OAAO,CAAC,YAAY,CAA2B;IAC/C,OAAO,CAAC,mBAAmB,CAAgC;IAE3D,OAAO,CAAC,QAAQ,CAAK;IACrB,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,YAAY,CAAK;IACzB,OAAO,CAAC,mBAAmB,CAAK;gBAG9B,OAAO,EAAE,iBAAiB,EAAE,EAC5B,OAAO,EAAE,CAAC,CAAC,EAAE,GAAG,KAAK,IAAI,EACzB,OAAO,EAAE,oBAAoB;IAc/B,OAAO,CAAC,KAAK,EAAE,UAAU;IAMzB,OAAO,CAAC,YAAY;IAapB,oBAAoB;IAcpB,gBAAgB,CAAC,SAAS,EAAE,qBAAqB;IA8BjD,gBAAgB,CAAC,EAAE,EAAE,MAAM;IAgB3B,oBAAoB,CAAC,SAAS,EAAE,qBAAqB;IAcrD,WAAW,CACT,WAAW,EAAE,UAAU,EACvB,SAAS,EAAE,qBAAqB,EAChC,EAAE,EAAE,MAAM;IAuDZ,KAAK;IAOL,OAAO;CASR"}