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

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 
 
+## [4.5.3-dev.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.3-dev.1...v4.5.3-dev.2) (2026-04-03)
+
+## [4.5.3-dev.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.9-rc.1...v4.5.3-dev.1) (2026-04-03)
+
+
+### Features
+
+* support 4.6.2 ([#1369](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1369)) ([1b9be80](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/1b9be800cd088c3edba06c335a08eaddd6cab9a7)), closes [#1287](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1287) [#1285](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1285) [#1286](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1286)
+
+## [4.5.2-build.9-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.194-rc.1...v4.5.2-build.9-rc.1) (2026-03-25)
+
+## [4.5.2-build.194-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.180-rc.2...v4.5.2-build.194-rc.1) (2026-03-09)
+
+## [4.5.2-build.180-rc.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.174-rc.1...v4.5.2-build.180-rc.2) (2026-02-10)
+
+## [4.5.2-build.174-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.166-rc.1...v4.5.2-build.174-rc.1) (2025-12-29)
+
+## [4.5.2-build.166-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.3-rc.1...v4.5.2-build.166-rc.1) (2025-11-28)
+
+## [4.5.2-build.3-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.143-rc.1...v4.5.2-build.3-rc.1) (2025-09-04)
+
+
+### Features
+
+* support 4.5.2.3 ([#1329](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1329)) ([a3c83e5](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/a3c83e5505a7943ac00f619653268dbd76e39c09)), closes [#1327](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1327) [#1330](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1330)
+
+## [4.5.2-build.143-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.139-rc.1...v4.5.2-build.143-rc.1) (2025-07-11)
+
+## [4.5.2-build.139-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2-build.131-rc.1...v4.5.2-build.139-rc.1) (2025-06-19)
+
+## [4.5.2-build.131-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.1-build.132-rc.1...v4.5.2-build.131-rc.1) (2025-04-27)
+
+## [4.5.1-build.132-rc.1](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.2...v4.5.1-build.132-rc.1) (2025-04-23)
+
+
+### Features
+
+* support 4.5.1.132 ([#1287](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1287)) ([54b9e83](https://github.com/AgoraIO-Extensions/Electron-SDK/commit/54b9e830e3f1268f2fbe2f59e354333fdade1262)), closes [#1285](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1285) [#1286](https://github.com/AgoraIO-Extensions/Electron-SDK/issues/1286)
+
 ## [4.5.2](https://github.com/AgoraIO-Extensions/Electron-SDK/compare/v4.5.1...v4.5.2) (2025-03-11)
 
 

package/README.md

@@ -1,5 +1,8 @@
+> ⚠️ **Note**: To provide you with better and higher quality technical support services, we will no longer provide technical support through GitHub issues. If you need help, please contact us directly through [Agora Support](https://www.agora.io/en/customer-support/).
+
 > NOTE: These sdk and samples only for the Agora Video 4.x APIs. For examples using previous releases please see the following branches:
->  - [3.x](https://github.com/AgoraIO-Extensions/Electron-SDK/tree/3.x)
+>
+> - [3.x](https://github.com/AgoraIO-Extensions/Electron-SDK/tree/3.x)
 
 # Agora RTC SDK for Electron
 
@@ -73,10 +76,10 @@ npm install --agora_electron_sdk_arch=x64
 ## 🔨 Usage
 
 ```javascript
-import createAgoraRtcEngine from "agora-electron-sdk";
+import createAgoraRtcEngine from 'agora-electron-sdk';
 
 const rtcEngine = createAgoraRtcEngine();
-rtcEngine.initialize({appId: "<your agora app id>"});
+rtcEngine.initialize({ appId: '<your agora app id>' });
 ```
 
 ### When using without electron-webpack

package/js/example/src/renderer/examples/advanced/VideoEffect/videoEffectHelpers.js

@@ -0,0 +1,395 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildFaceShapeEffectOperations = exports.buildMakeupEffectOperations = exports.buildStyleEffectOperations = exports.buildSdkDrivenBeautyOperations = exports.releaseVideoEffectResources = exports.resolveVideoEffectBundlePath = exports.getFaceShapeAreaParamName = exports.mapUiToResourceId = exports.FACE_SHAPE_STYLE_ITEMS = exports.FACE_SHAPE_AREA_ITEMS = exports.toIndexedItems = exports.MAKEUP_ITEMS = exports.DEFAULT_SDK_DRIVEN_BEAUTY_OPTIONS = exports.DEFAULT_FACE_SHAPE_OPTIONS = exports.FACE_SHAPE_BEAUTY_STYLES = exports.FACE_SHAPE_AREAS = exports.DEFAULT_MAKEUP_OPTIONS = exports.FILTER_TEMPLATES = exports.STYLE_MAKEUP_TEMPLATES = exports.BEAUTY_TEMPLATES = exports.VIDEO_EFFECT_BUNDLE_RELATIVE_PATH_CANDIDATES = exports.DEFAULT_VIDEO_EFFECT_BUNDLE_RELATIVE_PATH = exports.CLEAR_VISION_EXTENSION_NAME = exports.CLEAR_VISION_EXTENSION_PROVIDER = exports.CUSTOM_VIDEO_EFFECT_BUNDLE_RELATIVE_PATH = void 0;
+const agora_electron_sdk_1 = require("agora-electron-sdk");
+exports.CUSTOM_VIDEO_EFFECT_BUNDLE_RELATIVE_PATH = 'AgoraBeautyMaterial/beauty_material_functional';
+exports.CLEAR_VISION_EXTENSION_PROVIDER = 'agora_video_filters_clear_vision';
+exports.CLEAR_VISION_EXTENSION_NAME = 'clear_vision';
+exports.DEFAULT_VIDEO_EFFECT_BUNDLE_RELATIVE_PATH = 'beauty_agora/beauty_material.bundle/beauty_material_v2.0.0';
+exports.VIDEO_EFFECT_BUNDLE_RELATIVE_PATH_CANDIDATES = [
+    exports.DEFAULT_VIDEO_EFFECT_BUNDLE_RELATIVE_PATH,
+    'beauty_agora/beauty_material.bundle/beauty_material_v2.0.0_encrypted',
+    'beauty_material.bundle/beauty_material_v2.0.0',
+    'beauty_material.bundle/beauty_material_v2.0.0_encrypted',
+];
+exports.BEAUTY_TEMPLATES = {
+    basic: {
+        label: 'Basic (基础)',
+        templateName: 'Beauty-Basic',
+    },
+};
+exports.STYLE_MAKEUP_TEMPLATES = {
+    none: {
+        label: 'None',
+        templateName: null,
+    },
+    natural: {
+        label: 'Natural (百熙)',
+        templateName: 'Makeup-Natural',
+    },
+};
+exports.FILTER_TEMPLATES = {
+    none: {
+        label: 'None',
+        templateName: null,
+    },
+    whiteTea: {
+        label: 'Whitetea (白茶)',
+        templateName: 'Filter-Whitetea',
+    },
+};
+exports.DEFAULT_MAKEUP_OPTIONS = {
+    enable_mu: false,
+    browStyle: 0,
+    browColor: 0,
+    browStrength: 0,
+    lashStyle: 0,
+    lashColor: 0,
+    lashStrength: 0,
+    shadowStyle: 0,
+    shadowStrength: 0,
+    pupilStyle: 0,
+    pupilStrength: 0,
+    blushStyle: 0,
+    blushColor: 0,
+    blushStrength: 0,
+    lipStyle: 0,
+    lipColor: 0,
+    lipStrength: 0,
+};
+exports.FACE_SHAPE_AREAS = {
+    FaceShapeAreaNone: -1,
+    FaceShapeAreaHeadscale: 100,
+    FaceShapeAreaForehead: 101,
+    FaceShapeAreaFacecontour: 102,
+    FaceShapeAreaFacelength: 103,
+    FaceShapeAreaFacewidth: 104,
+    FaceShapeAreaCheekbone: 105,
+    FaceShapeAreaCheek: 106,
+    FaceShapeAreaChin: 108,
+    FaceShapeAreaEyescale: 200,
+    FaceShapeAreaNoselength: 300,
+    FaceShapeAreaNosewidth: 301,
+    FaceShapeAreaMouthscale: 400,
+};
+exports.FACE_SHAPE_BEAUTY_STYLES = {
+    FaceShapeBeautyStyleFemale: 0,
+    FaceShapeBeautyStyleMale: 1,
+};
+exports.DEFAULT_FACE_SHAPE_OPTIONS = {
+    shapeArea: exports.FACE_SHAPE_AREAS.FaceShapeAreaNone,
+    shapeIntensity: 0,
+    shapeStyle: exports.FACE_SHAPE_BEAUTY_STYLES.FaceShapeBeautyStyleFemale,
+    styleIntensity: 0,
+};
+exports.DEFAULT_SDK_DRIVEN_BEAUTY_OPTIONS = {
+    smoothness: 0.5,
+    lightness: 0.3,
+    redness: 0,
+    eyePouch: 0,
+    faceStyle: -1,
+    faceIntensity: 50,
+};
+exports.MAKEUP_ITEMS = {
+    browStyle: ['CLOSE', 'eyebrow001', 'eyebrow002', 'eyebrow003'],
+    browColor: ['Brown', 'Gray Brown', 'Dark Brown'],
+    lashStyle: ['CLOSE', 'eyelash003', 'eyelash005'],
+    lashColor: ['Black', 'Brown', 'Blue'],
+    shadowStyle: ['CLOSE', 'eyeshadow001', 'eyeshadow006'],
+    pupilStyle: ['CLOSE', 'facial002'],
+    blushStyle: ['CLOSE', 'blush001', 'blush002', 'blush004', 'blush009'],
+    blushColor: ['Pink', 'Orange', 'Red', 'Coral', 'Purple', 'Brown'],
+    lipStyle: ['CLOSE', 'Moisturizing', 'Matte'],
+    lipColor: ['Natural', 'Pink', 'Orange', 'Red', 'Coral', 'Purple'],
+};
+function toIndexedItems(labels) {
+    return labels.map((label, index) => ({
+        label,
+        value: index,
+    }));
+}
+exports.toIndexedItems = toIndexedItems;
+exports.FACE_SHAPE_AREA_ITEMS = [
+    {
+        label: 'FACE_SHAPE_AREA_NONE',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaNone,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_HEADSCALE',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaHeadscale,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_FOREHEAD',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaForehead,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_FACECONTOUR',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaFacecontour,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_FACELENGTH',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaFacelength,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_FACEWIDTH',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaFacewidth,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_CHEEKBONE',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaCheekbone,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_CHEEK',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaCheek,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_CHIN',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaChin,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_EYESCALE',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaEyescale,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_NOSELENGTH',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaNoselength,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_NOSEWIDTH',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaNosewidth,
+    },
+    {
+        label: 'FACE_SHAPE_AREA_MOUTHSCALE',
+        value: exports.FACE_SHAPE_AREAS.FaceShapeAreaMouthscale,
+    },
+];
+exports.FACE_SHAPE_STYLE_ITEMS = [
+    {
+        label: 'FACE_SHAPE_STYLE_FEMALE',
+        value: exports.FACE_SHAPE_BEAUTY_STYLES.FaceShapeBeautyStyleFemale,
+    },
+    {
+        label: 'FACE_SHAPE_STYLE_MALE',
+        value: exports.FACE_SHAPE_BEAUTY_STYLES.FaceShapeBeautyStyleMale,
+    },
+];
+const RESOURCE_ID_MAP = {
+    eyelash: [0, 3, 5],
+    eyeshadow: [0, 1, 6],
+    blush: [0, 1, 2, 4, 9],
+    pupil: [0, 2],
+};
+const FACE_SHAPE_AREA_PARAM_NAMES = {
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaHeadscale]: 'headScale',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaForehead]: 'forehead',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaFacecontour]: 'faceContour',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaFacelength]: 'faceLength',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaFacewidth]: 'faceWidth',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaCheekbone]: 'cheekBone',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaCheek]: 'cheek',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaChin]: 'chin',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaEyescale]: 'eyeScale',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaNoselength]: 'noseLength',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaNosewidth]: 'noseWidth',
+    [exports.FACE_SHAPE_AREAS.FaceShapeAreaMouthscale]: 'mouthScale',
+};
+function mapUiToResourceId(resourceType, uiIndex) {
+    const mapping = RESOURCE_ID_MAP[resourceType];
+    if (!mapping) {
+        return uiIndex;
+    }
+    return uiIndex < mapping.length ? mapping[uiIndex] ?? 0 : 0;
+}
+exports.mapUiToResourceId = mapUiToResourceId;
+function getFaceShapeAreaParamName(shapeArea) {
+    return FACE_SHAPE_AREA_PARAM_NAMES[shapeArea] ?? '';
+}
+exports.getFaceShapeAreaParamName = getFaceShapeAreaParamName;
+function resolveVideoEffectBundlePath(resolveAbsolutePath, exists) {
+    const absoluteCandidates = exports.VIDEO_EFFECT_BUNDLE_RELATIVE_PATH_CANDIDATES.map(resolveAbsolutePath);
+    return (absoluteCandidates.find((absolutePath) => exists(absolutePath)) ??
+        absoluteCandidates[0]);
+}
+exports.resolveVideoEffectBundlePath = resolveVideoEffectBundlePath;
+function releaseVideoEffectResources(engine, videoEffectObject) {
+    if (videoEffectObject && engine?.destroyVideoEffectObject) {
+        engine.destroyVideoEffectObject(videoEffectObject);
+    }
+    engine?.enableExtension?.(exports.CLEAR_VISION_EXTENSION_PROVIDER, exports.CLEAR_VISION_EXTENSION_NAME, false, agora_electron_sdk_1.MediaSourceType.PrimaryCameraSource);
+}
+exports.releaseVideoEffectResources = releaseVideoEffectResources;
+function buildSdkDrivenBeautyOperations(options) {
+    return [
+        {
+            kind: 'float',
+            option: 'beauty_effect_option',
+            key: 'smoothness',
+            value: options.smoothness,
+        },
+        {
+            kind: 'float',
+            option: 'beauty_effect_option',
+            key: 'lightness',
+            value: options.lightness,
+        },
+        {
+            kind: 'float',
+            option: 'beauty_effect_option',
+            key: 'redness',
+            value: options.redness,
+        },
+        {
+            kind: 'float',
+            option: 'face_buffing_option',
+            key: 'eye_pouch',
+            value: options.eyePouch,
+        },
+        {
+            kind: 'int',
+            option: 'face_shape_beauty_option',
+            key: 'style',
+            value: options.faceStyle,
+        },
+        {
+            kind: 'int',
+            option: 'face_shape_beauty_option',
+            key: 'intensity',
+            value: options.faceIntensity,
+        },
+    ];
+}
+exports.buildSdkDrivenBeautyOperations = buildSdkDrivenBeautyOperations;
+function buildStyleEffectOperations(option, value) {
+    return [
+        {
+            kind: 'float',
+            option,
+            key: option === 'style_effect_option' ? 'styleIntensity' : 'strength',
+            value,
+        },
+    ];
+}
+exports.buildStyleEffectOperations = buildStyleEffectOperations;
+function buildMakeupEffectOperations(options) {
+    const operations = [
+        {
+            kind: 'bool',
+            option: 'makeup_options',
+            key: 'enable_mu',
+            value: options.enable_mu,
+        },
+    ];
+    if (!options.enable_mu) {
+        return operations;
+    }
+    operations.push({
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'browStyle',
+        value: mapUiToResourceId('eyebrow', options.browStyle),
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'browColor',
+        value: options.browColor,
+    }, {
+        kind: 'float',
+        option: 'makeup_options',
+        key: 'browStrength',
+        value: options.browStrength,
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'lashStyle',
+        value: mapUiToResourceId('eyelash', options.lashStyle),
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'lashColor',
+        value: options.lashColor,
+    }, {
+        kind: 'float',
+        option: 'makeup_options',
+        key: 'lashStrength',
+        value: options.lashStrength,
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'shadowStyle',
+        value: mapUiToResourceId('eyeshadow', options.shadowStyle),
+    }, {
+        kind: 'float',
+        option: 'makeup_options',
+        key: 'shadowStrength',
+        value: options.shadowStrength,
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'pupilStyle',
+        value: mapUiToResourceId('pupil', options.pupilStyle),
+    }, {
+        kind: 'float',
+        option: 'makeup_options',
+        key: 'pupilStrength',
+        value: options.pupilStrength,
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'blushStyle',
+        value: mapUiToResourceId('blush', options.blushStyle),
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'blushColor',
+        value: options.blushColor,
+    }, {
+        kind: 'float',
+        option: 'makeup_options',
+        key: 'blushStrength',
+        value: options.blushStrength,
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'lipStyle',
+        value: options.lipStyle,
+    }, {
+        kind: 'int',
+        option: 'makeup_options',
+        key: 'lipColor',
+        value: options.lipColor,
+    }, {
+        kind: 'float',
+        option: 'makeup_options',
+        key: 'lipStrength',
+        value: options.lipStrength,
+    });
+    return operations;
+}
+exports.buildMakeupEffectOperations = buildMakeupEffectOperations;
+function buildFaceShapeEffectOperations(options) {
+    const operations = [];
+    const faceShapeAreaParamName = getFaceShapeAreaParamName(options.shapeArea);
+    if (faceShapeAreaParamName) {
+        operations.push({
+            kind: 'float',
+            option: 'face_buffing_option',
+            key: faceShapeAreaParamName,
+            value: options.shapeIntensity / 100,
+        });
+    }
+    if (options.shapeStyle !== exports.FACE_SHAPE_BEAUTY_STYLES.FaceShapeBeautyStyleFemale) {
+        operations.push({
+            kind: 'bool',
+            option: 'face_shape_beauty_option',
+            key: 'enable',
+            value: true,
+        }, {
+            kind: 'int',
+            option: 'face_shape_beauty_option',
+            key: 'intensity',
+            value: options.styleIntensity,
+        });
+    }
+    return operations;
+}
+exports.buildFaceShapeEffectOperations = buildFaceShapeEffectOperations;

package/js/{AgoraSdk.js → ts/AgoraSdk.js}

@@ -36,12 +36,7 @@ __exportStar(require("./Types"), exports);
 __exportStar(require("./Utils"), exports);
 const instance = new RtcEngineExInternal_1.RtcEngineExInternal();
 /**
- * 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
  */
 function createAgoraRtcEngine(options) {
     Object.assign(Utils_1.AgoraEnv, options);
@@ -49,12 +44,7 @@ function createAgoraRtcEngine(options) {
 }
 exports.createAgoraRtcEngine = createAgoraRtcEngine;
 /**
- * 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
  */
 function getMediaPlayerCacheManager() {
     return new IAgoraMediaPlayerImpl_1.IMediaPlayerCacheManagerImpl();

package/js/{Decoder → ts/Decoder}/index.js

@@ -53,7 +53,7 @@ class WebCodecsDecoder {
             if (renderer.rendererType !== Types_1.RendererType.WEBCODECSRENDERER) {
                 continue;
             }
-            renderer.drawFrame(this.pendingFrame, this._currentCodecConfig);
+            renderer.drawFrame(this._cacheContext.uid, this.pendingFrame, this._currentCodecConfig);
             this.pendingFrame = null;
         }
     }