agora-rte-sdk 3.8.2 → 3.9.0-alpha

package/lib/core/media/screen.d.ts

@@ -23,28 +23,36 @@ export interface AgoraRteScreenTrack extends AgoraRteObservableTrack<AgoraRteScr
      * Sets the capture parameters for the screen.
      * @param params The parameters for the video capture.
      */
-    startPreview(config: AgoraRteVideoRenderConfig, view: unknown): void;
+    startPreview(config: AgoraRteVideoRenderConfig, view: unknown): number;
     /**
      * Stops the screen video track for the specified source.
      * @returns A promise that resolves when the stop is successful.
      */
-    stopPreview(): void;
+    stopPreview(): number;
     /**
      * Sets the capture parameters for the screen.
      * @param params The parameters for the video capture.
      */
-    setCaptureParams(params: AgoraRteScreenCaptureParams): void;
+    setCaptureParams(params: AgoraRteScreenCaptureParams): number;
     /**
      * Starts the screen video track with the specified type and parameters.
      * @param type The type of screen capture.
      * @param excludeWindowList The list of window IDs to exclude from the screen capture.
      * @returns A promise that resolves when the start is successful.
      */
-    start(type: AgoraRteScreenCaptureType, excludeWindowList: string[]): void;
+    start(type: AgoraRteScreenCaptureType, excludeWindowList: string[]): number;
     /**
      * Stops the screen video track for the specified source.
      * @param type The type of screen capture.
      * @returns A promise that resolves when the stop is successful.
      */
-    stop(): void;
+    stop(): number;
+    /**
+     * Updates the screen capture exclude window list.
+     * @param excludeWindowList The list of window to exclude from the screen capture.
+     * @returns number
+     * 0: success
+     * < 0: failure
+     */
+    updateExcludeWindows(excludeWindowList: string[]): number;
 }

package/lib/core/media/screen.js

@@ -41,6 +41,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.AgoraRteScreenTrackImpl = exports.AgoraRteScreenDummyTrackImpl = void 0;
+require("core-js/modules/es.array.concat.js");
 require("core-js/modules/es.function.bind.js");
 var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
@@ -55,8 +56,9 @@ var _baseTrack = require("./base-track");
 var _type3 = require("./type");
 var _logger = require("../utilities/logger");
 var _imports = require("../../imports");
+var _constant = require("../../constant");
 var _ref, _AgoraRteScreenTrackImpl;
-var _initProto;
+var _initProto, _setCaptureParamsDecs, _startDecs, _updateExcludeWindowsDecs, _startPreviewDecs, _ref2;
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2["default"])(o), (0, _possibleConstructorReturn2["default"])(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2["default"])(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
 function _applyDecs(e, t, r, n, o, a) { function i(e, t, r) { return function (n, o) { return r && r(n), e[t].call(n, o); }; } function c(e, t) { for (var r = 0; r < e.length; r++) e[r].call(t); return t; } function s(e, t, r, n) { if ("function" != typeof e && (n || void 0 !== e)) throw new TypeError(t + " must " + (r || "be") + " a function" + (n ? "" : " or undefined")); return e; } function applyDec(e, t, r, n, o, a, c, u, l, f, p, d, h) { function m(e) { if (!h(e)) throw new TypeError("Attempted to access private element on non-instance"); } var y, v = t[0], g = t[3], b = !u; if (!b) { r || Array.isArray(v) || (v = [v]); var w = {}, S = [], A = 3 === o ? "get" : 4 === o || d ? "set" : "value"; f ? (p || d ? w = { get: _setFunctionName(function () { return g(this); }, n, "get"), set: function set(e) { t[4](this, e); } } : w[A] = g, p || _setFunctionName(w[A], n, 2 === o ? "" : A)) : p || (w = Object.getOwnPropertyDescriptor(e, n)); } for (var P = e, j = v.length - 1; j >= 0; j -= r ? 2 : 1) { var D = v[j], E = r ? v[j - 1] : void 0, I = {}, O = { kind: ["field", "accessor", "method", "getter", "setter", "class"][o], name: n, metadata: a, addInitializer: function (e, t) { if (e.v) throw Error("attempted to call addInitializer after decoration was finished"); s(t, "An initializer", "be", !0), c.push(t); }.bind(null, I) }; try { if (b) (y = s(D.call(E, P, O), "class decorators", "return")) && (P = y);else { var k, F; O["static"] = l, O["private"] = f, f ? 2 === o ? k = function k(e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function k(e) { return e[n]; }, (o < 2 || 4 === o) && (F = function F(e, t) { e[n] = t; })); var N = O.access = { has: f ? h.bind() : function (e) { return n in e; } }; if (k && (N.get = k), F && (N.set = F), P = D.call(E, d ? { get: w.get, set: w.set } : w[A], O), d) { if ("object" == _typeof(P) && P) (y = s(P.get, "accessor.get")) && (w.get = y), (y = s(P.set, "accessor.set")) && (w.set = y), (y = s(P.init, "accessor.init")) && S.push(y);else if (void 0 !== P) throw new TypeError("accessor decorators must return an object with get, set, or init properties or void 0"); } else s(P, (p ? "field" : "method") + " decorators", "return") && (p ? S.push(P) : w[A] = P); } } finally { I.v = !0; } } return (p || d) && u.push(function (e, t) { for (var r = S.length - 1; r >= 0; r--) t = S[r].call(e, t); return t; }), p || b || (f ? d ? u.push(i(w, "get"), i(w, "set")) : u.push(2 === o ? w[A] : i.call.bind(w[A])) : Object.defineProperty(e, n, w)), P; } function u(e, t) { return Object.defineProperty(e, Symbol.metadata || Symbol["for"]("Symbol.metadata"), { configurable: !0, enumerable: !0, value: t }); } if (arguments.length >= 6) var l = a[Symbol.metadata || Symbol["for"]("Symbol.metadata")]; var f = Object.create(null == l ? null : l), p = function (e, t, r, n) { var o, a, i = [], s = function s(t) { return _checkInRHS(t) === e; }, u = new Map(); function l(e) { e && i.push(c.bind(null, e)); } for (var f = 0; f < t.length; f++) { var p = t[f]; if (Array.isArray(p)) { var d = p[1], h = p[2], m = p.length > 3, y = 16 & d, v = !!(8 & d), g = 0 == (d &= 7), b = h + "/" + v; if (!g && !m) { var w = u.get(b); if (!0 === w || 3 === w && 4 !== d || 4 === w && 3 !== d) throw Error("Attempted to decorate a public method/accessor that has the same name as a previously decorated public method/accessor. This is not currently supported by the decorators plugin. Property name was: " + h); u.set(b, !(d > 2) || d); } applyDec(v ? e : e.prototype, p, y, m ? "#" + h : _toPropertyKey(h), d, n, v ? a = a || [] : o = o || [], i, v, m, g, 1 === d, v && m ? s : r); } } return l(o), l(a), i; }(e, t, o, f); return r.length || u(e, f), { e: p, get c() { var t = []; return r.length && [u(applyDec(e, [r], n, e.name, 5, f, t), f), c.bind(null, t, e)]; } }; }
@@ -67,13 +69,14 @@ function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side
 /**
  * Interface for a screen video track in Agora RTE SDK.
  */
+_ref2 = (_setCaptureParamsDecs = (0, _imports.trace)(['params']), _startDecs = (0, _imports.trace)(['type', 'excludeWindowList']), _updateExcludeWindowsDecs = (0, _imports.trace)(['excludeWindowList']), _startPreviewDecs = (0, _imports.trace)(['config', 'view']), "logger");
 //@internal
-var AgoraRteScreenTrackImpl = exports.AgoraRteScreenTrackImpl = /*#__PURE__*/function (_ref2) {
+var AgoraRteScreenTrackImpl = exports.AgoraRteScreenTrackImpl = /*#__PURE__*/function (_ref3) {
   function AgoraRteScreenTrackImpl(_rtcClient, _sourceId) {
     var _this;
     (0, _classCallCheck2["default"])(this, AgoraRteScreenTrackImpl);
     _this = _callSuper(this, AgoraRteScreenTrackImpl, [_rtcClient]);
-    (0, _defineProperty2["default"])(_this, "logger", (_initProto(_this), (0, _logger.createLogger)({
+    (0, _defineProperty2["default"])(_this, _ref2, (_initProto(_this), (0, _logger.createLogger)({
       prefix: 'AgoraRteScreenTrackImpl'
     })));
     (0, _defineProperty2["default"])(_this, "_state", _type.AgoraRteMediaSourceState.CLOSE);
@@ -85,7 +88,7 @@ var AgoraRteScreenTrackImpl = exports.AgoraRteScreenTrackImpl = /*#__PURE__*/fun
     });
     return _this;
   }
-  (0, _inherits2["default"])(AgoraRteScreenTrackImpl, _ref2);
+  (0, _inherits2["default"])(AgoraRteScreenTrackImpl, _ref3);
   return (0, _createClass2["default"])(AgoraRteScreenTrackImpl, [{
     key: "getSourceId",
     value: function getSourceId() {
@@ -105,6 +108,7 @@ var AgoraRteScreenTrackImpl = exports.AgoraRteScreenTrackImpl = /*#__PURE__*/fun
     key: "setCaptureParams",
     value: function setCaptureParams(params) {
       this._params = params;
+      return _constant.AgoraRteReturnCode.SUCCESS;
     }
   }, {
     key: "start",
@@ -112,15 +116,15 @@ var AgoraRteScreenTrackImpl = exports.AgoraRteScreenTrackImpl = /*#__PURE__*/fun
       this._captureType = type;
       if (type === _type2.AgoraRtcScreenCaptureType.SCREEN) {
         if (this._params) {
-          this._rtcClient.sourceManager.startScreenCaptureByDisplayIdWithParams(this._sourceId, this._params, excludeWindowList);
+          return this._rtcClient.sourceManager.startScreenCaptureByDisplayIdWithParams(this._sourceId, this._params, excludeWindowList);
         } else {
-          this._rtcClient.sourceManager.startScreenCaptureByDisplayId(this._sourceId, excludeWindowList);
+          return this._rtcClient.sourceManager.startScreenCaptureByDisplayId(this._sourceId, excludeWindowList);
         }
       } else {
         if (this._params) {
-          this._rtcClient.sourceManager.startScreenCaptureByWindowIdWithParams(this._sourceId, this._params);
+          return this._rtcClient.sourceManager.startScreenCaptureByWindowIdWithParams(this._sourceId, this._params);
         } else {
-          this._rtcClient.sourceManager.startScreenCaptureByWindowId(this._sourceId);
+          return this._rtcClient.sourceManager.startScreenCaptureByWindowId(this._sourceId);
         }
       }
     }
@@ -129,18 +133,29 @@ var AgoraRteScreenTrackImpl = exports.AgoraRteScreenTrackImpl = /*#__PURE__*/fun
     value: function stop() {
       return this._rtcClient.sourceManager.stopScreenCapture(this._sourceId, this._captureType);
     }
+  }, {
+    key: "updateExcludeWindows",
+    value: function updateExcludeWindows(excludeWindowList) {
+      if (this._captureType === _type2.AgoraRtcScreenCaptureType.SCREEN) {
+        return this._rtcClient.sourceManager.updateExcludeWindowsByDisplayId(this._sourceId, excludeWindowList);
+      } else {
+        this.logger.warn("updateExcludeWindows called with supported capture type: ".concat(_type2.AgoraRtcScreenCaptureType.SCREEN, ", but received: ").concat(this._captureType));
+        return 0;
+      }
+    }
   }, {
     key: "startPreview",
     value: function startPreview(config, view) {
       this._view = view;
-      this._rtcClient.startRenderScreenPreview(this._sourceId, view, _type2.AgoraRtcScreenCaptureType.SCREEN, config.renderMode, config.isMirror);
+      return this._rtcClient.startRenderScreenPreview(this._sourceId, view, _type2.AgoraRtcScreenCaptureType.SCREEN, config.renderMode, config.isMirror);
     }
   }, {
     key: "stopPreview",
     value: function stopPreview() {
       if (this._view) {
-        this._rtcClient.stopRenderScreenPreview(this._sourceId, this._view, _type2.AgoraRtcScreenCaptureType.SCREEN);
+        return this._rtcClient.stopRenderScreenPreview(this._sourceId, this._view, _type2.AgoraRtcScreenCaptureType.SCREEN);
       }
+      return _constant.AgoraRteReturnCode.UNDEFINED;
     }
   }, {
     key: "_handleScreenCaptureStateUpdated",
@@ -153,7 +168,7 @@ var AgoraRteScreenTrackImpl = exports.AgoraRteScreenTrackImpl = /*#__PURE__*/fun
   }]);
 }(_ref = _baseTrack.AgoraRteBaseTrack); // @internal
 _AgoraRteScreenTrackImpl = AgoraRteScreenTrackImpl;
-var _applyDecs$e = (0, _slicedToArray2["default"])(_applyDecs(_AgoraRteScreenTrackImpl, [[_imports.trace, 2, "setCaptureParams"], [_imports.trace, 2, "start"], [_imports.trace, 2, "stop"], [_imports.trace, 2, "startPreview"], [_imports.trace, 2, "stopPreview"]], [], 0, void 0, _ref).e, 1);
+var _applyDecs$e = (0, _slicedToArray2["default"])(_applyDecs(_AgoraRteScreenTrackImpl, [[_setCaptureParamsDecs, 2, "setCaptureParams"], [_startDecs, 2, "start"], [_imports.trace, 2, "stop"], [_updateExcludeWindowsDecs, 2, "updateExcludeWindows"], [_startPreviewDecs, 2, "startPreview"], [_imports.trace, 2, "stopPreview"]], [], 0, void 0, _ref).e, 1);
 _initProto = _applyDecs$e[0];
 var AgoraRteScreenDummyTrackImpl = exports.AgoraRteScreenDummyTrackImpl = /*#__PURE__*/function () {
   function AgoraRteScreenDummyTrackImpl() {
@@ -182,18 +197,33 @@ var AgoraRteScreenDummyTrackImpl = exports.AgoraRteScreenDummyTrackImpl = /*#__P
     }
   }, {
     key: "startPreview",
-    value: function startPreview(config, view) {}
+    value: function startPreview(config, view) {
+      return 0;
+    }
   }, {
     key: "stopPreview",
-    value: function stopPreview() {}
+    value: function stopPreview() {
+      return 0;
+    }
   }, {
     key: "setCaptureParams",
-    value: function setCaptureParams(params) {}
+    value: function setCaptureParams(params) {
+      return 0;
+    }
   }, {
     key: "start",
-    value: function start(type, excludeWindowList) {}
+    value: function start(type, excludeWindowList) {
+      return 0;
+    }
   }, {
     key: "stop",
-    value: function stop() {}
+    value: function stop() {
+      return 0;
+    }
+  }, {
+    key: "updateExcludeWindows",
+    value: function updateExcludeWindows(excludeWindowList) {
+      return 0;
+    }
   }]);
 }();

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

@@ -1,5 +1,9 @@
-import { AgoraRteMediaSourceState } from '../../type';
-import { AgoraRtcAudioOutputRouting, AgoraRtcAudioRawDataConfig, AgoraRtcBeautyOptions, AgoraRtcCameraCaptureParams, AgoraRtcDeviceInfo, AgoraRtcDimensions, AgoraRtcRenderMode, AgoraRtcScreenCaptureParams, AgoraRtcVirtualBackgroundOptions } from '../rtc/type';
+import { AgoraRteAudioSourceType, AgoraRteMediaSourceState, AgoraRteVideoSourceType } from '../../type';
+import { AgoraRtcAudioOutputRouting, AgoraRtcAudioRawDataConfig, AgoraRtcBeautyOptions, AgoraRtcCameraCaptureParams, AgoraRtcCapability, AgoraRtcDeviceInfo, AgoraRtcDimensions, AgoraRtcDisplayInfo, AgoraRtcRenderMode, AgoraRtcScreenCaptureParams, AgoraRtcVirtualBackgroundOptions, AgoraRtcWindowInfo } from '../rtc/type';
+import { AgoraRteCameraTrack } from './camera';
+import { AgoraRteLoopbackTrack } from './loopback';
+import { AgoraRteMicrophoneTrack } from './microphone';
+import { AgoraRteScreenTrack } from './screen';
 /**
  * 音频的输出位置
  */
@@ -65,6 +69,159 @@ export type AgoraRteMediaControlObserver = Partial<{
     onSystemSelectedSpeakerChanged(speaker: AgoraRtcDeviceInfo): void;
     onSystemSelectedMicrophoneChanged(microphone: AgoraRtcDeviceInfo): void;
 }>;
+export interface AgoraRteMediaControlInternalObsever extends AgoraRteMediaControlObserver {
+    onTrackVideoStateUpdated?: (sourceId: string, sourceType: AgoraRteVideoSourceType, state: AgoraRteMediaSourceState) => void;
+    onTrackAudioStateUpdated?: (sourceId: string, sourceType: AgoraRteAudioSourceType, state: AgoraRteMediaSourceState) => void;
+}
+/**
+ * Interface for the Agora Real-Time Engagement Media Control.
+ */
+export interface AgoraRteMediaControl {
+    /**
+     * Retrieves a list of available loopback devices.
+     * @returns An array of available loopback devices.
+     */
+    getLoopbackList(): AgoraRtcDeviceInfo[];
+    /**
+     * Retrieves a list of available cameras.
+     * @returns An array of available cameras.
+     */
+    getCameraList(): Promise<AgoraRtcDeviceInfo[]>;
+    /**
+     * Retrieves a list of available microphones.
+     * @returns An array of available microphones.
+     */
+    getMicrophoneList(): Promise<AgoraRtcDeviceInfo[]>;
+    /**
+     * Retrieves a list of available speakers.
+     * @returns An array of available speakers.
+     */
+    getSpeakerList(): Promise<AgoraRtcDeviceInfo[]>;
+    /**
+     * Retrieves the system-selected microphone.
+     * @returns The system-selected microphone.
+     */
+    getSystemSelectedMicrophone(): Promise<AgoraRtcDeviceInfo | undefined>;
+    /**
+     * Retrieves the system-selected speaker.
+     * @returns The system-selected speaker.
+     */
+    getSystemSelectedSpeaker(): Promise<AgoraRtcDeviceInfo | undefined>;
+    /**
+     * Retrieves a list of available windows for screen sharing.
+     * Only available in Electron, in browsers this method returns an empty array.
+     * @returns A promise that resolves to an array of available windows.
+     */
+    getWindowList(): Promise<AgoraRtcWindowInfo[]>;
+    /**
+     * Retrieves a list of available displays for screen sharing.
+     * Only available in Electron, in browsers this method returns an empty array.
+     * @returns A promise that resolves to an array of available displays.
+     */
+    getDisplayList(): Promise<AgoraRtcDisplayInfo[]>;
+    /**
+     * Retrieves the camera video track for a specific device.
+     * @param deviceId The ID of the device.
+     * @returns The camera video track.
+     */
+    getCameraTrack(deviceId: string): AgoraRteCameraTrack;
+    /**
+     * Retrieves the microphone audio track for a specific device.
+     * @param deviceId The ID of the device.
+     * @returns The microphone audio track.
+     */
+    getMicrophoneTrack(deviceId: string): AgoraRteMicrophoneTrack;
+    /**
+     * Retrieves the screen video track for a specific source.
+     * @param sourceId The ID of the source.
+     * @returns The screen video track.
+     */
+    getScreenTrack(sourceId: string): AgoraRteScreenTrack;
+    /**
+     * Retrieves the loopback audio track for a specific source.
+     * @param sourceId The ID of the source.
+     * @returns The loopback audio track.
+     */
+    getLoopbackTrack(sourceId: string): AgoraRteLoopbackTrack;
+    /**
+     * Sets a speaker for audio playback.
+     * @param deviceId The ID of the speaker device.
+     */
+    setSelectedSpeaker(deviceId: string): number;
+    /**
+     * Enable/Disable speaker playback.
+     * @param enable Whether to enable speaker playback.
+     */
+    setEnableSpeaker(enable: boolean): void;
+    /**
+     * Get the current audio output routing of the SDK
+     */
+    getAudioOutputRouting(): AgoraRtcAudioOutputRouting;
+    /**
+     * Starts a speaker test.
+     * @param url The URL of the audio file for the test.
+     */
+    startSpeakerTest(url: string): number;
+    /**
+     * Stops a speaker test.
+     */
+    stopSpeakerTest(): number;
+    /**
+     * Adjusts the playback audio volume.
+     * @param volume
+     */
+    adjustAudioOutputVolume(volume: number): number;
+    /**
+     * Check if the media control supports the specified capability.
+     * @param capability
+     */
+    isCapabilitySupported(capability: AgoraRtcCapability): boolean;
+    /**
+     * Set the volume of the selected speaker
+     * @param volume The volume to set
+     */
+    setSelectedSpeakerVolume(volume: number): number;
+    /**
+     * Get the volume of the selected speaker
+     */
+    getSelectedSpeakerVolume(): number;
+    /**
+     * Disable AGC
+     * @returns 0 if the AGC is disabled; otherwise,
+     * 1 if the AGC is not supported
+     */
+    disableAGC(): number;
+    /**
+     * Enable AGC
+     * @returns 0 if the AGC is enabled; otherwise,
+     * 1 if the AGC is not supported
+     */
+    enableAGC(): number;
+    /**
+     * Observe the system selected speaker
+     * @param enable
+     */
+    observeSystemSelectedSpeakerChanged(enable: boolean): number;
+    /**
+     * Observe the system selected microphone
+     * @param enable
+     */
+    observeSystemSelectedMicrophoneChanged(enable: boolean): number;
+    /**
+     * Adds an observer to be notified of media device events.
+     * @param observer The observer to add.
+     */
+    addObserver(observer: AgoraRteMediaControlObserver): void;
+    /**
+     * Removes an observer from the media device events.
+     * @param observer The observer to remove.
+     */
+    removeObserver(observer: AgoraRteMediaControlObserver): void;
+    /**
+     * Releases the resources used by the media control.
+     */
+    release(): number;
+}
 export type AgoraRteObservableTrack<T> = {
     addObserver(observer: T): void;
     removeObserver(observer: T): void;

package/lib/core/media/type.js

@@ -64,4 +64,7 @@ var AgoraRteMediaPublishState = exports.AgoraRteMediaPublishState = /*#__PURE__*
   AgoraRteMediaPublishState[AgoraRteMediaPublishState["UNPUBLISHED"] = 0] = "UNPUBLISHED";
   AgoraRteMediaPublishState[AgoraRteMediaPublishState["PUBLISHED"] = 1] = "PUBLISHED";
   return AgoraRteMediaPublishState;
-}({});
+}({});
+/**
+ * Interface for the Agora Real-Time Engagement Media Control.
+ */

package/lib/core/processor/message-handler.d.ts

@@ -1,11 +1,11 @@
 import { AgoraObservable } from '../../imports';
-import { AgoraRteSyncDataStore } from './sequence-msg/data';
-import { AgoraRteSequenceMessage, AgoraRteMessageHandlerObserver, AgoraRteSequenceMessageInUser, AgoraRteSequenceMessageOutUser } from './type';
-import { AgoraRteSyncSnapshotData } from './struct';
-import { AgoraRteServiceApi } from '../services/api';
 import { AgoraRtmClient } from '../rtm';
 import { AgoraRtmChannelClient } from '../rtm/channel';
 import { AgoraRteMediaStreamInfo, AgoraRteUserInfo } from '../scene/type';
+import { AgoraRteServiceApi } from '../services/api';
+import { AgoraRteSyncDataStore } from './sequence-msg/data';
+import { AgoraRteSyncSnapshotData } from './struct';
+import { AgoraRteMessageHandlerObserver, AgoraRteSequenceMessage, AgoraRteSequenceMessageInUser, AgoraRteSequenceMessageOutUser } from './type';
 export declare class AgoraRteMessageHandle {
     protected readonly logger: import("agora-foundation/lib/logger/type").Logger;
     protected readonly observable: AgoraObservable<Partial<{

package/lib/core/processor/message-handler.js

@@ -90,15 +90,15 @@ var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/cl
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
 var _imports = require("../../imports");
+var _type = require("../rtm/type");
+var _clone = require("../utilities/clone");
+var _diff = require("../utilities/diff");
+var _logger = require("../utilities/logger");
 var _data = require("./sequence-msg/data");
-var _type = require("./type");
+var _messageParser = require("./sequence-msg/message-parser");
 var _struct = require("./struct");
 var _synchronizer = require("./synchronizer");
-var _messageParser = require("./sequence-msg/message-parser");
-var _type2 = require("../rtm/type");
-var _clone = require("../utilities/clone");
-var _logger = require("../utilities/logger");
-var _diff = require("../utilities/diff");
+var _type2 = require("./type");
 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; } } }; }
 function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
 function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
@@ -116,7 +116,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
     }));
     (0, _defineProperty2["default"])(this, "observable", new _imports.AgoraObservable());
     (0, _defineProperty2["default"])(this, "_timestampGap", 0);
-    (0, _defineProperty2["default"])(this, "_rtmConnectionState", _type2.AgoraRtmConnectionState.DISCONNECTED);
+    (0, _defineProperty2["default"])(this, "_rtmConnectionState", _type.AgoraRtmConnectionState.DISCONNECTED);
     this._onSeqMessage = this._onSeqMessage.bind(this);
     this.handleSeqMessage = this.handleSeqMessage.bind(this);
     this._handleUserSubscribe = this._handleUserSubscribe.bind(this);
@@ -131,15 +131,53 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
     this._channelMessageSynchronizer = new _synchronizer.AgoraRteSynchronizerManager({
       apiService: apiService,
       sceneId: sceneId,
-      sequenceType: _type.AgoraRteSequenceType.CHANNEL_SEQUENCE,
+      sequenceType: _type2.AgoraRteSequenceType.CHANNEL_SEQUENCE,
       userId: userId
     });
     this._peerMessageSynchronizer = new _synchronizer.AgoraRteSynchronizerManager({
       apiService: apiService,
       sceneId: sceneId,
-      sequenceType: _type.AgoraRteSequenceType.PEER_SEQUENCE,
+      sequenceType: _type2.AgoraRteSequenceType.PEER_SEQUENCE,
       userId: userId
     });
+
+    // this.addObserver(
+    //   generateLogObserver(this.logger, [
+    //     ['onCustomChannelMessageRecieved', ['message']],
+
+    //     ['onLocalStreamAdded', ['streams', 'operator', 'cause']],
+    //     ['onLocalStreamRemoved', ['streams', 'operator', 'cause']],
+    //     ['onLocalStreamUpdated', ['streams', 'operator', 'cause']],
+
+    //     ['onRemoteStreamAdded', ['streams', 'operator', 'cause']],
+    //     ['onRemoteStreamRemoved', ['streams', 'operator', 'cause']],
+    //     ['onRemoteStreamUpdated', ['streams', 'operator', 'cause']],
+
+    //     [
+    //       'onLocalUserAdded',
+    //       ['user', 'addedStreamsData', 'removedStreamsData', 'updatedStreamsData'],
+    //     ],
+    //     ['onLocalUserRemoved', ['user']],
+
+    //     ['onRemoteUsersAdded', ['users']],
+    //     ['onRemoteUsersRemoved', ['removedUsers', 'removedStreamsData']],
+
+    //     ['onRoomPropertyDeleted', ['changedKeys', 'operator', 'cause']],
+    //     ['onRoomPropertyUpdated', ['changeProperties', 'changedKeys', 'operator', 'cause']],
+    //     ['onSnapshotUpdated', ['snapshot']],
+    //     ['onTimeStampGapUpdate', ['gap']],
+    //     ['onUserCountUpdated', ['total']],
+
+    //     ['onUserPropertyDeleted', ['userUuid', 'changedKeys', 'operator', 'cause']],
+    //     ['onUserPropertyListUpdated', ['changedProperties', 'operator', 'cause']],
+    //     ['onUserPropertyUpdated', ['userUuid', 'userProperties', 'operator', 'cause']],
+
+    //     ['onUserSubscribe', ['subscribeUsers', 'addedStreamsData', 'operator', 'cause']],
+    //     ['onUserUnsubscribe', ['unsubscribeUsers', 'removedStreamsData', 'operator', 'cause']],
+    //     ['onUserUpdated', ['user', 'operator', 'cause']],
+    //   ]),
+    // );
+
     this._addMessageEventListeners();
     this._addConnectionEventListeners();
     this.logger.info('initialized, sceneId:', this.sceneId);
@@ -197,7 +235,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
   }, {
     key: "_onConnectionStateUpdated",
     value: function _onConnectionStateUpdated(state) {
-      if ((this._rtmConnectionState === _type2.AgoraRtmConnectionState.RECONNECTING || this._rtmConnectionState === _type2.AgoraRtmConnectionState.CONNECTING) && state === _type2.AgoraRtmConnectionState.CONNECTED) {
+      if ((this._rtmConnectionState === _type.AgoraRtmConnectionState.RECONNECTING || this._rtmConnectionState === _type.AgoraRtmConnectionState.CONNECTING) && state === _type.AgoraRtmConnectionState.CONNECTED) {
         var syncCount = 100;
         this.logger.info("RTM connection state updated to connected, start sync sequence for last ".concat(syncCount));
         this._channelMessageSynchronizer.syncSequence(syncCount);
@@ -264,7 +302,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
         messageSynchronizer.addTasks(tasks);
       } else {
         tasks.forEach(function (task) {
-          if (task.cmd === _type.AgoraRteServerMessageCmd.MESSAGE_EXTENSION) {
+          if (task.cmd === _type2.AgoraRteServerMessageCmd.MESSAGE_EXTENSION) {
             _this2._handleCustomMessage(task);
           }
         });
@@ -306,36 +344,36 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
     key: "_handleSimpleMessage",
     value: function _handleSimpleMessage(task, cmd) {
       switch (cmd) {
-        case _type.AgoraRteServerMessageCmd.ROOM_PROPERTY:
+        case _type2.AgoraRteServerMessageCmd.ROOM_PROPERTY:
           // room property change struct aligns with properties so use the same handling func
           this._handleRoomProperties(task);
           break;
-        case _type.AgoraRteServerMessageCmd.ROOM_PROPERTIES:
+        case _type2.AgoraRteServerMessageCmd.ROOM_PROPERTIES:
           this._handleRoomProperties(task);
           break;
-        case _type.AgoraRteServerMessageCmd.USER_IN_OUT:
+        case _type2.AgoraRteServerMessageCmd.USER_IN_OUT:
           this._handleUserInOut(task);
           break;
-        case _type.AgoraRteServerMessageCmd.USER_INFO:
+        case _type2.AgoraRteServerMessageCmd.USER_INFO:
           this._handleUserInfo(task);
           break;
-        case _type.AgoraRteServerMessageCmd.USER_PROPERTY:
+        case _type2.AgoraRteServerMessageCmd.USER_PROPERTY:
           this._handleUserProperty(task);
           break;
-        case _type.AgoraRteServerMessageCmd.USER_PROPERTIES:
-        case _type.AgoraRteServerMessageCmd.USER_PRIVATE_PROPERTIES:
+        case _type2.AgoraRteServerMessageCmd.USER_PROPERTIES:
+        case _type2.AgoraRteServerMessageCmd.USER_PRIVATE_PROPERTIES:
           this._handleUserProperties(task);
           break;
-        case _type.AgoraRteServerMessageCmd.USER_SUBSCRIBE:
+        case _type2.AgoraRteServerMessageCmd.USER_SUBSCRIBE:
           this._handleUserSubscribe(task);
           break;
-        case _type.AgoraRteServerMessageCmd.STREAM_IN_OUT:
+        case _type2.AgoraRteServerMessageCmd.STREAM_IN_OUT:
           this._handleStreamInOut(task);
           break;
-        case _type.AgoraRteServerMessageCmd.STREAMS_IN_OUT:
+        case _type2.AgoraRteServerMessageCmd.STREAMS_IN_OUT:
           this._handleStreamsInOut(task);
           break;
-        case _type.AgoraRteServerMessageCmd.MESSAGE_EXTENSION:
+        case _type2.AgoraRteServerMessageCmd.MESSAGE_EXTENSION:
           this._handleCustomMessage(task);
           break;
         default:
@@ -346,7 +384,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
     key: "_handleBatchMessage",
     value: function _handleBatchMessage(task, cmd) {
       switch (cmd) {
-        case _type.AgoraRteServerMessageCmd.USER_PROPERTIES:
+        case _type2.AgoraRteServerMessageCmd.USER_PROPERTIES:
           this._handleUserPropertyList(task);
           break;
       }
@@ -440,7 +478,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
       var changedKeys = Array.from(new Set(Object.keys(changeProperties).map(function (k) {
         return k.split('.')[0];
       })));
-      if (action === _type.AgoraRteSequenceMessagePropertiesAction.UPSERT) {
+      if (action === _type2.AgoraRteSequenceMessagePropertiesAction.UPSERT) {
         this.observable.notifyObservers('onRoomPropertyUpdated', changeProperties, changedKeys,
         // FIXME: get real connector
         _struct.AgoraRteUser.fromSeqData(_objectSpread({}, operator)), cause);
@@ -473,7 +511,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
         } else {
           user = _struct.AgoraRteUser.fromSeqData(u);
         }
-        if (u.subscribe === _type.AgoraRteSequenceMessageSubscribeUserState.SUBSCRIBE) {
+        if (u.subscribe === _type2.AgoraRteSequenceMessageSubscribeUserState.SUBSCRIBE) {
           _this4._dataStore.setUser(user.userId, user);
           var _u$streams = u.streams,
             streams = _u$streams === void 0 ? [] : _u$streams;
@@ -485,7 +523,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
             _this4._dataStore.setStream(stream.streamId, stream);
           });
           subscribeUsersData.push(user);
-        } else if (u.subscribe === _type.AgoraRteSequenceMessageSubscribeUserState.UNSUBSCRIBE) {
+        } else if (u.subscribe === _type2.AgoraRteSequenceMessageSubscribeUserState.UNSUBSCRIBE) {
           var _streams = _this4._dataStore.findUserStreams(u.userUuid);
           var streamUuids = _streams.map(function (stream) {
             return stream.streamId;
@@ -728,7 +766,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
       }
       var mergedProperties = this._mergeProperties((_user$userProperties2 = user.userProperties) !== null && _user$userProperties2 !== void 0 ? _user$userProperties2 : {}, changeProperties);
       user.setUserProperties(mergedProperties);
-      if (action === _type.AgoraRteSequenceMessagePropertiesAction.UPSERT) {
+      if (action === _type2.AgoraRteSequenceMessagePropertiesAction.UPSERT) {
         this.observable.notifyObservers('onUserPropertyUpdated', userUuid, changeProperties,
         // FIXME: get real connector
         _struct.AgoraRteUser.fromSeqData(_objectSpread({}, operator)), cause);
@@ -849,7 +887,7 @@ var AgoraRteMessageHandle = exports.AgoraRteMessageHandle = /*#__PURE__*/functio
     value: function release() {
       this._removeConnectionEventListeners();
       this._removeMessageEventListeners();
-      this._rtmConnectionState = _type2.AgoraRtmConnectionState.DISCONNECTED;
+      this._rtmConnectionState = _type.AgoraRtmConnectionState.DISCONNECTED;
       this._channelMessageSynchronizer.release();
       this._peerMessageSynchronizer.release();
     }

package/lib/core/processor/sequence-msg/data.d.ts

@@ -7,19 +7,21 @@ export declare class AgoraRteSyncDataStore {
     private _streams;
     private _roomProperties;
     get users(): Immutable.Map<string, AgoraRteUser>;
-    setUsers(users: Record<string, AgoraRteUser>): void;
-    setUser(key: string, user: AgoraRteUser): void;
-    deleteUser(key: string): void;
+    setUsers(users: Record<string, AgoraRteUser>): number;
+    setUser(key: string, user: AgoraRteUser): number;
+    deleteUser(key: string): number;
     findUser(userUuid: string): AgoraRteUser | undefined;
     get roomProperties(): Record<string, unknown>;
     setRoomProperties(roomProperties: Record<string, unknown>): void;
     get streams(): Immutable.Map<string, AgoraRteMediaStream>;
-    setStreams(streams: Record<string, AgoraRteMediaStream>): void;
+    setStreams(streams: Record<string, AgoraRteMediaStream>): number;
     findUserStreams(userId: string): AgoraRteMediaStream[];
-    setStream(key: string, stream: AgoraRteMediaStream): void;
-    deleteStream(key: string): void;
-    deleteStreams(keys: string[]): void;
+    setStream(key: string, stream: AgoraRteMediaStream): number;
+    deleteStream(key: string): number;
+    deleteStreams(keys: string[]): number;
     findStream(streamUuid: string): AgoraRteMediaStream | undefined;
     get userCount(): number;
     setUserCount(userCount: number): void;
+    getRoomPropertiesDeepCloneByKeyPath(keyPath: string): unknown;
+    getUserPropertiesDeepCloneByKeyPath(userId: string, keyPath: string): unknown;
 }