agora-rte-sdk 3.8.0 → 3.8.1-beta

package/lib/core/rtc/canvas.d.ts

@@ -32,6 +32,7 @@ export declare abstract class AgoraRtcCanvasTagPool {
     abstract getTagWithCanvasId(canvasAddress: AgoraRteRenderView): AgoraRtcCanvasTag | undefined;
     abstract addTagWithCanvasId(canvasAddress: AgoraRteRenderView, sourceId: string, canvas: AgoraRtcVideoCanvas, isLocal: boolean, connection?: AgoraRtcConnection): void;
     abstract ifNeedStopRenderCanvas(canvasAddress: AgoraRteRenderView): void;
+    abstract ifNeedStopLocalRenderCanvas(canvasAddress: AgoraRteRenderView): void;
     abstract stopRenderOnAllCanvasWithSourceId(sourceId: string): void;
     /**
      * 获取画布标签池

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

@@ -5,13 +5,13 @@ import { AgoraRteStreamPlayer } from './stream-player';
 import { AgoraRteLocalUser } from './local-user';
 import { AgoraRteServiceApi } from '../services/api';
 import { AgoraObservable, AgoraRteError } from '../../imports';
-import { AgoraRtcMediaSourceState, AgoraRtcScreenCaptureType } from '../rtc/type';
+import { AgoraRtcMediaSourceState, AgoraRtcScreenCaptureType, AgoraRtcVideoSourceType } from '../rtc/type';
 export declare class AgoraRteScene {
     protected logger: import("agora-foundation/lib/logger/type").Logger;
     protected readonly observable: AgoraObservable<Partial<{
         onJoinSceneSuccess(sceneId: string, localUser: AgoraRteLocalUser, streamPlayer: AgoraRteStreamPlayer): void;
         onJoinSceneFailure(sceneId: string, error: AgoraRteError): void;
-        onSceneMessageReceived(sceneId: string, message: import("../..").AgoraRteMessage): void;
+        onSceneMessageReceived(sceneId: string, message: import("../../type").AgoraRteMessage): void;
         onScenePropertiesUpdated(sceneId: string, event: import("./type").AgoraRteScenePropertiesUpdatedEvent): void;
         onScenePropertiesDeleted(sceneId: string, event: import("./type").AgoraRteScenePropertiesDeletedEvent): void;
         onUserPropertiesUpdated(sceneId: string, event: AgoraRteUserPropertiesUpdatedEvent): void;
@@ -45,6 +45,7 @@ export declare class AgoraRteScene {
     private _stateSynchronizer?;
     private _messageSynchronizer?;
     private _messageHandlerObservers?;
+    private _screenStreamLabelMap;
     private _streamPlayer?;
     private _timestampGap;
     private _totalUserCount;
@@ -122,6 +123,9 @@ export declare class AgoraRteScene {
      *
      */
     fetchUserList(params: AgoraRteUserPageParams): Promise<AgoraRteUserPageResponse>;
+    addLocalStreamLabels(streamId: string, labels: Map<string, any>): void;
+    removeLocalStreamLabel(streamId: string): void;
+    getLocalStreamSourceTypeFromStreamLabel(streamId: string): AgoraRtcVideoSourceType.CAMERA | AgoraRtcVideoSourceType.SCREEN | undefined;
     /**
      * Get all streams in scene, return as object
      * @returns {Record<string, AgoraRteMediaStreamInfo[]>} all streams in scene

package/lib/core/scene/index.js

@@ -88,6 +88,7 @@ var _error2 = require("../utilities/error");
 var _type2 = require("../rtc/type");
 var _client = require("../services/client");
 var _type3 = require("../rtm/type");
+var _type4 = require("../../type");
 var _AgoraRteScene;
 var _initProto;
 function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
@@ -115,6 +116,8 @@ var AgoraRteScene = exports.AgoraRteScene = /*#__PURE__*/function () {
       prefix: 'AgoraRteScene'
     })));
     (0, _defineProperty2["default"])(this, "observable", new _imports.AgoraObservable());
+    // key is streamId, value is label
+    (0, _defineProperty2["default"])(this, "_screenStreamLabelMap", new Map());
     (0, _defineProperty2["default"])(this, "_timestampGap", 0);
     (0, _defineProperty2["default"])(this, "_totalUserCount", 0);
     (0, _defineProperty2["default"])(this, "_joinSuccess", false);
@@ -576,12 +579,34 @@ var AgoraRteScene = exports.AgoraRteScene = /*#__PURE__*/function () {
         return _fetchUserList.apply(this, arguments);
       }
       return fetchUserList;
-    }()
+    }())
+  }, {
+    key: "addLocalStreamLabels",
+    value: function addLocalStreamLabels(streamId, labels) {
+      this._screenStreamLabelMap.set(streamId, labels);
+    }
+  }, {
+    key: "removeLocalStreamLabel",
+    value: function removeLocalStreamLabel(streamId) {
+      this._screenStreamLabelMap["delete"](streamId);
+    }
+  }, {
+    key: "getLocalStreamSourceTypeFromStreamLabel",
+    value: function getLocalStreamSourceTypeFromStreamLabel(streamId) {
+      var label = this._screenStreamLabelMap.get(streamId);
+      if ((label === null || label === void 0 ? void 0 : label.get('localSourceType')) === 'screen') {
+        return _type4.AgoraRteVideoSourceType.SCREEN;
+      }
+      if ((label === null || label === void 0 ? void 0 : label.get('localSourceType')) === 'camera') {
+        return _type4.AgoraRteVideoSourceType.CAMERA;
+      }
+      return undefined;
+    }
+
     /**
      * Get all streams in scene, return as object
      * @returns {Record<string, AgoraRteMediaStreamInfo[]>} all streams in scene
      */
-    )
   }, {
     key: "getStreams",
     value: function getStreams() {
@@ -1116,7 +1141,7 @@ var AgoraRteScene = exports.AgoraRteScene = /*#__PURE__*/function () {
       var _this7 = this;
       streams.forEach(/*#__PURE__*/function () {
         var _ref9 = (0, _asyncToGenerator2["default"])(/*#__PURE__*/_regenerator["default"].mark(function _callee12(stream) {
-          var streamToken, shouldPublishAudio, shouldPublishVideo, _this7$_rtcMainChanne, _this7$rtcMainChannel, _this7$_rtcMainChanne2, _this7$rtcMainChannel2, observer;
+          var streamToken, shouldPublishAudio, shouldPublishVideo, localLabelSourceType, sourceType, _this7$_rtcMainChanne, _this7$rtcMainChannel, _this7$_rtcMainChanne2, _this7$rtcMainChannel2, observer;
           return _regenerator["default"].wrap(function (_context12) {
             while (1) switch (_context12.prev = _context12.next) {
               case 0:
@@ -1124,10 +1149,12 @@ var AgoraRteScene = exports.AgoraRteScene = /*#__PURE__*/function () {
                   streamToken = _this7.localUser.getStreamTokenByStreamId(stream.streamId);
                   shouldPublishAudio = stream.streamType === _type.AgoraRteMediaStreamType.BOTH || stream.streamType === _type.AgoraRteMediaStreamType.AUDIO;
                   shouldPublishVideo = stream.streamType === _type.AgoraRteMediaStreamType.BOTH || stream.streamType === _type.AgoraRteMediaStreamType.VIDEO;
+                  localLabelSourceType = _this7.getLocalStreamSourceTypeFromStreamLabel(stream.streamId);
+                  sourceType = localLabelSourceType !== null && localLabelSourceType !== void 0 ? localLabelSourceType : stream.videoSourceType;
                   if (shouldPublishVideo) {
-                    (_this7$_rtcMainChanne = _this7._rtcMainChannelClient) === null || _this7$_rtcMainChanne === void 0 || _this7$_rtcMainChanne.publisher.publishLocalVideoStream(streamToken, stream.streamId, stream.videoSourceId, stream.videoSourceType);
+                    (_this7$_rtcMainChanne = _this7._rtcMainChannelClient) === null || _this7$_rtcMainChanne === void 0 || _this7$_rtcMainChanne.publisher.publishLocalVideoStream(streamToken, stream.streamId, stream.videoSourceId, sourceType);
                   } else {
-                    (_this7$rtcMainChannel = _this7.rtcMainChannelClient) === null || _this7$rtcMainChannel === void 0 || _this7$rtcMainChannel.publisher.unpublishLocalVideoStream(stream.streamId, stream.videoSourceType);
+                    (_this7$rtcMainChannel = _this7.rtcMainChannelClient) === null || _this7$rtcMainChannel === void 0 || _this7$rtcMainChannel.publisher.unpublishLocalVideoStream(stream.streamId, sourceType);
                   }
                   if (shouldPublishAudio) {
                     (_this7$_rtcMainChanne2 = _this7._rtcMainChannelClient) === null || _this7$_rtcMainChanne2 === void 0 || _this7$_rtcMainChanne2.publisher.publishLocalAudioStream(streamToken, stream.streamId, stream.audioSourceId, stream.audioSourceType);
@@ -1145,7 +1172,7 @@ var AgoraRteScene = exports.AgoraRteScene = /*#__PURE__*/function () {
                           }
                           if (shouldPublishVideo) {
                             var _this7$_rtcMainChanne4;
-                            (_this7$_rtcMainChanne4 = _this7._rtcMainChannelClient) === null || _this7$_rtcMainChanne4 === void 0 || _this7$_rtcMainChanne4.publisher.publishLocalVideoStream(token, stream.streamId, stream.videoSourceId, stream.videoSourceType);
+                            (_this7$_rtcMainChanne4 = _this7._rtcMainChannelClient) === null || _this7$_rtcMainChanne4 === void 0 || _this7$_rtcMainChanne4.publisher.publishLocalVideoStream(token, stream.streamId, stream.videoSourceId, sourceType);
                           }
                           _this7.localUser.removeObserver(observer);
                         }
@@ -1737,6 +1764,7 @@ var AgoraRteScene = exports.AgoraRteScene = /*#__PURE__*/function () {
     value: function _cleanup() {
       var _this$_stateSynchroni3;
       (_this$_stateSynchroni3 = this._stateSynchronizer) === null || _this$_stateSynchroni3 === void 0 || _this$_stateSynchroni3.stop();
+      this._screenStreamLabelMap.clear();
       this._stopDeviceStateSync();
       this._localUser = undefined;
       this._streamPlayer = undefined;

package/lib/plugin/rtc/electron/canvas-tag-pool.d.ts

@@ -39,6 +39,7 @@ export declare class AgoraRtcCanvasTagPoolImpl extends AgoraRtcCanvasTagPool {
      * @param rtcEngine - RTC引擎实例
      */
     ifNeedStopRenderCanvas(canvasAddress: AgoraRteRenderView): void;
+    ifNeedStopLocalRenderCanvas(canvasAddress: AgoraRteRenderView): void;
     /**
      * 停止所有指定源ID的画布渲染
      * @param sourceId - 源ID

package/lib/plugin/rtc/electron/canvas-tag-pool.js

@@ -3,8 +3,6 @@
 require("core-js/modules/es.symbol.js");
 require("core-js/modules/es.symbol.description.js");
 require("core-js/modules/es.symbol.to-primitive.js");
-require("core-js/modules/es.error.cause.js");
-require("core-js/modules/es.error.to-string.js");
 require("core-js/modules/es.array.is-array.js");
 require("core-js/modules/es.array.push.js");
 require("core-js/modules/es.date.to-primitive.js");
@@ -24,6 +22,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AgoraRtcCanvasTagPoolImpl = void 0;
+require("core-js/modules/es.error.cause.js");
+require("core-js/modules/es.error.to-string.js");
 require("core-js/modules/es.array.filter.js");
 require("core-js/modules/es.array.for-each.js");
 require("core-js/modules/es.array.from.js");
@@ -146,6 +146,30 @@ var AgoraRtcCanvasTagPoolImpl = exports.AgoraRtcCanvasTagPoolImpl = /*#__PURE__*
       }
     }
 
+    // 新增了这个方法，用于停止本地渲染，
+    // 有部分客户在停止摄像头预览时，会传入远程画布地址
+    // 导致远端也停止渲染，所以需要新增这个方法来停止本地渲染。
+  }, {
+    key: "ifNeedStopLocalRenderCanvas",
+    value: function ifNeedStopLocalRenderCanvas(canvasAddress) {
+      var canvasTag = this._canvasTagPool.get(canvasAddress);
+      if (!canvasTag) {
+        return;
+      }
+      if (!canvasTag.isLocal) {
+        this.logger.error('Remote canvas should not be stopped');
+        throw new Error('Remote canvas should not be stopped');
+      }
+      try {
+        if (!canvasTag.connection) {
+          this._stopLocalRender(canvasTag);
+          this._cleanupCanvas(canvasAddress);
+        }
+      } catch (error) {
+        this.logger.error('Error stopping render canvas:', error);
+      }
+    }
+
     /**
      * 停止所有指定源ID的画布渲染
      * @param sourceId - 源ID
@@ -360,7 +384,7 @@ var AgoraRtcCanvasTagPoolImpl = exports.AgoraRtcCanvasTagPoolImpl = /*#__PURE__*
   }]);
 }(_canvas.AgoraRtcCanvasTagPool);
 _AgoraRtcCanvasTagPoolImpl = AgoraRtcCanvasTagPoolImpl;
-var _applyDecs$e = _applyDecs(_AgoraRtcCanvasTagPoolImpl, [[_imports.trace, 2, "release"], [_imports.trace, 2, "addTagWithCanvasId"], [_imports.trace, 2, "ifNeedStopRenderCanvas"], [_imports.trace, 2, "stopRenderOnAllCanvasWithSourceId"], [_imports.trace, 2, "_isLastLocalCanvas"]], [], 0, void 0, _canvas.AgoraRtcCanvasTagPool).e;
+var _applyDecs$e = _applyDecs(_AgoraRtcCanvasTagPoolImpl, [[_imports.trace, 2, "release"], [_imports.trace, 2, "addTagWithCanvasId"], [_imports.trace, 2, "ifNeedStopRenderCanvas"], [_imports.trace, 2, "ifNeedStopLocalRenderCanvas"], [_imports.trace, 2, "stopRenderOnAllCanvasWithSourceId"], [_imports.trace, 2, "_isLastLocalCanvas"]], [], 0, void 0, _canvas.AgoraRtcCanvasTagPool).e;
 var _applyDecs$e2 = (0, _slicedToArray2["default"])(_applyDecs$e, 1);
 _initProto = _applyDecs$e2[0];
 _applyDecs$e;

package/lib/plugin/rtc/electron/client.js

@@ -382,7 +382,7 @@ var AgoraRtcClientImpl = exports.AgoraRtcClientImpl = /*#__PURE__*/function (_Ag
   }, {
     key: "stopRenderCameraPreview",
     value: function stopRenderCameraPreview(deviceId, view) {
-      this.canvasTagPool.ifNeedStopRenderCanvas(view);
+      this.canvasTagPool.ifNeedStopLocalRenderCanvas(view);
       this.canvasHelper.unbind(view);
       return 0;
     }

package/lib/plugin/rtc/electron/source-state-control/camera-state-control.js

@@ -84,7 +84,7 @@ var CameraStateControlImpl = exports.CameraStateControlImpl = /*#__PURE__*/funct
     //@internal
     (0, _defineProperty2["default"])(_this, "_cameraSourceIndexMapping", (_initProto(_this), new Map()));
     //@internal
-    (0, _defineProperty2["default"])(_this, "_availableCameraSourceIndex", initAvailableCameraSourceIndex);
+    (0, _defineProperty2["default"])(_this, "_availableCameraSourceIndex", [].concat(initAvailableCameraSourceIndex));
     return _this;
   }
   (0, _inherits2["default"])(CameraStateControlImpl, _SourceStateControlIm);
@@ -97,7 +97,7 @@ var CameraStateControlImpl = exports.CameraStateControlImpl = /*#__PURE__*/funct
     key: "release",
     value: function release() {
       this._cameraSourceIndexMapping.clear();
-      this._availableCameraSourceIndex = initAvailableCameraSourceIndex;
+      this._availableCameraSourceIndex = [].concat(initAvailableCameraSourceIndex);
       _superPropGet(CameraStateControlImpl, "release", this, 3)([]);
     }
   }, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agora-rte-sdk",
-  "version": "3.8.0",
+  "version": "3.8.1-beta",
   "description": "SDK for building interactive scenarios",
   "author": "agora.io",
   "license": "ISC",
@@ -28,7 +28,7 @@
     "@types/sinon": "^17.0.2",
     "@types/ua-parser-js": "^0.7.35",
     "agora-token": "^2.0.3",
-    "agora-toolchain": "3.8.0",
+    "agora-toolchain": "3.8.1-beta",
     "core-js": "^3.33.3",
     "electron": "22.3.27",
     "husky": "^9.0.11",
@@ -43,7 +43,7 @@
     "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.8.0",
+    "agora-foundation": "3.8.1-beta",
     "agora-rtc-sdk-ng": "4.23.3",
     "agora-rtm": "2.2.2-3",
     "await-to-js": "^3.0.0",