fcr-core 3.8.2 → 3.9.0-alpha

package/lib-es/utilities/parameters.js

@@ -1,4 +1,27 @@
-import "core-js/modules/es.array.push.js";
+import "core-js/modules/es.json.stringify.js";
+import "core-js/modules/esnext.set.add-all.js";
+import "core-js/modules/esnext.set.delete-all.js";
+import "core-js/modules/esnext.set.difference.v2.js";
+import "core-js/modules/esnext.set.difference.js";
+import "core-js/modules/esnext.set.every.js";
+import "core-js/modules/esnext.set.filter.js";
+import "core-js/modules/esnext.set.find.js";
+import "core-js/modules/esnext.set.intersection.v2.js";
+import "core-js/modules/esnext.set.intersection.js";
+import "core-js/modules/esnext.set.is-disjoint-from.v2.js";
+import "core-js/modules/esnext.set.is-disjoint-from.js";
+import "core-js/modules/esnext.set.is-subset-of.v2.js";
+import "core-js/modules/esnext.set.is-subset-of.js";
+import "core-js/modules/esnext.set.is-superset-of.v2.js";
+import "core-js/modules/esnext.set.is-superset-of.js";
+import "core-js/modules/esnext.set.join.js";
+import "core-js/modules/esnext.set.map.js";
+import "core-js/modules/esnext.set.reduce.js";
+import "core-js/modules/esnext.set.some.js";
+import "core-js/modules/esnext.set.symmetric-difference.v2.js";
+import "core-js/modules/esnext.set.symmetric-difference.js";
+import "core-js/modules/esnext.set.union.v2.js";
+import "core-js/modules/esnext.set.union.js";
 import { FcrApplicationPlatform, getPlatform } from '../imports';
 export const isTrueValue = value => {
   return value === 'true' || !!value;
@@ -15,19 +38,69 @@ export const getEasemobRestIpList = parameters => {
 export const isEndpointRegionDisabled = parameters => {
   return isTrueValue(parameters?.core?.disableEndpointRegion);
 };
-export const getRtcPresetParameters = () => {
-  let parameters = [];
-  if (getPlatform() == FcrApplicationPlatform.WINDOWS) {
-    parameters.push('{\"engine.video.hw_decoder_provider\":\"qsv\"}', '{\"rtc.video.default_hw_decoder_thres\":921600}');
-  }
-  if (getPlatform() == FcrApplicationPlatform.MACOS) {
-    parameters.push('{\"che.video.screenCaptureMode\":1}');
-  }
-  if (getPlatform() == FcrApplicationPlatform.WINDOWS || getPlatform() == FcrApplicationPlatform.MACOS) {
-    parameters.push('{\"che.video.videoCodecIndex\": 1}', '{\"rtc.video.new_complexity\": true}', '{\"rtc.video.default_complexity\": 1027}', '{\"rtc.video.enable_doc_screen_share_sr\":true}', '{\"rtc.video.enable_pvc\":false}', '{\"che.video.brightness_detection_enable\":false} ', '{\"che.audio.bitrate_level\":1}', '{\"rtc.video.downMaxRetryTimes\":5}', '{\"che.video.vqc_min_width\": 1280}', '{\"che.video.vqc_min_height\": 720}', '{\"che.video.lowest_dev_score_4_seg\":0}', '{\"che.video.lowest_dev_score_4_beauty\":0}', '{\"rtc.video.color_space_enable\":true}', '{\"rtc.video.videoFullrange\":1}', '{\"rtc.video.matrixCoefficients\":5}', '{\"che.video.screen_disable_frame_transparent_check\":true}', '{\"che.audio.reset_apm_capture_state_for_microphone_track\":false}');
-  }
-  if (getPlatform() == FcrApplicationPlatform.WEB_DESKTOP) {
-    parameters.push('{\"RESTRICTION_SET_PLAYBACK_DEVICE\":false}');
+
+/** RTC preset parameters configuration mapping table */
+const RTC_PRESET_PARAMS_MAP = {
+  [FcrApplicationPlatform.WINDOWS]: [{
+    'rtc.video.default_hw_decoder_thres': 921600
+  }],
+  [FcrApplicationPlatform.MACOS]: [{
+    'che.video.screenCaptureMode': 1
+  }, {
+    'che.video.screen_disable_frame_transparent_check': true
+  }],
+  [FcrApplicationPlatform.WEB_DESKTOP]: [{
+    RESTRICTION_SET_PLAYBACK_DEVICE: false
+  }]
+};
+
+/** desktop common parameters */
+const DESKTOP_COMMON_PARAMS = [
+// audio parameters settings
+{
+  'che.audio.bitrate_level': 1
+}, {
+  'che.audio.reset_apm_capture_state_for_microphone_track': false
+},
+// video parameters settings
+{
+  'rtc.video.color_space_enable': true
+}, {
+  'rtc.video.videoFullrange': 1
+}, {
+  'rtc.video.matrixCoefficients': 5
+}, {
+  'rtc.video.new_complexity': true
+}, {
+  'rtc.video.default_complexity': 1027
+}, {
+  'che.video.videoCodecIndex': 1
+}, {
+  'rtc.video.low_stream_enable_hw_encoder': true
+}, {
+  'rtc.video.enable_doc_screen_share_sr': true
+}, {
+  'rtc.video.enable_pvc': false
+}, {
+  'rtc.video.enable_sr': {
+    enabled: false,
+    mode: 2
   }
-  return parameters;
+}, {
+  'che.video.brightness_detection_enable': false
+}, {
+  'che.video.lowest_dev_score_4_seg': 0
+}, {
+  'rtc.video.downMaxRetryTimes': 5
+}, {
+  'che.video.lowest_dev_score_4_beauty': 0
+}];
+
+/** desktop platforms set */
+const DESKTOP_PLATFORMS = new Set([FcrApplicationPlatform.WINDOWS, FcrApplicationPlatform.MACOS]);
+export const getRtcPresetParameters = () => {
+  const platform = getPlatform();
+  const platformParams = RTC_PRESET_PARAMS_MAP[platform] ?? [];
+  const desktopParams = DESKTOP_PLATFORMS.has(platform) ? DESKTOP_COMMON_PARAMS : [];
+  return [...platformParams, ...desktopParams].map(p => JSON.stringify(p));
 };

package/lib-es/utilities/validate-params.js

@@ -1,7 +1,8 @@
+import { DetailErrorCode } from '../imports';
 import { validateParams } from '../imports';
-import { FcrErrorCode, generateFcrCoreClientError } from './error';
+import { generateFcrCoreClientError } from './error';
 export default validateParams(error => {
   const message = `invalid params: ${error.message}`;
   const fcrErrorModuleCode = '00';
-  return generateFcrCoreClientError(fcrErrorModuleCode, FcrErrorCode.INVALID_PARAMS, message, new Error(message));
+  return generateFcrCoreClientError(fcrErrorModuleCode, DetailErrorCode.INVALID_PARAMS, message);
 });

package/lib-es/utilities/video-encoder-config.js

@@ -0,0 +1,103 @@
+import { getPlatform, FcrApplicationPlatform } from '../imports';
+const COMMON_HIGH_CAMERA_CONFIG = {
+  dimensions: {
+    width: 1280,
+    height: 720
+  },
+  bitrate: 1250,
+  frameRate: 24
+};
+const COMMON_LOW_CAMERA_CONFIG = {
+  dimensions: {
+    width: 480,
+    height: 270
+  },
+  bitrate: 350,
+  frameRate: 15
+};
+const COMMON_FULL_HIGH_CAMERA_CONFIG = {
+  dimensions: {
+    width: 1920,
+    height: 1080
+  },
+  bitrate: 2500,
+  frameRate: 20
+};
+const COMMON_CLARITY_SCREEN_CONFIG = {
+  dimensions: {
+    width: 1920,
+    height: 1080
+  },
+  bitrate: 1500,
+  frameRate: 15
+};
+const COMMON_SMOOTH_SCREEN_CONFIG = {
+  dimensions: {
+    width: 1920,
+    height: 1080
+  },
+  bitrate: 1500,
+  frameRate: 30
+};
+const MOBILE_HIGH_CAMERA_CONFIG = {
+  dimensions: {
+    width: 960,
+    height: 540
+  },
+  bitrate: 1000,
+  frameRate: 24
+};
+const HIGH_CAMERA_CONFIG_MAP = {
+  [FcrApplicationPlatform.HARMONY]: MOBILE_HIGH_CAMERA_CONFIG,
+  [FcrApplicationPlatform.WEB_MOBILE]: MOBILE_HIGH_CAMERA_CONFIG
+};
+const LOW_CAMERA_CONFIG_MAP = {};
+const FULL_HIGH_CAMERA_CONFIG_MAP = {};
+const CLARITY_SCREEN_CONFIG_MAP = {
+  [FcrApplicationPlatform.WEB_DESKTOP]: {
+    dimensions: {
+      width: 1920,
+      height: 1080
+    },
+    bitrate: 1950,
+    frameRate: 15
+  }
+};
+const SMOOTH_SCREEN_CONFIG_MAP = {
+  [FcrApplicationPlatform.WEB_DESKTOP]: {
+    dimensions: {
+      width: 1920,
+      height: 1080
+    },
+    bitrate: 1950,
+    frameRate: 30
+  }
+};
+export let FcrVideoEncoderConfig;
+(function (_FcrVideoEncoderConfig) {
+  function createDefaultHighCameraConfig() {
+    const platform = getPlatform();
+    return HIGH_CAMERA_CONFIG_MAP[platform] ?? COMMON_HIGH_CAMERA_CONFIG;
+  }
+  _FcrVideoEncoderConfig.createDefaultHighCameraConfig = createDefaultHighCameraConfig;
+  function createDefaultLowCameraConfig() {
+    const platform = getPlatform();
+    return LOW_CAMERA_CONFIG_MAP[platform] ?? COMMON_LOW_CAMERA_CONFIG;
+  }
+  _FcrVideoEncoderConfig.createDefaultLowCameraConfig = createDefaultLowCameraConfig;
+  function createDefaultFullHighCameraConfig() {
+    const platform = getPlatform();
+    return FULL_HIGH_CAMERA_CONFIG_MAP[platform] ?? COMMON_FULL_HIGH_CAMERA_CONFIG;
+  }
+  _FcrVideoEncoderConfig.createDefaultFullHighCameraConfig = createDefaultFullHighCameraConfig;
+  function createDefaultClarityScreenConfig() {
+    const platform = getPlatform();
+    return CLARITY_SCREEN_CONFIG_MAP[platform] ?? COMMON_CLARITY_SCREEN_CONFIG;
+  }
+  _FcrVideoEncoderConfig.createDefaultClarityScreenConfig = createDefaultClarityScreenConfig;
+  function createDefaultSmoothScreenConfig() {
+    const platform = getPlatform();
+    return SMOOTH_SCREEN_CONFIG_MAP[platform] ?? COMMON_SMOOTH_SCREEN_CONFIG;
+  }
+  _FcrVideoEncoderConfig.createDefaultSmoothScreenConfig = createDefaultSmoothScreenConfig;
+})(FcrVideoEncoderConfig || (FcrVideoEncoderConfig = {}));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "fcr-core",
   "description": "Core APIs for building online scenes",
-  "version": "3.8.2",
+  "version": "3.9.0-alpha",
   "module": "lib/index.js",
   "types": "lib/index.d.ts",
   "files": [
@@ -41,7 +41,7 @@
     "@types/lodash": "^4.14.168",
     "@types/sinon": "^17.0.2",
     "@types/uuid": "^8.3.0",
-    "agora-toolchain": "3.8.2",
+    "agora-toolchain": "3.9.0-alpha",
     "core-js": "^3.33.3",
     "decomment": "^0.9.5",
     "husky": "^9.0.11",
@@ -55,14 +55,14 @@
   "dependencies": {
     "@netless/app-slide": "^0.2.81",
     "@netless/appliance-plugin": "^1.1.21",
-    "@netless/forge-room": "1.0.6",
-    "@netless/forge-rtm": "1.0.6",
-    "@netless/forge-whiteboard": "1.0.6",
+    "@netless/forge-room": "1.1.0",
+    "@netless/forge-rtm": "1.1.0",
+    "@netless/forge-whiteboard": "1.1.0",
     "@netless/video-js-plugin": "^0.3.8",
     "@netless/white-snapshot": "^0.4.2",
     "@netless/window-manager": "^1.0.7-beta.6",
-    "agora-foundation": "3.8.2",
-    "agora-rte-sdk": "3.8.2",
+    "agora-foundation": "3.9.0-alpha",
+    "agora-rte-sdk": "3.9.0-alpha",
     "await-to-js": "^3.0.0",
     "dayjs": "^1.10.4",
     "easemob-websdk": "4.13.0",

package/lib/chat-connection/index.d.ts

@@ -1,24 +0,0 @@
-import { EasemobChat } from '../imports';
-import { FcrChatConnection, FcrChatConnectionObserver, FcrChatConnectionState } from './type';
-import { FcrCoreServiceApi } from '../service/api';
-export declare class FcrChatConnectionImpl implements FcrChatConnection {
-    private _userId;
-    private _api;
-    private _chatIpList?;
-    private _restIpList?;
-    protected logger: import("agora-foundation/lib/logger/type").Logger;
-    private _observable;
-    private _initConfig?;
-    private _conn?;
-    private _connectionState;
-    constructor(_userId: string, _api: FcrCoreServiceApi, _chatIpList?: string[] | undefined, _restIpList?: string[] | undefined);
-    login(): Promise<void>;
-    private _addEventListeners;
-    logout(): void;
-    private _setConnectionState;
-    getConnectionState(): FcrChatConnectionState;
-    getConnectionInstance(): EasemobChat.Connection;
-    addObserver(observer: FcrChatConnectionObserver): void;
-    removeObserver(observer: FcrChatConnectionObserver): void;
-    private _getPrivateConfig;
-}

package/lib/chat-connection/type.d.ts

@@ -1,17 +0,0 @@
-export interface FcrChatConnection {
-    login(): Promise<void>;
-    logout(): void;
-    getConnectionState(): FcrChatConnectionState;
-    getConnectionInstance(): unknown;
-    addObserver(observer: FcrChatConnectionObserver): void;
-    removeObserver(observer: FcrChatConnectionObserver): void;
-}
-export interface FcrChatConnectionObserver {
-    onConnectionStateUpdated(state: FcrChatConnectionState): void;
-    onConnectionLoginSuccess(): void;
-}
-export declare enum FcrChatConnectionState {
-    DISCONNECTED = 0,
-    CONNECTION = 1,
-    CONNECTED = 2
-}