fcr-ui-scene 3.4.1 → 3.4.2

package/lib/shared-data-source/setting.js

@@ -0,0 +1,153 @@
+"use strict";
+
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.symbol.description.js");
+require("core-js/modules/es.symbol.to-primitive.js");
+require("core-js/modules/es.error.cause.js");
+require("core-js/modules/es.error.to-string.js");
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.array.for-each.js");
+require("core-js/modules/es.array.is-array.js");
+require("core-js/modules/es.array.push.js");
+require("core-js/modules/es.date.to-primitive.js");
+require("core-js/modules/es.function.bind.js");
+require("core-js/modules/es.function.name.js");
+require("core-js/modules/es.map.js");
+require("core-js/modules/es.number.constructor.js");
+require("core-js/modules/es.object.create.js");
+require("core-js/modules/es.object.define-properties.js");
+require("core-js/modules/es.object.define-property.js");
+require("core-js/modules/es.object.get-own-property-descriptor.js");
+require("core-js/modules/es.object.get-own-property-descriptors.js");
+require("core-js/modules/es.object.keys.js");
+require("core-js/modules/esnext.async-iterator.filter.js");
+require("core-js/modules/esnext.async-iterator.for-each.js");
+require("core-js/modules/esnext.function.metadata.js");
+require("core-js/modules/esnext.iterator.constructor.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/web.dom-collections.for-each.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+var _typeof = require("@babel/runtime/helpers/typeof");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrUISharedSettingDataSourceImpl = void 0;
+require("core-js/modules/es.array.iterator.js");
+require("core-js/modules/es.object.to-string.js");
+require("core-js/modules/es.string.iterator.js");
+require("core-js/modules/es.weak-map.js");
+require("core-js/modules/esnext.weak-map.delete-all.js");
+require("core-js/modules/esnext.weak-map.emplace.js");
+require("core-js/modules/web.dom-collections.iterator.js");
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _imports = require("agora-rte-sdk/lib/imports");
+var _fcrCore = require("fcr-core");
+var _parameters = require("../utilities/parameters");
+var _mobx = require("mobx");
+var _base = require("../base");
+var _FcrUISharedSettingDataSourceImpl;
+var _initProto, _init__setting, _preHandleSettingDecs, _setSettingDecs, _ref;
+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 _classPrivateFieldInitSpec(e, t, a) { _checkPrivateRedeclaration(e, t), t.set(e, a); }
+function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
+function _classPrivateFieldSet(s, a, r) { return s.set(_assertClassBrand(s, a), r), r; }
+function _classPrivateFieldGet(s, a) { return s.get(_assertClassBrand(s, a)); }
+function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); }
+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)]; } }; }
+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; }
+/**
+ * FcrUISharedSettingDataSource 接口定义了用于获取和修改共享 UI 设置数据的方法。
+ * 通过该接口，可以方便地对自定义设置进行读取和更新操作，适用于管理和维护 UI 相关的共享配置。
+ */
+var _A = /*#__PURE__*/new WeakMap();
+_ref = (_preHandleSettingDecs = [_mobx.action, _mobx.action.bound], _setSettingDecs = [_mobx.action, _mobx.action.bound], "_creatorConfig");
+var FcrUISharedSettingDataSourceImpl = exports.FcrUISharedSettingDataSourceImpl = /*#__PURE__*/function () {
+  function FcrUISharedSettingDataSourceImpl(creatorConfig) {
+    (0, _classCallCheck2["default"])(this, FcrUISharedSettingDataSourceImpl);
+    (0, _defineProperty2["default"])(this, _ref, void _initProto(this));
+    _classPrivateFieldInitSpec(this, _A, _init__setting(this, {
+      shouldDisplayPreviewDialog: true,
+      shouldHideNonVideoParticipants: false,
+      displayedMaxAttendees: 16,
+      autoAdjustmentSpeakerVolume: true,
+      autoAdjustmentMicrophoneVolume: (0, _imports.isElectron)(),
+      noiseReduce: _fcrCore.FcrAiDenoiseLevel.AUTO,
+      recordingPath: '',
+      videoHD: true,
+      videoLowLight: false,
+      hardwareForReception: false,
+      videoNoise: false,
+      audioHiFi: false,
+      audioEchoCancellation: false,
+      audioStereo: false,
+      audioVoiceChanger: false,
+      spotlightEnabled: true
+    }));
+    (0, _defineProperty2["default"])(this, "_useDefaultAudioEchoCancellation", true);
+    this._creatorConfig = creatorConfig;
+    var defaultVideoGallerySize = (0, _parameters.getDefaultVideoGallerySize)(this._creatorConfig.parameters);
+    if (defaultVideoGallerySize) {
+      defaultVideoGallerySize = Math.min(Math.max(defaultVideoGallerySize, 16), 25);
+    }
+    this._setting.displayedMaxAttendees = defaultVideoGallerySize || 0;
+  }
+  return (0, _createClass2["default"])(FcrUISharedSettingDataSourceImpl, [{
+    key: "_setting",
+    get: function get() {
+      return _classPrivateFieldGet(_A, this);
+    },
+    set: function set(v) {
+      _classPrivateFieldSet(_A, this, v);
+    }
+  }, {
+    key: "setting",
+    get: function get() {
+      return this._setting;
+    }
+  }, {
+    key: "_preHandleSetting",
+    value: function _preHandleSetting(newSetting) {
+      if (newSetting !== null && newSetting !== void 0 && newSetting.audioVoiceChanger && !this._setting.audioVoiceChanger && this._useDefaultAudioEchoCancellation) {
+        this._useDefaultAudioEchoCancellation = false;
+        return _objectSpread(_objectSpread({}, newSetting), {}, {
+          audioEchoCancellation: true
+        });
+      }
+      return newSetting;
+    }
+  }, {
+    key: "setSetting",
+    value: function setSetting(assignedSetting) {
+      var newSetting = this._preHandleSetting(assignedSetting);
+      this._setting = newSetting;
+    }
+  }]);
+}();
+_FcrUISharedSettingDataSourceImpl = FcrUISharedSettingDataSourceImpl;
+var _applyDecs$e = (0, _slicedToArray2["default"])(_applyDecs(_FcrUISharedSettingDataSourceImpl, [[_mobx.observable, 1, "_setting"], [_preHandleSettingDecs, 18, "_preHandleSetting"], [_setSettingDecs, 18, "setSetting"]], []).e, 2);
+_init__setting = _applyDecs$e[0];
+_initProto = _applyDecs$e[1];
+(0, _base.registerDependency)('sharedSettingDataSource');

package/lib/shared-data-source/speaker-spotlight.d.ts

@@ -0,0 +1,5 @@
+export interface FcrUISharedSpeakerSpotlightDataSource {
+}
+export declare class FcrUISharedSpeakerSpotlightDataSourceImpl implements FcrUISharedSpeakerSpotlightDataSource {
+    constructor();
+}

package/lib/shared-data-source/speaker-spotlight.js

@@ -0,0 +1,15 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrUISharedSpeakerSpotlightDataSourceImpl = void 0;
+var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
+var _base = require("../base");
+var FcrUISharedSpeakerSpotlightDataSourceImpl = exports.FcrUISharedSpeakerSpotlightDataSourceImpl = /*#__PURE__*/(0, _createClass2["default"])(function FcrUISharedSpeakerSpotlightDataSourceImpl() {
+  (0, _classCallCheck2["default"])(this, FcrUISharedSpeakerSpotlightDataSourceImpl);
+});
+(0, _base.registerDependency)('sharedSpeakerSpotlightDataSource');

package/lib/shared-data-source/video-window.d.ts

@@ -0,0 +1,161 @@
+import { FcrUIVideoWindowData, FcrUIVideoWindowFoldSortingPriority, FcrUIVideoWindowLayoutType, FcrUIVideoWindowMainSortingPriority, FcrUIWindowType } from './../type';
+import { FcrStreamInfo, FcrUserInfo, FcrUserRole } from 'fcr-core/lib/type';
+import { FcrRoomConnectorType, FcrVideoSourceType } from 'fcr-core';
+import { FcrUISharedSettingDataSource } from './setting';
+import { FcrUIEventProvider } from '../providers/event-provider';
+type FcrStreamUIData = Omit<FcrStreamInfo, 'owner'> & {
+    owner: FcrUserInfo;
+};
+export interface FcrUIVideoWindowDataSource {
+    addPin(streamId: string): boolean;
+    removePin(streamId: string): void;
+    addPinToast(streamId: string): void;
+    removePinToast(streamId: string, toastText: string): void;
+    layoutType: FcrUIVideoWindowLayoutType;
+    manualLayout: FcrUIVideoWindowLayoutType | undefined;
+    mainList: FcrUIVideoWindowDataImpl[];
+    foldList: FcrUIVideoWindowDataImpl[];
+    toggleMainStream(streamId: string): boolean;
+    setLayout(layout: FcrUIVideoWindowLayoutType, manual?: boolean): void;
+    update(param: FcrStreamInfo | FcrUserInfo): void;
+    add(stream: FcrStreamInfo, isMySelf: boolean): void;
+    delete(stream: FcrStreamInfo): void;
+    addBoard(userInfo: FcrUserInfo, isMySelf: boolean, canEdit?: boolean): void;
+    updateBoard(canEdit: boolean): void;
+    removeBoard(): void;
+    addObserver(observer: Partial<FcrUIVideoWindowDataSourceObserver>): void;
+    removeObserver(observer: FcrUIVideoWindowDataSourceObserver): void;
+    setSpotlightEnabled(enabled: boolean): void;
+    setSpeakerSpotlight(streamId: string): void;
+    spotlightStreamId: string;
+    layoutMainList: FcrUIVideoWindowDataImpl[];
+    shouldHideNonVideoParticipants: boolean;
+}
+export declare class FcrUIVideoWindowDataImpl implements FcrUIVideoWindowData {
+    private _placement;
+    private _isMySelf;
+    private _boardUserInfo?;
+    private _layoutType;
+    private accessor _videoStream;
+    private accessor _audioStream;
+    private accessor _spotlightEnabled;
+    private accessor _isSpeakerSpotlight;
+    private accessor _boardCanEdit;
+    needToSort: boolean;
+    type: FcrUIWindowType;
+    accessor isPin: boolean;
+    accessor hasScreenSharing: boolean;
+    get isSpeakerSpotlight(): boolean;
+    get windowId(): string;
+    get videoStreamId(): string | undefined;
+    get audioStreamId(): string | undefined;
+    get audioStreamConnectorType(): FcrRoomConnectorType;
+    get videoStreamConnectorType(): FcrRoomConnectorType;
+    get hasMicrophoneAudioStream(): boolean;
+    get phoneMicEnabled(): boolean;
+    get hasVideoStream(): boolean;
+    get hasLoopbackAudioStream(): boolean;
+    get userId(): string;
+    get userName(): string;
+    get ownerRoleType(): FcrUserRole;
+    get videoSourceType(): FcrVideoSourceType.CAMERA | FcrVideoSourceType.SCREEN;
+    get isMySelf(): boolean;
+    get sortingPriority(): FcrUIVideoWindowMainSortingPriority | FcrUIVideoWindowFoldSortingPriority;
+    constructor(type: FcrUIWindowType, { videoStream, audioStream, boardUserInfo, }: {
+        videoStream?: FcrStreamUIData;
+        audioStream?: FcrStreamUIData;
+        boardUserInfo?: FcrUserInfo;
+    }, _placement: 'main-list' | 'fold-list', _isMySelf: boolean, layoutType: FcrUIVideoWindowLayoutType | undefined, spotlightEnabled: boolean, canEdit?: boolean);
+    setLayoutType(layoutType: FcrUIVideoWindowLayoutType): void;
+    setVideoStream(videoStream: FcrStreamUIData | undefined): void;
+    setVideoStreamOwnerInfo(userInfo: FcrUserInfo): void;
+    setAudioStream(audioStream: FcrStreamUIData | undefined): void;
+    setAudioStreamOwnerInfo(userInfo: FcrUserInfo): void;
+    setPin(pin: boolean): void;
+    setSpotlightEnabled(enabled: boolean): void;
+    setSpeakerSpotlight(speakerSpotlight: boolean): void;
+    setHasScreenSharing(screenSharing: boolean): void;
+    setBoardCanEdit(canEdit: boolean): void;
+}
+export interface FcrUIVideoWindowDataSourceObserver {
+    onLayoutUpdated?: (layout: FcrUIVideoWindowLayoutType) => void;
+    onMainListAdded?: (index: number) => void;
+    onMainListUpdated?: (index: number) => void;
+    onMainListRemoved?: (index: number) => void;
+    onFoldListAdded?: (index: number) => void;
+    onFoldListUpdated?: (index: number) => void;
+    onFoldListRemoved?: (index: number) => void;
+    onSpotlightAdded?: (streamId: string) => void;
+    onSpotlightRemoved?: (streamId: string) => void;
+}
+export declare class FcrUIVideoWindowDataSourceImpl implements FcrUIVideoWindowDataSource {
+    private _sharedSettingDataSource;
+    private _eventProvider;
+    private _observer;
+    private _spotlightPool;
+    accessor spotlightEnabled: boolean;
+    accessor layoutType: FcrUIVideoWindowLayoutType;
+    accessor manualLayout: FcrUIVideoWindowLayoutType | undefined;
+    accessor pinLimitedCount: number;
+    accessor mainListLimitedCount: number;
+    accessor foldListLimitedCount: number;
+    accessor mainList: FcrUIVideoWindowDataImpl[];
+    accessor foldList: FcrUIVideoWindowDataImpl[];
+    accessor spotlightStreamId: string;
+    constructor(_sharedSettingDataSource: FcrUISharedSettingDataSource, _eventProvider: FcrUIEventProvider);
+    get shouldHideNonVideoParticipants(): boolean;
+    get layoutMainList(): FcrUIVideoWindowDataImpl[];
+    setSpotlightEnabled(enabled: boolean): void;
+    setLayout(layout: FcrUIVideoWindowLayoutType, manual?: boolean): void;
+    onSpotlightRemoved(streamId: string): void;
+    resetList(): void;
+    addBoard(userInfo: FcrUserInfo, isMySelf: boolean, canEdit?: boolean): void;
+    updateBoard(canEdit: boolean): void;
+    removeBoard(): void;
+    private _mergePstnStreamOrInsertNewData;
+    add(stream: FcrStreamInfo, isMySelf: boolean): void;
+    update(stream: FcrStreamInfo): void;
+    update(user: FcrUserInfo): void;
+    delete(stream: FcrStreamInfo): void;
+    addPin(streamId: string): boolean;
+    addPinToast(streamId: string): void;
+    removePinToast(streamId: string, toastText?: string): void;
+    private _updateSpeakerSpotlightPosition;
+    removePin(streamId: string): true | undefined;
+    setSpeakerSpotlight(streamId: string): void;
+    toggleMainStream(windowId: string): boolean;
+    clearSpeakerSpotlight(): void;
+    addObserver(observer: FcrUIVideoWindowDataSourceObserver): void;
+    removeObserver(observer: FcrUIVideoWindowDataSourceObserver): void;
+    private copyStreamInfo;
+    private _syncHasScreenSharing;
+    private _insertByPriority;
+    private _insertBeginningByPriority;
+    private _insertEndByPriority;
+    private _findInsertBeginningIndex;
+    private _findInsertEndIndex;
+    private _findCurrentSpeakerSpotlight;
+    private _findItemIndexWithWindowId;
+    private _findItemIndexWithUserId;
+    private _findItemIndexWithAudioStreamId;
+    private _insertBoard;
+    private _insertNewData;
+}
+export declare class FcrUISpeakerSpotlightPool {
+    streams: Map<string, number>;
+    limitCount: number;
+    duration: number;
+    private _timer;
+    private _observer;
+    constructor();
+    add(streamId: string): boolean;
+    private _scan;
+    clear(): void;
+    addObserver(observer: {
+        onRemoved: (streamId: string) => void;
+    }): void;
+    removeObserver(observer: {
+        onRemoved: (streamId: string) => void;
+    }): void;
+}
+export {};