agora-rte-sdk 2.8.21 → 2.8.30

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

@@ -4,7 +4,8 @@ import { AGRtcConfig } from './adapter';
 import { LocalAudioTrackStateEvent, LocalVideoTrackStateEvent, RtcAudioDeviceManagerBase, RtcVideoDeviceManagerBase } from './adapter/base';
 import { AgoraRtcVideoCanvas } from './canvas';
 import { AGRtcChannel } from './channel';
-import { AGRtcDeviceInfo, AGScreenShareDevice, AGScreenShareType, AGBeautyEffect, AGAudioRawDataConfig } from './type';
+import { AGRtcDeviceInfo, AGScreenShareDevice, AGScreenShareType, AGBeautyEffect } from './type';
+import { AgoraRteAudioRawDataConfig, AgoraRteAudioRawDataObserver, AgoraRteAudioRawDataPosition } from '../media/type';
 export declare class AGRtcManager {
     private _adapter;
     private _channels;
@@ -34,8 +35,6 @@ export declare class AGRtcManager {
     stopAudioRecordingDeviceTest(): number;
     startAudioPlaybackDeviceTest(url: string): number;
     stopAudioPlaybackDeviceTest(): number;
-    setAudioFrameCallback(): number;
-    stopAudioFrameCallback(): number;
     onAutoPlayFailed(cb: () => void): number;
     onLocalCameraListChanged(cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void): number;
     onLocalRecordingDeviceListChanged(cb: (addNewDevice: boolean, newDevices: AGRtcDeviceInfo[], allDevices: AGRtcDeviceInfo[]) => void): number;
@@ -44,7 +43,9 @@ export declare class AGRtcManager {
     onLocalAudioTrackStateChanged(cb: LocalAudioTrackStateEvent): number;
     onLocalAudioVolume(cb: (volume: number) => void): number;
     setBeautyEffectOptions(enable: boolean, options: AGBeautyEffect): number;
-    setAudioRawDataConfig(config: AGAudioRawDataConfig): number;
+    setAudioRawDataConfig(config: AgoraRteAudioRawDataConfig, position: AgoraRteAudioRawDataPosition): number;
+    addAudioRawDataObserver(observer: AgoraRteAudioRawDataObserver, position: AgoraRteAudioRawDataPosition): number;
+    removeAudioRawDataObserver(observer: AgoraRteAudioRawDataObserver, position: AgoraRteAudioRawDataPosition): number;
     hasScreenSharePermission(): boolean;
     takeSnapshot(channel: string, streamUuid: number, filePath: string): Promise<void | import("./type").AGSnapshotInfo>;
     getCurrentFrameData(channelName: string, streamUuid: string, isLocal: boolean): ImageData;

package/lib/core/rtc/index.js

@@ -151,16 +151,6 @@ var AGRtcManager = (_dec = _decorator.Log.attach(), _dec2 = _decorator.Log.silen
     value: function stopAudioPlaybackDeviceTest() {
       return this._adapter.stopAudioPlaybackDeviceTest();
     }
-  }, {
-    key: "setAudioFrameCallback",
-    value: function setAudioFrameCallback() {
-      return this._adapter.setAudioFrameCallback();
-    }
-  }, {
-    key: "stopAudioFrameCallback",
-    value: function stopAudioFrameCallback() {
-      return this._adapter.stopAudioFrameCallback();
-    }
   }, {
     key: "onAutoPlayFailed",
     value: function onAutoPlayFailed(cb) {
@@ -203,8 +193,18 @@ var AGRtcManager = (_dec = _decorator.Log.attach(), _dec2 = _decorator.Log.silen
     }
   }, {
     key: "setAudioRawDataConfig",
-    value: function setAudioRawDataConfig(config) {
-      return this._adapter.setAudioRawDataConfig(config);
+    value: function setAudioRawDataConfig(config, position) {
+      return this._adapter.setAudioRawDataConfig(config, position);
+    }
+  }, {
+    key: "addAudioRawDataObserver",
+    value: function addAudioRawDataObserver(observer, position) {
+      return this._adapter.addAudioRawDataObserver(observer, position);
+    }
+  }, {
+    key: "removeAudioRawDataObserver",
+    value: function removeAudioRawDataObserver(observer, position) {
+      return this._adapter.removeAudioRawDataObserver(observer, position);
     }
   }, {
     key: "hasScreenSharePermission",

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

@@ -132,10 +132,6 @@ export interface AGBeautyEffect {
     smoothnessLevel: number;
     sharpnessLevel: number;
 }
-export interface AGAudioRawDataConfig {
-    frameSize?: 256 | 512 | 1024 | 2048 | 4096 | 8192 | 16384;
-    sampleRate?: number;
-}
 export declare enum AGRemoteVideoStreamType {
     /**
      * 0: High-quality video stream (high-bitrate, high-resolution).

package/lib/core/services/api.d.ts

@@ -92,4 +92,8 @@ export declare class AgoraRteService extends ApiBase {
     }): Promise<any>;
     sendRoomChatMessage(message: string, roomUuid: string): Promise<any>;
     publishStreamToCdn(roomUuid: string, userUuid: string, streamUuid: string, params: PublishCdnParams): Promise<any>;
+    updateOnlineState({ userUuid, roomUuid }: {
+        roomUuid: string;
+        userUuid: string;
+    }): Promise<any>;
 }

package/lib/core/services/api.js

@@ -569,6 +569,35 @@ var AgoraRteService = (_dec = _log.Log.attach(), _dec(_class = /*#__PURE__*/func
       }
       return publishStreamToCdn;
     }()
+  }, {
+    key: "updateOnlineState",
+    value: function () {
+      var _updateOnlineState = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regeneratorRuntime().mark(function _callee16(_ref9) {
+        var userUuid, roomUuid;
+        return _regeneratorRuntime().wrap(function _callee16$(_context16) {
+          while (1) {
+            switch (_context16.prev = _context16.next) {
+              case 0:
+                userUuid = _ref9.userUuid, roomUuid = _ref9.roomUuid;
+                _context16.next = 3;
+                return this.fetch({
+                  path: "/v1/rooms/".concat(roomUuid, "/users/").concat(userUuid, "/states/1"),
+                  method: 'PUT'
+                });
+              case 3:
+                return _context16.abrupt("return", _context16.sent);
+              case 4:
+              case "end":
+                return _context16.stop();
+            }
+          }
+        }, _callee16, this);
+      }));
+      function updateOnlineState(_x34) {
+        return _updateOnlineState.apply(this, arguments);
+      }
+      return updateOnlineState;
+    }()
   }]);
   return AgoraRteService;
 }(_base.ApiBase)) || _class);

package/lib/core/utils/decorator.d.ts

@@ -0,0 +1,2 @@
+export declare function immutable(target: any, propertyKey: string, descriptor: PropertyDescriptor): PropertyDescriptor;
+export declare function deepFreeze(object: any): any;

package/lib/core/utils/decorator.js

@@ -0,0 +1,65 @@
+"use strict";
+
+require("core-js/modules/es.object.keys.js");
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.object.get-own-property-descriptor.js");
+require("core-js/modules/es.array.for-each.js");
+require("core-js/modules/web.dom-collections.for-each.js");
+require("core-js/modules/es.object.get-own-property-descriptors.js");
+require("core-js/modules/es.object.define-properties.js");
+require("core-js/modules/es.object.define-property.js");
+require("core-js/modules/es.array.slice.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.function.name.js");
+require("core-js/modules/es.array.from.js");
+require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/es.symbol.description.js");
+require("core-js/modules/es.symbol.iterator.js");
+require("core-js/modules/es.array.iterator.js");
+require("core-js/modules/web.dom-collections.iterator.js");
+require("core-js/modules/es.array.is-array.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.deepFreeze = deepFreeze;
+exports.immutable = immutable;
+require("core-js/modules/es.object.get-own-property-names.js");
+require("core-js/modules/es.object.freeze.js");
+var _typeof2 = _interopRequireDefault(require("@babel/runtime/helpers/typeof"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+function _createForOfIteratorHelper(o, allowArrayLike) { var it = typeof Symbol !== "undefined" && o[Symbol.iterator] || o["@@iterator"]; if (!it) { if (Array.isArray(o) || (it = _unsupportedIterableToArray(o)) || allowArrayLike && o && typeof o.length === "number") { if (it) o = it; var i = 0; var F = function F() {}; return { s: F, n: function n() { if (i >= o.length) return { done: true }; return { done: false, value: o[i++] }; }, e: function e(_e) { throw _e; }, 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 normalCompletion = true, didErr = false, err; return { s: function s() { it = it.call(o); }, n: function n() { var step = it.next(); normalCompletion = step.done; return step; }, e: function e(_e2) { didErr = true; err = _e2; }, f: function f() { try { if (!normalCompletion && it["return"] != null) it["return"](); } finally { if (didErr) throw err; } } }; }
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { (0, _defineProperty2["default"])(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+function immutable(target, propertyKey, descriptor) {
+  var original = descriptor.get;
+  // @ts-ignore
+  descriptor.get = function (value) {
+    var res = original.call(this, _objectSpread({}, value));
+    return deepFreeze(res);
+  };
+  return descriptor;
+}
+function deepFreeze(object) {
+  if (!object) return;
+  var propNames = Object.getOwnPropertyNames(object);
+  var _iterator = _createForOfIteratorHelper(propNames),
+    _step;
+  try {
+    for (_iterator.s(); !(_step = _iterator.n()).done;) {
+      var name = _step.value;
+      var value = object[name];
+      if (value && (0, _typeof2["default"])(value) === 'object') {
+        deepFreeze(value);
+      }
+    }
+  } catch (err) {
+    _iterator.e(err);
+  } finally {
+    _iterator.f();
+  }
+  return Object.freeze(object);
+}

package/lib/index.d.ts

@@ -15,11 +15,13 @@ export { retryAttempt } from './core/utils/utils';
 export { Log, Lodash, bound } from './core/decorator';
 export { AgoraRteVideoSourceType, AgoraRteAudioSourceType, AgoraRteMediaPublishState, AgoraRteMediaTrack, AgoraRteCameraVideoTrack, AgoraRteMicrophoneAudioTrack, AgoraRteScreenShareTrack, AgoraRteStreamMediaTrack, } from './core/media/track';
 export { AgoraMediaControlEventType, AgoraMediaControl } from './core/media/control';
+export { AgoraRteAudioRawDataPosition } from './core/media/type';
+export type { AgoraRteAudioRawDataConfig, AgoraRteAudioRawDataObserver } from './core/media/type';
 export type { AgoraFromUser } from './core/processor/channel-msg/struct';
 export { Scheduler, ActionWhenTaskFail } from './core/schedule';
 export { Duration } from './core/schedule/scheduler';
 export { AGNetworkQuality, AgoraRteMediaSourceState, AGRtcState, AGMediaEncryptionMode, AGRteTrackErrorReason, AGScreenShareType, AGRenderMode, AGLighteningLevel, AGRemoteVideoStreamType, } from './core/rtc/type';
-export type { AGNetworkStats, AGRtcDeviceInfo, AGMediaEncryptionConfig, AGScreenShareDevice, AGVideoEncoderConfigurations, AGBeautyEffect, AGAudioRawDataConfig, AGLowStreamParameter, AGSnapshotInfo, } from './core/rtc/type';
+export type { AGNetworkStats, AGRtcDeviceInfo, AGMediaEncryptionConfig, AGScreenShareDevice, AGVideoEncoderConfigurations, AGBeautyEffect, AGLowStreamParameter, AGSnapshotInfo, } from './core/rtc/type';
 export type { AGRtcConfig } from './core/rtc/adapter/index';
 export { AGEventEmitter } from './core/utils/events';
 export { AgoraRteConnectionState, AGChannelProfile, AgoraRteLogLevel } from './type';

package/lib/index.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", {
 Object.defineProperty(exports, "AGChannelProfile", {
   enumerable: true,
   get: function get() {
-    return _type2.AGChannelProfile;
+    return _type3.AGChannelProfile;
   }
 });
 Object.defineProperty(exports, "AGError", {
@@ -31,31 +31,31 @@ Object.defineProperty(exports, "AGEventEmitter", {
 Object.defineProperty(exports, "AGLighteningLevel", {
   enumerable: true,
   get: function get() {
-    return _type.AGLighteningLevel;
+    return _type2.AGLighteningLevel;
   }
 });
 Object.defineProperty(exports, "AGMediaEncryptionMode", {
   enumerable: true,
   get: function get() {
-    return _type.AGMediaEncryptionMode;
+    return _type2.AGMediaEncryptionMode;
   }
 });
 Object.defineProperty(exports, "AGNetworkQuality", {
   enumerable: true,
   get: function get() {
-    return _type.AGNetworkQuality;
+    return _type2.AGNetworkQuality;
   }
 });
 Object.defineProperty(exports, "AGRemoteVideoStreamType", {
   enumerable: true,
   get: function get() {
-    return _type.AGRemoteVideoStreamType;
+    return _type2.AGRemoteVideoStreamType;
   }
 });
 Object.defineProperty(exports, "AGRenderMode", {
   enumerable: true,
   get: function get() {
-    return _type.AGRenderMode;
+    return _type2.AGRenderMode;
   }
 });
 Object.defineProperty(exports, "AGRtcConnectionType", {
@@ -67,7 +67,7 @@ Object.defineProperty(exports, "AGRtcConnectionType", {
 Object.defineProperty(exports, "AGRtcState", {
   enumerable: true,
   get: function get() {
-    return _type.AGRtcState;
+    return _type2.AGRtcState;
   }
 });
 Object.defineProperty(exports, "AGRteErrorCode", {
@@ -79,13 +79,13 @@ Object.defineProperty(exports, "AGRteErrorCode", {
 Object.defineProperty(exports, "AGRteTrackErrorReason", {
   enumerable: true,
   get: function get() {
-    return _type.AGRteTrackErrorReason;
+    return _type2.AGRteTrackErrorReason;
   }
 });
 Object.defineProperty(exports, "AGScreenShareType", {
   enumerable: true,
   get: function get() {
-    return _type.AGScreenShareType;
+    return _type2.AGScreenShareType;
   }
 });
 Object.defineProperty(exports, "AbstractErrorCenter", {
@@ -133,13 +133,13 @@ Object.defineProperty(exports, "AgoraMediaPlayerCanvas", {
 Object.defineProperty(exports, "AgoraRCEventType", {
   enumerable: true,
   get: function get() {
-    return _type3.AgoraRCEventType;
+    return _type4.AgoraRCEventType;
   }
 });
 Object.defineProperty(exports, "AgoraRCRole", {
   enumerable: true,
   get: function get() {
-    return _type3.AgoraRCRole;
+    return _type4.AgoraRCRole;
   }
 });
 Object.defineProperty(exports, "AgoraRegion", {
@@ -166,6 +166,12 @@ Object.defineProperty(exports, "AgoraRtcVideoCanvas", {
     return _canvas.AgoraRtcVideoCanvas;
   }
 });
+Object.defineProperty(exports, "AgoraRteAudioRawDataPosition", {
+  enumerable: true,
+  get: function get() {
+    return _type.AgoraRteAudioRawDataPosition;
+  }
+});
 Object.defineProperty(exports, "AgoraRteAudioSourceType", {
   enumerable: true,
   get: function get() {
@@ -181,7 +187,7 @@ Object.defineProperty(exports, "AgoraRteCameraVideoTrack", {
 Object.defineProperty(exports, "AgoraRteConnectionState", {
   enumerable: true,
   get: function get() {
-    return _type2.AgoraRteConnectionState;
+    return _type3.AgoraRteConnectionState;
   }
 });
 Object.defineProperty(exports, "AgoraRteEngine", {
@@ -205,7 +211,7 @@ Object.defineProperty(exports, "AgoraRteEventType", {
 Object.defineProperty(exports, "AgoraRteLogLevel", {
   enumerable: true,
   get: function get() {
-    return _type2.AgoraRteLogLevel;
+    return _type3.AgoraRteLogLevel;
   }
 });
 Object.defineProperty(exports, "AgoraRteMediaPublishState", {
@@ -217,7 +223,7 @@ Object.defineProperty(exports, "AgoraRteMediaPublishState", {
 Object.defineProperty(exports, "AgoraRteMediaSourceState", {
   enumerable: true,
   get: function get() {
-    return _type.AgoraRteMediaSourceState;
+    return _type2.AgoraRteMediaSourceState;
   }
 });
 Object.defineProperty(exports, "AgoraRteMediaTrack", {
@@ -354,11 +360,12 @@ var _utils = require("./core/utils/utils");
 var _decorator = require("./core/decorator");
 var _track = require("./core/media/track");
 var _control = require("./core/media/control");
+var _type = require("./core/media/type");
 var _schedule = require("./core/schedule");
 var _scheduler = require("./core/schedule/scheduler");
-var _type = require("./core/rtc/type");
+var _type2 = require("./core/rtc/type");
 var _events = require("./core/utils/events");
-var _type2 = require("./type");
+var _type3 = require("./type");
 var _thread = require("./core/utils/thread");
-var _type3 = require("./core/rc/type");
+var _type4 = require("./core/rc/type");
 var _mediaPlayer = require("./core/media-player");

package/lib/scene/index.d.ts

@@ -44,6 +44,7 @@ export declare class AgoraRteScene extends EventEmitter {
     private _rtcManager;
     private _rtmChannel;
     private _rtcChannel;
+    private _stateSynchronizer;
     private _rtmChannelObserver;
     private _synchronizer?;
     private _timestampGap;

package/lib/scene/index.js

@@ -62,6 +62,7 @@ var _configs = require("../configs");
 var _log = require("../core/decorator/log");
 var _type = require("../type");
 var _api = require("../core/services/api");
+var _stateSync = require("./state-sync");
 var _dec, _class;
 function _regeneratorRuntime() { "use strict"; /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */ _regeneratorRuntime = function _regeneratorRuntime() { return exports; }; var exports = {}, Op = Object.prototype, hasOwn = Op.hasOwnProperty, defineProperty = Object.defineProperty || function (obj, key, desc) { obj[key] = desc.value; }, $Symbol = "function" == typeof Symbol ? Symbol : {}, iteratorSymbol = $Symbol.iterator || "@@iterator", asyncIteratorSymbol = $Symbol.asyncIterator || "@@asyncIterator", toStringTagSymbol = $Symbol.toStringTag || "@@toStringTag"; function define(obj, key, value) { return Object.defineProperty(obj, key, { value: value, enumerable: !0, configurable: !0, writable: !0 }), obj[key]; } try { define({}, ""); } catch (err) { define = function define(obj, key, value) { return obj[key] = value; }; } function wrap(innerFn, outerFn, self, tryLocsList) { var protoGenerator = outerFn && outerFn.prototype instanceof Generator ? outerFn : Generator, generator = Object.create(protoGenerator.prototype), context = new Context(tryLocsList || []); return defineProperty(generator, "_invoke", { value: makeInvokeMethod(innerFn, self, context) }), generator; } function tryCatch(fn, obj, arg) { try { return { type: "normal", arg: fn.call(obj, arg) }; } catch (err) { return { type: "throw", arg: err }; } } exports.wrap = wrap; var ContinueSentinel = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} var IteratorPrototype = {}; define(IteratorPrototype, iteratorSymbol, function () { return this; }); var getProto = Object.getPrototypeOf, NativeIteratorPrototype = getProto && getProto(getProto(values([]))); NativeIteratorPrototype && NativeIteratorPrototype !== Op && hasOwn.call(NativeIteratorPrototype, iteratorSymbol) && (IteratorPrototype = NativeIteratorPrototype); var Gp = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(IteratorPrototype); function defineIteratorMethods(prototype) { ["next", "throw", "return"].forEach(function (method) { define(prototype, method, function (arg) { return this._invoke(method, arg); }); }); } function AsyncIterator(generator, PromiseImpl) { function invoke(method, arg, resolve, reject) { var record = tryCatch(generator[method], generator, arg); if ("throw" !== record.type) { var result = record.arg, value = result.value; return value && "object" == _typeof(value) && hasOwn.call(value, "__await") ? PromiseImpl.resolve(value.__await).then(function (value) { invoke("next", value, resolve, reject); }, function (err) { invoke("throw", err, resolve, reject); }) : PromiseImpl.resolve(value).then(function (unwrapped) { result.value = unwrapped, resolve(result); }, function (error) { return invoke("throw", error, resolve, reject); }); } reject(record.arg); } var previousPromise; defineProperty(this, "_invoke", { value: function value(method, arg) { function callInvokeWithMethodAndArg() { return new PromiseImpl(function (resolve, reject) { invoke(method, arg, resolve, reject); }); } return previousPromise = previousPromise ? previousPromise.then(callInvokeWithMethodAndArg, callInvokeWithMethodAndArg) : callInvokeWithMethodAndArg(); } }); } function makeInvokeMethod(innerFn, self, context) { var state = "suspendedStart"; return function (method, arg) { if ("executing" === state) throw new Error("Generator is already running"); if ("completed" === state) { if ("throw" === method) throw arg; return doneResult(); } for (context.method = method, context.arg = arg;;) { var delegate = context.delegate; if (delegate) { var delegateResult = maybeInvokeDelegate(delegate, context); if (delegateResult) { if (delegateResult === ContinueSentinel) continue; return delegateResult; } } if ("next" === context.method) context.sent = context._sent = context.arg;else if ("throw" === context.method) { if ("suspendedStart" === state) throw state = "completed", context.arg; context.dispatchException(context.arg); } else "return" === context.method && context.abrupt("return", context.arg); state = "executing"; var record = tryCatch(innerFn, self, context); if ("normal" === record.type) { if (state = context.done ? "completed" : "suspendedYield", record.arg === ContinueSentinel) continue; return { value: record.arg, done: context.done }; } "throw" === record.type && (state = "completed", context.method = "throw", context.arg = record.arg); } }; } function maybeInvokeDelegate(delegate, context) { var methodName = context.method, method = delegate.iterator[methodName]; if (undefined === method) return context.delegate = null, "throw" === methodName && delegate.iterator["return"] && (context.method = "return", context.arg = undefined, maybeInvokeDelegate(delegate, context), "throw" === context.method) || "return" !== methodName && (context.method = "throw", context.arg = new TypeError("The iterator does not provide a '" + methodName + "' method")), ContinueSentinel; var record = tryCatch(method, delegate.iterator, context.arg); if ("throw" === record.type) return context.method = "throw", context.arg = record.arg, context.delegate = null, ContinueSentinel; var info = record.arg; return info ? info.done ? (context[delegate.resultName] = info.value, context.next = delegate.nextLoc, "return" !== context.method && (context.method = "next", context.arg = undefined), context.delegate = null, ContinueSentinel) : info : (context.method = "throw", context.arg = new TypeError("iterator result is not an object"), context.delegate = null, ContinueSentinel); } function pushTryEntry(locs) { var entry = { tryLoc: locs[0] }; 1 in locs && (entry.catchLoc = locs[1]), 2 in locs && (entry.finallyLoc = locs[2], entry.afterLoc = locs[3]), this.tryEntries.push(entry); } function resetTryEntry(entry) { var record = entry.completion || {}; record.type = "normal", delete record.arg, entry.completion = record; } function Context(tryLocsList) { this.tryEntries = [{ tryLoc: "root" }], tryLocsList.forEach(pushTryEntry, this), this.reset(!0); } function values(iterable) { if (iterable) { var iteratorMethod = iterable[iteratorSymbol]; if (iteratorMethod) return iteratorMethod.call(iterable); if ("function" == typeof iterable.next) return iterable; if (!isNaN(iterable.length)) { var i = -1, next = function next() { for (; ++i < iterable.length;) { if (hasOwn.call(iterable, i)) return next.value = iterable[i], next.done = !1, next; } return next.value = undefined, next.done = !0, next; }; return next.next = next; } } return { next: doneResult }; } function doneResult() { return { value: undefined, done: !0 }; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, defineProperty(Gp, "constructor", { value: GeneratorFunctionPrototype, configurable: !0 }), defineProperty(GeneratorFunctionPrototype, "constructor", { value: GeneratorFunction, configurable: !0 }), GeneratorFunction.displayName = define(GeneratorFunctionPrototype, toStringTagSymbol, "GeneratorFunction"), exports.isGeneratorFunction = function (genFun) { var ctor = "function" == typeof genFun && genFun.constructor; return !!ctor && (ctor === GeneratorFunction || "GeneratorFunction" === (ctor.displayName || ctor.name)); }, exports.mark = function (genFun) { return Object.setPrototypeOf ? Object.setPrototypeOf(genFun, GeneratorFunctionPrototype) : (genFun.__proto__ = GeneratorFunctionPrototype, define(genFun, toStringTagSymbol, "GeneratorFunction")), genFun.prototype = Object.create(Gp), genFun; }, exports.awrap = function (arg) { return { __await: arg }; }, defineIteratorMethods(AsyncIterator.prototype), define(AsyncIterator.prototype, asyncIteratorSymbol, function () { return this; }), exports.AsyncIterator = AsyncIterator, exports.async = function (innerFn, outerFn, self, tryLocsList, PromiseImpl) { void 0 === PromiseImpl && (PromiseImpl = Promise); var iter = new AsyncIterator(wrap(innerFn, outerFn, self, tryLocsList), PromiseImpl); return exports.isGeneratorFunction(outerFn) ? iter : iter.next().then(function (result) { return result.done ? result.value : iter.next(); }); }, defineIteratorMethods(Gp), define(Gp, toStringTagSymbol, "Generator"), define(Gp, iteratorSymbol, function () { return this; }), define(Gp, "toString", function () { return "[object Generator]"; }), exports.keys = function (val) { var object = Object(val), keys = []; for (var key in object) { keys.push(key); } return keys.reverse(), function next() { for (; keys.length;) { var key = keys.pop(); if (key in object) return next.value = key, next.done = !1, next; } return next.done = !0, next; }; }, exports.values = values, Context.prototype = { constructor: Context, reset: function reset(skipTempReset) { if (this.prev = 0, this.next = 0, this.sent = this._sent = undefined, this.done = !1, this.delegate = null, this.method = "next", this.arg = undefined, this.tryEntries.forEach(resetTryEntry), !skipTempReset) for (var name in this) { "t" === name.charAt(0) && hasOwn.call(this, name) && !isNaN(+name.slice(1)) && (this[name] = undefined); } }, stop: function stop() { this.done = !0; var rootRecord = this.tryEntries[0].completion; if ("throw" === rootRecord.type) throw rootRecord.arg; return this.rval; }, dispatchException: function dispatchException(exception) { if (this.done) throw exception; var context = this; function handle(loc, caught) { return record.type = "throw", record.arg = exception, context.next = loc, caught && (context.method = "next", context.arg = undefined), !!caught; } for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i], record = entry.completion; if ("root" === entry.tryLoc) return handle("end"); if (entry.tryLoc <= this.prev) { var hasCatch = hasOwn.call(entry, "catchLoc"), hasFinally = hasOwn.call(entry, "finallyLoc"); if (hasCatch && hasFinally) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } else if (hasCatch) { if (this.prev < entry.catchLoc) return handle(entry.catchLoc, !0); } else { if (!hasFinally) throw new Error("try statement without catch or finally"); if (this.prev < entry.finallyLoc) return handle(entry.finallyLoc); } } } }, abrupt: function abrupt(type, arg) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc <= this.prev && hasOwn.call(entry, "finallyLoc") && this.prev < entry.finallyLoc) { var finallyEntry = entry; break; } } finallyEntry && ("break" === type || "continue" === type) && finallyEntry.tryLoc <= arg && arg <= finallyEntry.finallyLoc && (finallyEntry = null); var record = finallyEntry ? finallyEntry.completion : {}; return record.type = type, record.arg = arg, finallyEntry ? (this.method = "next", this.next = finallyEntry.finallyLoc, ContinueSentinel) : this.complete(record); }, complete: function complete(record, afterLoc) { if ("throw" === record.type) throw record.arg; return "break" === record.type || "continue" === record.type ? this.next = record.arg : "return" === record.type ? (this.rval = this.arg = record.arg, this.method = "return", this.next = "end") : "normal" === record.type && afterLoc && (this.next = afterLoc), ContinueSentinel; }, finish: function finish(finallyLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.finallyLoc === finallyLoc) return this.complete(entry.completion, entry.afterLoc), resetTryEntry(entry), ContinueSentinel; } }, "catch": function _catch(tryLoc) { for (var i = this.tryEntries.length - 1; i >= 0; --i) { var entry = this.tryEntries[i]; if (entry.tryLoc === tryLoc) { var record = entry.completion; if ("throw" === record.type) { var thrown = record.arg; resetTryEntry(entry); } return thrown; } } throw new Error("illegal catch attempt"); }, delegateYield: function delegateYield(iterable, resultName, nextLoc) { return this.delegate = { iterator: values(iterable), resultName: resultName, nextLoc: nextLoc }, "next" === this.method && (this.arg = undefined), ContinueSentinel; } }, exports; }
 function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
@@ -89,6 +90,7 @@ var AgoraRteScene = (_dec = _log.Log.attach({
     _this._rtcManager = void 0;
     _this._rtmChannel = void 0;
     _this._rtcChannel = void 0;
+    _this._stateSynchronizer = void 0;
     _this._rtmChannelObserver = void 0;
     _this._synchronizer = void 0;
     _this._timestampGap = 0;
@@ -101,6 +103,7 @@ var AgoraRteScene = (_dec = _log.Log.attach({
     _this._rtmChannelObserver = options.rtmChannelObserver;
     _this._rtcChannel = options.rtcChannel;
     _this._apiService = new _api.AgoraRteService();
+    _this._stateSynchronizer = new _stateSync.AGOnlineStateSynchronizer(_this._apiService, sceneId);
     _this._apiService.pathPrefix = options.engine.apiServicePathPrefix;
     _this.dataStore = new _data.AgoraRteSyncDataStore();
 
@@ -173,7 +176,7 @@ var AgoraRteScene = (_dec = _log.Log.attach({
     key: "joinScene",
     value: function () {
       var _joinScene = (0, _asyncToGenerator2["default"])( /*#__PURE__*/_regeneratorRuntime().mark(function _callee(options) {
-        var mediaControl, _yield$this$getApiSer, user, room, streamUuid, userName, userUuid, role, rtcToken, _user$streams, streams, userProperties, agStreams, stream, snapshotData;
+        var mediaControl, _yield$this$getApiSer, user, room, sysConfig, streamUuid, userName, userUuid, role, rtcToken, _user$streams, streams, userProperties, agStreams, stream, snapshotData;
         return _regeneratorRuntime().wrap(function _callee$(_context) {
           while (1) {
             switch (_context.prev = _context.next) {
@@ -205,6 +208,11 @@ var AgoraRteScene = (_dec = _log.Log.attach({
                 _yield$this$getApiSer = _context.sent;
                 user = _yield$this$getApiSer.user;
                 room = _yield$this$getApiSer.room;
+                sysConfig = _yield$this$getApiSer.sysConfig;
+                if (user.subscribe === 1) {
+                  this._stateSynchronizer.setSyncDelay(sysConfig.onlineStateEnsureDelay || 5000);
+                }
+                this._stateSynchronizer.addConnectionStateListeners(this);
                 this.createTs = room.roomState.createTime;
 
                 // Object.assign(AgoraRteEngineConfig.shared.service.headers, { token: user.userToken });
@@ -214,9 +222,9 @@ var AgoraRteScene = (_dec = _log.Log.attach({
                 });
 
                 // 2. rtm join
-                _context.next = 15;
+                _context.next = 18;
                 return this._rtmManager.join(this._rtmChannel, this._rtmChannelObserver, this.sceneId);
-              case 15:
+              case 18:
                 // 3. initialize object models
                 streamUuid = user.streamUuid, userName = user.userName, userUuid = user.userUuid, role = user.role, rtcToken = user.rtcToken, _user$streams = user.streams, streams = _user$streams === void 0 ? [] : _user$streams, userProperties = user.userProperties;
                 agStreams = streams.map(function (s) {
@@ -266,27 +274,28 @@ var AgoraRteScene = (_dec = _log.Log.attach({
                   rtm: this._rtmManager
                 });
                 this._addEventListeners(this._synchronizer.handle);
+                this._stateSynchronizer.addMessageEventListeners(this._synchronizer.handle);
 
                 // 4. sync/get snapshot
-                _context.next = 24;
+                _context.next = 28;
                 return this.getApiService().syncSnapShot(this.sceneId);
-              case 24:
+              case 28:
                 snapshotData = _context.sent;
                 this._synchronizer.syncSnapshot(_struct.AgoraRteSyncSnapshotData.fromData(snapshotData));
-                _context.next = 32;
+                _context.next = 36;
                 break;
-              case 28:
-                _context.prev = 28;
+              case 32:
+                _context.prev = 32;
                 _context.t0 = _context["catch"](3);
                 // cleanup
                 this._cleanup();
                 return _context.abrupt("return", _error.RteErrorCenter.shared.handleThrowableError(_error.AGRteErrorCode.RTE_ERR_JOIN_SCENE_FAILED, _context.t0));
-              case 32:
+              case 36:
               case "end":
                 return _context.stop();
             }
           }
-        }, _callee, this, [[3, 28]]);
+        }, _callee, this, [[3, 32]]);
       }));
       function joinScene(_x) {
         return _joinScene.apply(this, arguments);
@@ -302,16 +311,17 @@ var AgoraRteScene = (_dec = _log.Log.attach({
           while (1) {
             switch (_context2.prev = _context2.next) {
               case 0:
-                _context2.next = 2;
+                this._stateSynchronizer.stop();
+                _context2.next = 3;
                 return (0, _awaitToJs["default"])(this._rtmManager.leave(this.sceneId));
-              case 2:
+              case 3:
                 _yield$to = _context2.sent;
                 _yield$to2 = (0, _slicedToArray2["default"])(_yield$to, 1);
                 err = _yield$to2[0];
                 err && _error.RteErrorCenter.shared.handleNonThrowableError(_error.AGRteErrorCode.RTE_ERR_LEAVE_SCENE_FAIL, err);
                 this._rtmManager.off(_handler.AgoraRteEventType.RtmConnectionStateChanged, this._handleRtmStateChange);
                 this._cleanup();
-              case 8:
+              case 9:
               case "end":
                 return _context2.stop();
             }

package/lib/scene/state-sync.d.ts

@@ -0,0 +1,21 @@
+import { AgoraRteScene } from '.';
+import { Logger } from '../core/logger';
+import { AgoraRteChannelMessageHandle } from '../core/processor/channel-msg/handler';
+import { AgoraRteService } from '../core/services/api';
+export declare class AGOnlineStateSynchronizer {
+    logger: Logger;
+    private _task?;
+    private _api;
+    private _sceneId;
+    private _delay;
+    private _connState;
+    private _isOnline;
+    constructor(api: AgoraRteService, sceneId: string);
+    setSyncDelay(delay: number): void;
+    addMessageEventListeners(handle: AgoraRteChannelMessageHandle): void;
+    addConnectionStateListeners(scene: AgoraRteScene): void;
+    start(): void;
+    stop(): void;
+    get isStateNotInSync(): boolean;
+    private _notifyServerStateOnline;
+}