agora-rte-sdk 3.11.0-rc.3 → 3.11.0

package/lib/core/scene/stream-player.js

@@ -186,7 +186,7 @@ var AgoraRteStreamPlayer = exports.AgoraRteStreamPlayer = /*#__PURE__*/function
     key: "takeSnapshot",
     value: function () {
       var _takeSnapshot = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee(streamId, filePath) {
-        var _yield$this$_rtcChann, data, type;
+        var _yield$this$_rtcChann, data, type, imageData;
         return _regenerator["default"].wrap(function (_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -196,13 +196,26 @@ var AgoraRteStreamPlayer = exports.AgoraRteStreamPlayer = /*#__PURE__*/function
               _yield$this$_rtcChann = _context.sent;
               data = _yield$this$_rtcChann.data;
               type = _yield$this$_rtcChann.type;
+              if (!(type === 'filepath')) {
+                _context.next = 2;
+                break;
+              }
               return _context.abrupt("return", Promise.resolve({
-                streamId: '',
-                filePath: '',
+                streamId: streamId,
+                filePath: data,
                 width: 0,
                 height: 0
               }));
             case 2:
+              imageData = data;
+              return _context.abrupt("return", Promise.resolve({
+                streamId: streamId,
+                filePath: filePath,
+                width: imageData.width,
+                height: imageData.height,
+                imageData: imageData
+              }));
+            case 3:
             case "end":
               return _context.stop();
           }

package/lib/core/scene/type.d.ts

@@ -447,6 +447,7 @@ export type AgoraRteSnapshotInfo = {
     filePath: string;
     width: number;
     height: number;
+    imageData?: ImageData;
 };
 export type AgoraRteUserPageRequest = {
     userRole: number;

package/lib/plugin/audio-player.js

@@ -312,7 +312,6 @@ var AgoraWebAudioPlayer = exports.AgoraWebAudioPlayer = /*#__PURE__*/function ()
         this._analyserNode = this._audioContext.createAnalyser();
         this._analyserNode.smoothingTimeConstant = 0.3;
         this._analyserNode.fftSize = 1024;
-        this._analyserNode.connect(this._audioContext.destination);
         if (this._audioContext.state === 'running') {
           this._initialized = true;
         }

package/lib/plugin/rtc/electron/media-recorder/media-recorder-manager.js

@@ -269,7 +269,7 @@ var AgoraElectronMediaRecorderManager = exports.AgoraElectronMediaRecorderManage
                   recordingHeight = (_currentWindowInfo$bo2 = currentWindowInfo.bounds) === null || _currentWindowInfo$bo2 === void 0 ? void 0 : _currentWindowInfo$bo2.height;
                   this.logger.info("startClientRecording: using window bounds for recording resolution, width=".concat(recordingWidth, ", height=").concat(recordingHeight));
                 }
-                this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, true);
+                this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, false);
                 this.logger.info("startClientRecording: started own window capture for recording (without highlight), windowId: ".concat(currentWindowInfo.id));
               } else {
                 this.logger.warn('startClientRecording: failed to find current window for recording');
@@ -362,7 +362,7 @@ var AgoraElectronMediaRecorderManager = exports.AgoraElectronMediaRecorderManage
     key: "resumeOwnCapture",
     value: (function () {
       var _resumeOwnCapture = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee3() {
-        var currentWindowInfo, maxRetries, retryInterval, i, res;
+        var currentWindowInfo, maxRetries, retryInterval, i, maxStartAttempts, startRetryInterval, res, attempt;
         return _regenerator["default"].wrap(function (_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
@@ -411,44 +411,80 @@ var AgoraElectronMediaRecorderManager = exports.AgoraElectronMediaRecorderManage
               _context3.next = 3;
               break;
             case 7:
-              if (currentWindowInfo) {
-                // 保护这个 sourceId 不被 onLocalVideoStateChanged 的延迟回调误杀
-                this._sourceManager.protectSourceId(currentWindowInfo.id);
-
-                // 启动自己的窗口采集
-                this._clientRecordingSourceId = currentWindowInfo.id;
-                this._clientRecordingCaptureType = _type.AgoraRtcScreenCaptureType.WINDOW;
-                this._clientRecordingOwnsCapture = true;
-                res = this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, true);
-                this.logger.info("resumeOwnCapture: startScreenCaptureByWindowId result=".concat(res, ", windowId: ").concat(currentWindowInfo.id));
-                if (res !== 0) {
-                  this.logger.warn("resumeOwnCapture: startScreenCaptureByWindowId failed with code ".concat(res));
-                  this._sourceManager.unprotectSourceId(currentWindowInfo.id);
-                  this._clientRecordingSourceId = undefined;
-                  this._clientRecordingCaptureType = undefined;
-                  this._clientRecordingOwnsCapture = false;
-                } else if (this._channelId && this._uid) {
-                  // 采集成功后重建 MediaRecorder，因为屏幕共享停止时 SDK 内部管道已断开，
-                  // 旧的 MediaRecorder 无法接收新采集源的视频帧。
-                  this.logger.info('resumeOwnCapture: recreating MediaRecorder for new capture source');
-                  if (this._mediaRecorder && this._isRecordingStarted) {
-                    this._mediaRecorder.stopRecording();
-                    this._isRecordingStarted = false;
-                  }
-                  if (this._mediaRecorder) {
-                    this._recorderGeneration++;
-                    this._rtcEngine.destroyMediaRecorder(this._mediaRecorder);
-                    this._mediaRecorder = undefined;
-                    this._mediaRecorderObserver = undefined;
-                  }
-                  this._createMediaRecorder(this._channelId, this._uid);
-                  this._setupMediaRecorderObserver(this._channelId, this._uid);
-                  this._startRecording(this._lastRecordingConfig);
-                }
-              } else {
-                this.logger.warn('resumeOwnCapture: failed to find current window after retries, recording may be affected');
+              if (!currentWindowInfo) {
+                _context3.next = 12;
+                break;
               }
+              // 保护这个 sourceId 不被 onLocalVideoStateChanged 的延迟回调误杀
+              this._sourceManager.protectSourceId(currentWindowInfo.id);
+
+              // 启动自己的窗口采集
+              this._clientRecordingSourceId = currentWindowInfo.id;
+              this._clientRecordingCaptureType = _type.AgoraRtcScreenCaptureType.WINDOW;
+              this._clientRecordingOwnsCapture = true;
+
+              // 屏幕共享停止后 RTC 内部的 VideoSourceScreenPrimary 通道还在异步拆除，
+              // 此时立刻调用 startScreenCaptureByWindowId 会返回 -2 (ERR_INVALID_ARGUMENT)，
+              // 导致后续录制全是黑帧。这里做有界重试。
+              maxStartAttempts = 6;
+              startRetryInterval = 200;
+              res = -1;
+              attempt = 0;
             case 8:
+              if (!(attempt < maxStartAttempts)) {
+                _context3.next = 11;
+                break;
+              }
+              res = this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, false);
+              this.logger.info("resumeOwnCapture: startScreenCaptureByWindowId result=".concat(res, ", windowId: ").concat(currentWindowInfo.id, ", attempt: ").concat(attempt + 1, "/").concat(maxStartAttempts));
+              if (!(res === 0)) {
+                _context3.next = 9;
+                break;
+              }
+              return _context3.abrupt("continue", 11);
+            case 9:
+              this.logger.warn("resumeOwnCapture: startScreenCaptureByWindowId attempt ".concat(attempt + 1, " failed with code ").concat(res, ", retrying in ").concat(startRetryInterval, "ms..."));
+              _context3.next = 10;
+              return new Promise(function (r) {
+                return setTimeout(r, startRetryInterval);
+              });
+            case 10:
+              attempt++;
+              _context3.next = 8;
+              break;
+            case 11:
+              if (res !== 0) {
+                this.logger.warn("resumeOwnCapture: startScreenCaptureByWindowId failed with code ".concat(res, " after ").concat(maxStartAttempts, " attempts"));
+                this._sourceManager.unprotectSourceId(currentWindowInfo.id);
+                this._clientRecordingSourceId = undefined;
+                this._clientRecordingCaptureType = undefined;
+                this._clientRecordingOwnsCapture = false;
+              }
+              //  else if (this._channelId && this._uid) {
+              //   // 采集成功后重建 MediaRecorder，因为屏幕共享停止时 SDK 内部管道已断开，
+              //   // 旧的 MediaRecorder 无法接收新采集源的视频帧。
+              //   this.logger.info('resumeOwnCapture: recreating MediaRecorder for new capture source');
+
+              //   if (this._mediaRecorder && this._isRecordingStarted) {
+              //     this._mediaRecorder.stopRecording();
+              //     this._isRecordingStarted = false;
+              //   }
+              //   if (this._mediaRecorder) {
+              //     this._recorderGeneration++;
+              //     this._rtcEngine.destroyMediaRecorder(this._mediaRecorder);
+              //     this._mediaRecorder = undefined;
+              //     this._mediaRecorderObserver = undefined;
+              //   }
+
+              //   this._createMediaRecorder(this._channelId, this._uid);
+              //   this._setupMediaRecorderObserver(this._channelId, this._uid);
+              //   this._startRecording(this._lastRecordingConfig);
+              // }
+              _context3.next = 13;
+              break;
+            case 12:
+              this.logger.warn('resumeOwnCapture: failed to find current window after retries, recording may be affected');
+            case 13:
             case "end":
               return _context3.stop();
           }
@@ -588,7 +624,10 @@ var AgoraElectronMediaRecorderManager = exports.AgoraElectronMediaRecorderManage
         videoSourceType: 2,
         width: config === null || config === void 0 ? void 0 : config.width,
         height: config === null || config === void 0 ? void 0 : config.height,
-        fps: config === null || config === void 0 ? void 0 : config.fps
+        fps: config === null || config === void 0 ? void 0 : config.fps,
+        audioConfiguration: {
+          audioRecordingType: 4
+        }
       };
       var result = (_this$_mediaRecorder2 = this._mediaRecorder) === null || _this$_mediaRecorder2 === void 0 ? void 0 : _this$_mediaRecorder2.startRecording(recordingConfig);
       if (result !== undefined && result !== 0) {

package/lib/plugin/rtc/web/channel.js

@@ -397,9 +397,10 @@ var AgoraRtcChannelWebAdapterImp = exports.AgoraRtcChannelWebAdapterImp = /*#__P
   }, {
     key: "takeSnapshot",
     value: function takeSnapshot(streamId, filePath) {
+      var imageData = this.subscriber.takeSnapshot(streamId);
       return Promise.resolve({
         type: 'imageData',
-        data: this.subscriber.takeSnapshot(streamId)
+        data: imageData
       });
     }
   }, {

package/lib-es/core/scene/stream-player.js

@@ -179,7 +179,7 @@ export var AgoraRteStreamPlayer = /*#__PURE__*/function () {
     key: "takeSnapshot",
     value: function () {
       var _takeSnapshot = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee(streamId, filePath) {
-        var _yield$this$_rtcChann, data, type;
+        var _yield$this$_rtcChann, data, type, imageData;
         return _regeneratorRuntime.wrap(function (_context) {
           while (1) switch (_context.prev = _context.next) {
             case 0:
@@ -189,13 +189,26 @@ export var AgoraRteStreamPlayer = /*#__PURE__*/function () {
               _yield$this$_rtcChann = _context.sent;
               data = _yield$this$_rtcChann.data;
               type = _yield$this$_rtcChann.type;
+              if (!(type === 'filepath')) {
+                _context.next = 2;
+                break;
+              }
               return _context.abrupt("return", Promise.resolve({
-                streamId: '',
-                filePath: '',
+                streamId: streamId,
+                filePath: data,
                 width: 0,
                 height: 0
               }));
             case 2:
+              imageData = data;
+              return _context.abrupt("return", Promise.resolve({
+                streamId: streamId,
+                filePath: filePath,
+                width: imageData.width,
+                height: imageData.height,
+                imageData: imageData
+              }));
+            case 3:
             case "end":
               return _context.stop();
           }

package/lib-es/plugin/audio-player.js

@@ -305,7 +305,6 @@ export var AgoraWebAudioPlayer = /*#__PURE__*/function () {
         this._analyserNode = this._audioContext.createAnalyser();
         this._analyserNode.smoothingTimeConstant = 0.3;
         this._analyserNode.fftSize = 1024;
-        this._analyserNode.connect(this._audioContext.destination);
         if (this._audioContext.state === 'running') {
           this._initialized = true;
         }

package/lib-es/plugin/rtc/electron/media-recorder/media-recorder-manager.js

@@ -263,7 +263,7 @@ export var AgoraElectronMediaRecorderManager = /*#__PURE__*/function () {
                   recordingHeight = (_currentWindowInfo$bo2 = currentWindowInfo.bounds) === null || _currentWindowInfo$bo2 === void 0 ? void 0 : _currentWindowInfo$bo2.height;
                   this.logger.info("startClientRecording: using window bounds for recording resolution, width=".concat(recordingWidth, ", height=").concat(recordingHeight));
                 }
-                this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, true);
+                this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, false);
                 this.logger.info("startClientRecording: started own window capture for recording (without highlight), windowId: ".concat(currentWindowInfo.id));
               } else {
                 this.logger.warn('startClientRecording: failed to find current window for recording');
@@ -356,7 +356,7 @@ export var AgoraElectronMediaRecorderManager = /*#__PURE__*/function () {
     key: "resumeOwnCapture",
     value: (function () {
       var _resumeOwnCapture = _asyncToGenerator(/*#__PURE__*/_regeneratorRuntime.mark(function _callee3() {
-        var currentWindowInfo, maxRetries, retryInterval, i, res;
+        var currentWindowInfo, maxRetries, retryInterval, i, maxStartAttempts, startRetryInterval, res, attempt;
         return _regeneratorRuntime.wrap(function (_context3) {
           while (1) switch (_context3.prev = _context3.next) {
             case 0:
@@ -405,44 +405,80 @@ export var AgoraElectronMediaRecorderManager = /*#__PURE__*/function () {
               _context3.next = 3;
               break;
             case 7:
-              if (currentWindowInfo) {
-                // 保护这个 sourceId 不被 onLocalVideoStateChanged 的延迟回调误杀
-                this._sourceManager.protectSourceId(currentWindowInfo.id);
-
-                // 启动自己的窗口采集
-                this._clientRecordingSourceId = currentWindowInfo.id;
-                this._clientRecordingCaptureType = AgoraRtcScreenCaptureType.WINDOW;
-                this._clientRecordingOwnsCapture = true;
-                res = this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, true);
-                this.logger.info("resumeOwnCapture: startScreenCaptureByWindowId result=".concat(res, ", windowId: ").concat(currentWindowInfo.id));
-                if (res !== 0) {
-                  this.logger.warn("resumeOwnCapture: startScreenCaptureByWindowId failed with code ".concat(res));
-                  this._sourceManager.unprotectSourceId(currentWindowInfo.id);
-                  this._clientRecordingSourceId = undefined;
-                  this._clientRecordingCaptureType = undefined;
-                  this._clientRecordingOwnsCapture = false;
-                } else if (this._channelId && this._uid) {
-                  // 采集成功后重建 MediaRecorder，因为屏幕共享停止时 SDK 内部管道已断开，
-                  // 旧的 MediaRecorder 无法接收新采集源的视频帧。
-                  this.logger.info('resumeOwnCapture: recreating MediaRecorder for new capture source');
-                  if (this._mediaRecorder && this._isRecordingStarted) {
-                    this._mediaRecorder.stopRecording();
-                    this._isRecordingStarted = false;
-                  }
-                  if (this._mediaRecorder) {
-                    this._recorderGeneration++;
-                    this._rtcEngine.destroyMediaRecorder(this._mediaRecorder);
-                    this._mediaRecorder = undefined;
-                    this._mediaRecorderObserver = undefined;
-                  }
-                  this._createMediaRecorder(this._channelId, this._uid);
-                  this._setupMediaRecorderObserver(this._channelId, this._uid);
-                  this._startRecording(this._lastRecordingConfig);
-                }
-              } else {
-                this.logger.warn('resumeOwnCapture: failed to find current window after retries, recording may be affected');
+              if (!currentWindowInfo) {
+                _context3.next = 12;
+                break;
               }
+              // 保护这个 sourceId 不被 onLocalVideoStateChanged 的延迟回调误杀
+              this._sourceManager.protectSourceId(currentWindowInfo.id);
+
+              // 启动自己的窗口采集
+              this._clientRecordingSourceId = currentWindowInfo.id;
+              this._clientRecordingCaptureType = AgoraRtcScreenCaptureType.WINDOW;
+              this._clientRecordingOwnsCapture = true;
+
+              // 屏幕共享停止后 RTC 内部的 VideoSourceScreenPrimary 通道还在异步拆除，
+              // 此时立刻调用 startScreenCaptureByWindowId 会返回 -2 (ERR_INVALID_ARGUMENT)，
+              // 导致后续录制全是黑帧。这里做有界重试。
+              maxStartAttempts = 6;
+              startRetryInterval = 200;
+              res = -1;
+              attempt = 0;
             case 8:
+              if (!(attempt < maxStartAttempts)) {
+                _context3.next = 11;
+                break;
+              }
+              res = this._sourceManager.startScreenCaptureByWindowId(currentWindowInfo.id, false);
+              this.logger.info("resumeOwnCapture: startScreenCaptureByWindowId result=".concat(res, ", windowId: ").concat(currentWindowInfo.id, ", attempt: ").concat(attempt + 1, "/").concat(maxStartAttempts));
+              if (!(res === 0)) {
+                _context3.next = 9;
+                break;
+              }
+              return _context3.abrupt("continue", 11);
+            case 9:
+              this.logger.warn("resumeOwnCapture: startScreenCaptureByWindowId attempt ".concat(attempt + 1, " failed with code ").concat(res, ", retrying in ").concat(startRetryInterval, "ms..."));
+              _context3.next = 10;
+              return new Promise(function (r) {
+                return setTimeout(r, startRetryInterval);
+              });
+            case 10:
+              attempt++;
+              _context3.next = 8;
+              break;
+            case 11:
+              if (res !== 0) {
+                this.logger.warn("resumeOwnCapture: startScreenCaptureByWindowId failed with code ".concat(res, " after ").concat(maxStartAttempts, " attempts"));
+                this._sourceManager.unprotectSourceId(currentWindowInfo.id);
+                this._clientRecordingSourceId = undefined;
+                this._clientRecordingCaptureType = undefined;
+                this._clientRecordingOwnsCapture = false;
+              }
+              //  else if (this._channelId && this._uid) {
+              //   // 采集成功后重建 MediaRecorder，因为屏幕共享停止时 SDK 内部管道已断开，
+              //   // 旧的 MediaRecorder 无法接收新采集源的视频帧。
+              //   this.logger.info('resumeOwnCapture: recreating MediaRecorder for new capture source');
+
+              //   if (this._mediaRecorder && this._isRecordingStarted) {
+              //     this._mediaRecorder.stopRecording();
+              //     this._isRecordingStarted = false;
+              //   }
+              //   if (this._mediaRecorder) {
+              //     this._recorderGeneration++;
+              //     this._rtcEngine.destroyMediaRecorder(this._mediaRecorder);
+              //     this._mediaRecorder = undefined;
+              //     this._mediaRecorderObserver = undefined;
+              //   }
+
+              //   this._createMediaRecorder(this._channelId, this._uid);
+              //   this._setupMediaRecorderObserver(this._channelId, this._uid);
+              //   this._startRecording(this._lastRecordingConfig);
+              // }
+              _context3.next = 13;
+              break;
+            case 12:
+              this.logger.warn('resumeOwnCapture: failed to find current window after retries, recording may be affected');
+            case 13:
             case "end":
               return _context3.stop();
           }
@@ -582,7 +618,10 @@ export var AgoraElectronMediaRecorderManager = /*#__PURE__*/function () {
         videoSourceType: 2,
         width: config === null || config === void 0 ? void 0 : config.width,
         height: config === null || config === void 0 ? void 0 : config.height,
-        fps: config === null || config === void 0 ? void 0 : config.fps
+        fps: config === null || config === void 0 ? void 0 : config.fps,
+        audioConfiguration: {
+          audioRecordingType: 4
+        }
       };
       var result = (_this$_mediaRecorder2 = this._mediaRecorder) === null || _this$_mediaRecorder2 === void 0 ? void 0 : _this$_mediaRecorder2.startRecording(recordingConfig);
       if (result !== undefined && result !== 0) {

package/lib-es/plugin/rtc/web/channel.js

@@ -390,9 +390,10 @@ export var AgoraRtcChannelWebAdapterImp = /*#__PURE__*/function (_AgoraRtcChanne
   }, {
     key: "takeSnapshot",
     value: function takeSnapshot(streamId, filePath) {
+      var imageData = this.subscriber.takeSnapshot(streamId);
       return Promise.resolve({
         type: 'imageData',
-        data: this.subscriber.takeSnapshot(streamId)
+        data: imageData
       });
     }
   }, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-rte-sdk",
-  "version": "3.11.0-rc.3",
+  "version": "3.11.0",
   "description": "SDK for building interactive scenarios",
   "author": "agora.io",
   "license": "ISC",
@@ -30,7 +30,7 @@
     "@types/sinon": "^17.0.2",
     "@types/ua-parser-js": "^0.7.35",
     "agora-token": "^2.0.3",
-    "agora-toolchain": "3.11.0-rc.3",
+    "agora-toolchain": "3.11.0",
     "core-js": "^3.33.3",
     "electron": "22.3.27",
     "husky": "^9.0.11",
@@ -41,11 +41,11 @@
     "typescript": "^5.3.2"
   },
   "dependencies": {
-    "shengwang-electron-sdk": "4.6.3-build.133-rc.14",
+    "shengwang-electron-sdk": "4.6.3-build.133-rc.16",
     "agora-extension-ai-denoiser": "^1.0.0",
     "agora-extension-beauty-effect": "^1.0.1-beta",
     "agora-extension-virtual-background": "^2.1.0",
-    "agora-foundation": "3.11.0-rc.3",
+    "agora-foundation": "3.11.0",
     "agora-rtc-sdk-ng": "4.23.3",
     "agora-rtm": "2.2.2-3",
     "await-to-js": "^3.0.0",