UNPKG

fcr-core

Version:

Core APIs for building online scenes

440 lines (437 loc) 24.6 kB
"use strict"; require("core-js/modules/es.symbol.description.js"); require("core-js/modules/es.error.cause.js"); require("core-js/modules/es.array.push.js"); require("core-js/modules/esnext.function.metadata.js"); require("core-js/modules/esnext.iterator.filter.js"); require("core-js/modules/esnext.iterator.for-each.js"); require("core-js/modules/esnext.map.delete-all.js"); require("core-js/modules/esnext.map.emplace.js"); require("core-js/modules/esnext.map.every.js"); require("core-js/modules/esnext.map.filter.js"); require("core-js/modules/esnext.map.find.js"); require("core-js/modules/esnext.map.find-key.js"); require("core-js/modules/esnext.map.includes.js"); require("core-js/modules/esnext.map.key-of.js"); require("core-js/modules/esnext.map.map-keys.js"); require("core-js/modules/esnext.map.map-values.js"); require("core-js/modules/esnext.map.merge.js"); require("core-js/modules/esnext.map.reduce.js"); require("core-js/modules/esnext.map.some.js"); require("core-js/modules/esnext.map.update.js"); require("core-js/modules/esnext.symbol.metadata.js"); require("core-js/modules/esnext.weak-map.delete-all.js"); require("core-js/modules/esnext.weak-map.emplace.js"); var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault"); Object.defineProperty(exports, "__esModule", { value: true }); exports.FcrWhiteboardControlImpl = void 0; require("core-js/modules/esnext.iterator.constructor.js"); require("core-js/modules/esnext.iterator.map.js"); require("core-js/modules/web.dom-collections.iterator.js"); var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty")); var _appSlide = _interopRequireDefault(require("@netless/app-slide")); var _whiteWebSdk = require("white-web-sdk"); var netlessVideoPlugin = _interopRequireWildcard(require("@netless/video-js-plugin")); var _windowManager = require("@netless/window-manager"); var _appliancePlugin = require("@netless/appliance-plugin"); var _utils = require("./utils"); var _observable = require("agora-foundation/lib/utilities/observable"); var _boardWindow = require("./board-window"); var _type = require("../whiteboard-control/type"); var _decorator = require("agora-foundation/lib/decorator"); var _user = require("../../utilities/user"); var _2 = require("../.."); var _logger = require("../../utilities/logger"); var _imports = require("../../imports"); var _error = require("../../utilities/error"); var _imports2 = require("agora-rte-sdk/lib/imports"); var _type2 = require("../sharing-control/type"); var _FcrWhiteboardControlImpl; let _initProto; function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); } function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; } function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; } 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 (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 (e) { return m(e), w.value; } : (o < 4 && (k = i(w, "get", m)), 3 !== o && (F = i(w, "set", m))) : (k = function (e) { return e[n]; }, (o < 2 || 4 === o) && (F = function (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 (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)]; } }; } function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; } function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); } function _setFunctionName(e, t, n) { "symbol" == typeof t && (t = (t = t.description) ? "[" + t + "]" : ""); try { Object.defineProperty(e, "name", { configurable: !0, value: n ? n + " " + t : t }); } catch (e) {} return e; } function _checkInRHS(e) { if (Object(e) !== e) throw TypeError("right-hand side of 'in' should be an object, got " + (null !== e ? typeof e : "null")); return e; } /** * @internal */ class FcrWhiteboardControlImpl { constructor(_scene, _api, _sharedCache, hasOperationPrivilege) { (0, _defineProperty2.default)(this, "logger", (_initProto(this), (0, _logger.createLogger)({ prefix: 'FcrWhiteboardControlImpl' }))); (0, _defineProperty2.default)(this, "_client", {}); (0, _defineProperty2.default)(this, "_joined", false); (0, _defineProperty2.default)(this, "_connectState", _2.FcrConnectionState.DISCONNECTED); (0, _defineProperty2.default)(this, "_observable", new _observable.AgoraObservable()); (0, _defineProperty2.default)(this, "_options", { debug: false }); (0, _defineProperty2.default)(this, "_hasOperationPrivilege", false); this._scene = _scene; this._api = _api; this._sharedCache = _sharedCache; this._hasOperationPrivilege = hasOperationPrivilege; this._roomCache = this._sharedCache.getRoomCache(this._scene.sceneId); this._addLogObserver(); _scene.addObserver({ onScenePropertiesUpdated: (_, event) => { var _event$cause; const operatorUser = (0, _user.convertRteUserToFcrUser)(event.operatorUser, this._roomCache); if (((_event$cause = event.cause) === null || _event$cause === void 0 ? void 0 : _event$cause.cmd) === 10) { var _ref, _event$cause$data$wid2; const { state, extra: { backgroundColor: bgColor } } = (_ref = _scene.getScenePropertiesByKeyPath('widgets.netlessBoard')) !== null && _ref !== void 0 ? _ref : { state: 0, extra: { backgroundColor: '#fff' } }; if (state === 1) { this._observable.notifyObservers('onActive', _scene.getScenePropertiesByKeyPath('widgets.netlessBoard').ownerUserUuid, operatorUser); } if (state === 0) { var _event$cause$data$wid; this._observable.notifyObservers('onInactive', (_event$cause$data$wid = event.cause.data.widgetCause) === null || _event$cause$data$wid === void 0 || (_event$cause$data$wid = _event$cause$data$wid.data) === null || _event$cause$data$wid === void 0 ? void 0 : _event$cause$data$wid.reason, operatorUser); } if (((_event$cause$data$wid2 = event.cause.data.widgetCause) === null || _event$cause$data$wid2 === void 0 ? void 0 : _event$cause$data$wid2.cmd) === 100101) { this._observable.notifyObservers('onBackgroundColorUpdated', bgColor, operatorUser); } } } }); _windowManager.WindowManager.register({ kind: 'Slide', src: _appSlide.default }); } async active() { return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this._scene.sceneId, _type2.FcrSharePermissionState.ON), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'active failed'); } async inactive() { return (0, _error.handleRequestError)(() => this._api.toggleWhiteboardActivityState(this._scene.sceneId, _type2.FcrSharePermissionState.OFF), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'inactive failed'); } async open() { let params = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {}; this._whiteboardPrivateParameters = params; // 白板权限禁用状态下,主持人和联席主持人仍然可以发起共享,所以,不能根据是否禁用状态直接拒绝 this._joined = true; if (this._connectState !== _2.FcrConnectionState.DISCONNECTED) { return this._boardView; } const boardView = await this._connect(); return boardView; } async close() { this._joined = false; await this._clean(); } async setBackgroundColor(backgroundColor) { await this._api.setBackgroundColor({ roomId: this._scene.sceneId, backgroundColor }); } getActivity() { return this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard').state === 1; } getOwnerId() { return this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard.ownerUserUuid'); } getBackgroundColor() { return this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard.extra.backgroundColor'); } getConnectionState() { return this._connectState; } getMainWindow() { return this._boardView; } addObserver(observer) { this._observable.addObserver(observer); } removeObserver(observer) { this._observable.removeObserver(observer); } getBoardActiveInfo() { const { state, ownerUserUuid: ownerUserId } = this._scene.getScenePropertiesByKeyPath('widgets.netlessBoard') || { isActive: false, ownerUserUuid: null }; if (state === _type.FcrBoardPropertiesState.ACTIVE) { return { isActive: true, ownerUserId }; } else { return { isActive: false, ownerUserId: null }; } } hasOperationPrivilege() { return this._hasOperationPrivilege; } setOperationPrivilege(hasPrivilege) { if (hasPrivilege !== this._hasOperationPrivilege) { this._hasOperationPrivilege = hasPrivilege; this._setBoardWritable(hasPrivilege); } } async _setBoardWritable(granted) { if (this._room) { const room = this._room; if (granted) { this.logger.info('set whiteboard writable => true, start'); await room.setWritable(true); this.logger.info('set whiteboard writable => true, success'); room.disableDeviceInputs = false; room.disableSerialization = false; const mainWindow = this._boardView; if (mainWindow) { // @ts-ignore mainWindow._observable.notifyObservers('onWritable', true); } } else { room.disableDeviceInputs = true; room.disableSerialization = true; this.logger.info('set whiteboard writable => false, start'); await room.setWritable(false); this.logger.info('set whiteboard writable => false, success'); const mainWindow = this._boardView; if (mainWindow) { // @ts-ignore mainWindow._observable.notifyObservers('onWritable', false); } } } } _createPlugins() { const plugins = (0, _whiteWebSdk.createPlugins)({ [netlessVideoPlugin.PluginId]: netlessVideoPlugin.videoJsPlugin() }); plugins.setPluginContext(netlessVideoPlugin.PluginId, { enable: true, verbose: true }); return plugins; } async _getToken(roomId, userId) { return await (0, _error.handleRequestError)(() => this._api.getWhiteboardToken({ roomId, userId }), _error.FcrErrorModuleCode.ROOM_WHITEBOARD, 'get whiteboard token failed'); } _handleRoomStateUpdated(state) { const { memberState } = state; if (memberState) { const { strokeColor, strokeWidth, currentApplianceName, textSize, shapeType } = memberState; const localState = {}; const [tool, shape] = (0, _utils.convertToFcrBoardToolShape)(currentApplianceName, shapeType); localState.tool = tool; localState.shape = shape; if (typeof strokeColor !== 'undefined') { const [r, g, b] = strokeColor; localState.strokeColor = { r, g, b }; } if (typeof strokeWidth !== 'undefined') { localState.strokeWidth = strokeWidth; } if (typeof textSize !== 'undefined') { localState.textSize = textSize; } } } _updateConnnectionState(state) { if (this._connectState !== state) { if (state === _2.FcrConnectionState.CONNECTED) { // 首次加入白板,白板回调connected时,boardView还为创建 if (this._boardView) { this._connectState = state; this._observable.notifyObservers('onConnectionStateUpdated', state); } } else if (state === _2.FcrConnectionState.DISCONNECTED) { if (this._joined) { this.logger.info('whiteboard is disconnected, about to reconnect..'); (0, _imports2.sleep)(5000).then(() => { if (this._joined) { this._connect(); } }); } else { this._connectState = state; this._observable.notifyObservers('onConnectionStateUpdated', state); } } else { this._connectState = state; this._observable.notifyObservers('onConnectionStateUpdated', state); } } } _handleConnectionStateUpdated(phase) { if (phase === _whiteWebSdk.RoomPhase.Connecting) { this._updateConnnectionState(_2.FcrConnectionState.CONNECTING); } else if (phase === _whiteWebSdk.RoomPhase.Connected) { this._updateConnnectionState(_2.FcrConnectionState.CONNECTED); } else if (phase === _whiteWebSdk.RoomPhase.Reconnecting) { this._updateConnnectionState(_2.FcrConnectionState.RECONNECTING); } else if (phase === _whiteWebSdk.RoomPhase.Disconnected) { this._updateConnnectionState(_2.FcrConnectionState.DISCONNECTED); } else if (phase === _whiteWebSdk.RoomPhase.Disconnecting) { // this._updateConnnectionState(FcrConnectionState.DISCONNECTING); } } async _connect() { try { var _this$_scene$getUser, _this$_whiteboardPriv, _this$_whiteboardPriv2, _this$_whiteboardPriv3, _this$_whiteboardPriv4; this._updateConnnectionState(_2.FcrConnectionState.CONNECTING); const roomId = this._scene.sceneId; const userId = this._scene.localUser.getLocalUserId(); const cursorName = (_this$_scene$getUser = this._scene.getUser(userId)) === null || _this$_scene$getUser === void 0 ? void 0 : _this$_scene$getUser.userName; const syncMode = (_this$_whiteboardPriv = (_this$_whiteboardPriv2 = this._whiteboardPrivateParameters) === null || _this$_whiteboardPriv2 === void 0 ? void 0 : _this$_whiteboardPriv2.syncMode) !== null && _this$_whiteboardPriv !== void 0 ? _this$_whiteboardPriv : false; const { data } = await this._getToken(roomId, userId); const { boardAppId, boardId, boardRegion, boardToken } = data || {}; const plugins = this._createPlugins(); this._client = new _whiteWebSdk.WhiteWebSdk(_objectSpread({ appIdentifier: boardAppId, useMobXState: true, pptParams: { useServerWrap: true }, deviceType: _whiteWebSdk.DeviceType.Surface, plugins, preloadDynamicPPT: true, loggerOptions: { reportQualityMode: _whiteWebSdk.LoggerReportMode.AlwaysReport, reportDebugLogMode: _whiteWebSdk.LoggerReportMode.AlwaysReport, reportLevelMask: this._options.debug ? 'debug' : 'info', printLevelMask: this._options.debug ? 'debug' : 'info' } }, this._whiteboardPrivateParameters)); const hasPermission = this._hasOperationPrivilege; const joinParams = { region: boardRegion, uuid: boardId, uid: userId, roomToken: boardToken, isWritable: hasPermission, disableDeviceInputs: false, disableCameraTransform: true, disableNewPencil: false, disableEraseImage: false, wrappedComponents: [], invisiblePlugins: [_windowManager.WindowManager, _appliancePlugin.ApplianceMultiPlugin], useMultiViews: true, disableMagixEventDispatchLimit: true, userPayload: { userId, avatar: '', cursorName, disappearCursor: true }, floatBar: (_this$_whiteboardPriv3 = (_this$_whiteboardPriv4 = this._whiteboardPrivateParameters) === null || _this$_whiteboardPriv4 === void 0 ? void 0 : _this$_whiteboardPriv4.floatBar) !== null && _this$_whiteboardPriv3 !== void 0 ? _this$_whiteboardPriv3 : { colors: _utils.textColors.map(color => (0, _utils.hexColorToWhiteboardColor)(color)) } }; const room = await this._client.joinRoom(joinParams, { onPhaseChanged: this._handleConnectionStateUpdated, onRoomStateChanged: this._handleRoomStateUpdated }); this._room = room; if (hasPermission) { room.setViewMode(_whiteWebSdk.ViewMode.Broadcaster); } this.logger.info("set whiteboard sync mode: ".concat(syncMode)); room.syncMode = syncMode; const mountOptions = {}; const privateParams = this._whiteboardPrivateParameters; if (!this._boardView) { const mainWindow = this._createBoardMainWindow(room); this._boardView = mainWindow; // @ts-ignore await this._boardView._mount(mountOptions, privateParams); } else { this.logger.info('reusing main window for whiteboard'); //@ts-ignore this._boardView._setRoom(room, mountOptions, privateParams); } if (this._joined) { this._updateConnnectionState(_2.FcrConnectionState.CONNECTED); } else { // 如果没有加入白板,则需要清理掉之前的状态 this.logger.info('whiteboard is not joined, cleaning up the state'); this._clean(); } } catch (e) { this.logger.error('error when connecting to whiteboard', e); this._updateConnnectionState(_2.FcrConnectionState.DISCONNECTED); } return this._boardView; } _createBoardMainWindow(room) { this.logger.info('creating main window for whiteboard'); const mainWindow = new _boardWindow.FcrBoardMainWindowImpl(room); return mainWindow; } async _clean() { if (this._boardView) { // @ts-ignore this._boardView.destroy(); this._boardView = undefined; } if (this._room) { try { // Workaround for whiteboard sdk issue: frameGenerator being null when disconnecting will cause error and trigger 'did-finish-loading' event in electron. // Set writable to false to prevent this error from throwing. // this.logger.info('change writable to false before disconnecting'); // await this._room.setWritable(false); await this._room.disconnect(); } catch (e) { this.logger.error('error when disconnecting whiteboard room', e); } finally { this._room.callbacks.off('onPhaseChanged', this._handleConnectionStateUpdated); this._room.callbacks.off('onRoomStateChanged', this._handleRoomStateUpdated); } this._room = undefined; } } _addLogObserver() { this.addObserver((0, _logger.generateLogObserver)(this.logger, ['onActive', 'onInactive', 'onBackgroundColorUpdated', 'onConnectionStateUpdated'])); } } exports.FcrWhiteboardControlImpl = FcrWhiteboardControlImpl; _FcrWhiteboardControlImpl = FcrWhiteboardControlImpl; [_initProto] = _applyDecs(_FcrWhiteboardControlImpl, [[[_decorator.bound, _imports.trace], 2, "active"], [[_decorator.bound, _imports.trace], 2, "inactive"], [[_decorator.bound, _imports.trace], 2, "open"], [[_decorator.bound, _imports.trace], 2, "close"], [[_decorator.bound, _imports.trace], 2, "setBackgroundColor"], [[_decorator.bound, _imports.trace], 2, "getActivity"], [[_decorator.bound, _imports.trace], 2, "getOwnerId"], [[_decorator.bound, _imports.trace], 2, "getBackgroundColor"], [[_decorator.bound, _imports.trace], 2, "getConnectionState"], [[_decorator.bound, _imports.trace], 2, "getMainWindow"], [[_decorator.bound, _imports.trace], 2, "addObserver"], [[_decorator.bound, _imports.trace], 2, "removeObserver"], [[_decorator.bound, _imports.trace], 2, "getBoardActiveInfo"], [[_decorator.bound, _imports.trace], 2, "hasOperationPrivilege"], [[_decorator.bound, _imports.trace], 2, "setOperationPrivilege"], [_imports.trace, 2, "_setBoardWritable"], [_decorator.bound, 2, "_getToken"], [_decorator.bound, 2, "_handleRoomStateUpdated"], [_decorator.bound, 2, "_updateConnnectionState"], [_decorator.bound, 2, "_handleConnectionStateUpdated"], [_imports.trace, 2, "_connect"], [_imports.trace, 2, "_clean"]], []).e;