fcr-ui-scene 3.4.1 → 3.4.3

package/lib/providers/local-storage-provider.d.ts

@@ -1,5 +1,14 @@
 export interface FcrUILocalStorageProvider {
+    /**
+     * 写入本地存储
+     * @param key
+     * @param value
+     */
     write(key: string, value: any): number;
+    /**
+     * 从本地存储读取
+     * @param key
+     */
     read(key: string): string | null;
 }
 export declare class FcrUILocalStorageProviderImpl implements FcrUILocalStorageProvider {

package/lib/providers/message-provider.d.ts

@@ -0,0 +1,69 @@
+import { FcrUIToastParams, FcrUINotificationParams, FcrUINotificationContentType } from '../type';
+import { FcrUIAction } from '../utilities/constant';
+interface FcrUIEventObserver {
+    onEvent?(action: FcrUIAction, payload?: unknown): void;
+}
+/**
+ * FcrUIMessageProvider 接口定义了一系列用于管理和操作 UI 消息的方法。
+ * 这些方法涵盖了显示不同类型消息（如 Toast 提示、通知等）、关闭通知以及管理消息事件观察者的功能。
+ */
+export interface FcrUIMessageProvider {
+    /**
+     * 显示一个 Toast 提示消息。
+     * Toast 通常是短暂显示的轻量级消息，用于向用户传达简单的信息。
+     *
+     * @param params - 显示 Toast 提示所需的参数，类型为 FcrUIToastParams，
+     * 该参数包含了 Toast 的内容、显示时长等相关配置信息。
+     */
+    showToast(params: FcrUIToastParams): void;
+    /**
+     * 显示一个通知消息。
+     * 通知通常用于向用户展示更重要、更详细的信息，可能会在界面上停留一段时间。
+     *
+     * @param params - 显示通知所需的参数，类型为 FcrUINotificationParams，
+     * 该参数包含了通知的标题、内容、图标等相关配置信息。
+     */
+    showNotification(params: FcrUINotificationParams): void;
+    /**
+     * 关闭指定类型的通知消息。
+     *
+     * @param key - 要关闭的通知的内容类型标识，类型为 FcrUINotificationContentType，
+     * 通过该标识可以准确地关闭特定类型的通知。
+     */
+    closeNotification(key: FcrUINotificationContentType): void;
+    /**
+     * 在聊天界面显示一个 Toast 提示消息。
+     * 与普通的 showToast 方法不同，此方法专门用于在聊天场景中显示提示。
+     *
+     * @param params - 显示聊天 Toast 提示所需的参数，类型为 FcrUIToastParams，
+     * 同样包含了 Toast 的内容、显示时长等相关配置信息。
+     */
+    showChatToast(params: FcrUIToastParams): void;
+    /**
+     * 添加一个消息事件观察者。
+     * 观察者可以监听 UI 消息的各种事件，如消息显示、关闭等。
+     *
+     * @param observer - 要添加的观察者对象，类型为 FcrUIEventObserver，
+     * 该对象应该实现了相应的事件处理方法。
+     */
+    addObserver(observer: FcrUIEventObserver): void;
+    /**
+     * 移除一个消息事件观察者。
+     * 移除后，该观察者将不再接收 UI 消息的事件通知。
+     *
+     * @param observer - 要移除的观察者对象，类型为 FcrUIEventObserver。
+     */
+    removeObserver(observer: FcrUIEventObserver): void;
+}
+export declare class FcrUIMessageProviderImpl implements FcrUIMessageProvider {
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _observable;
+    sendEvent(action: FcrUIAction, payload?: unknown): void;
+    showToast(params: FcrUIToastParams): void;
+    showNotification(params: FcrUINotificationParams): void;
+    closeNotification(key: FcrUINotificationContentType): void;
+    showChatToast(params: FcrUIToastParams): void;
+    addObserver(observer: FcrUIEventObserver): void;
+    removeObserver(observer: FcrUIEventObserver): void;
+}
+export {};

package/lib/providers/message-provider.js

@@ -0,0 +1,96 @@
+"use strict";
+
+require("core-js/modules/es.symbol.js");
+require("core-js/modules/es.array.filter.js");
+require("core-js/modules/es.array.for-each.js");
+require("core-js/modules/es.array.push.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/es.object.to-string.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/web.dom-collections.for-each.js");
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.FcrUIMessageProviderImpl = void 0;
+require("core-js/modules/es.array.concat.js");
+require("core-js/modules/es.date.now.js");
+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 _base = require("../base");
+var _constant = require("../utilities/constant");
+var _logger = require("agora-foundation/lib/logger");
+var _imports = require("fcr-core/lib/imports");
+var _chat = require("../modules/chat");
+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; }
+/**
+ * FcrUIMessageProvider 接口定义了一系列用于管理和操作 UI 消息的方法。
+ * 这些方法涵盖了显示不同类型消息（如 Toast 提示、通知等）、关闭通知以及管理消息事件观察者的功能。
+ */
+var FcrUIMessageProviderImpl = exports.FcrUIMessageProviderImpl = /*#__PURE__*/function () {
+  function FcrUIMessageProviderImpl() {
+    (0, _classCallCheck2["default"])(this, FcrUIMessageProviderImpl);
+    (0, _defineProperty2["default"])(this, "logger", (0, _logger.getLogger)());
+    (0, _defineProperty2["default"])(this, "_observable", new _imports.AgoraObservable());
+  }
+  return (0, _createClass2["default"])(FcrUIMessageProviderImpl, [{
+    key: "sendEvent",
+    value: function sendEvent(action, payload) {
+      var start = Date.now();
+      try {
+        this._observable.notifyObservers('onEvent', action, payload);
+      } finally {
+        var end = Date.now();
+        var time = end - start;
+        if (time >= 10) {
+          this.logger.warn("[FcrUIEventStore] sendEvent ".concat(_constant.FcrUIAction[action], ", payload: ").concat(payload, ", handlers took: ").concat(end - start, "ms"));
+        }
+      }
+    }
+  }, {
+    key: "showToast",
+    value: function showToast(params) {
+      this.sendEvent(_constant.FcrUIAction.OPEN_DIALOG, {
+        dialogKey: _constant.FcrUIDialogKey.SHOW_TOAST,
+        dialogId: "".concat(_constant.FcrUIDialogKey.SHOW_TOAST, "_").concat(Date.now()),
+        params: params
+      });
+    }
+  }, {
+    key: "showNotification",
+    value: function showNotification(params) {
+      this.sendEvent(_constant.FcrUIAction.SHOW_NOTIFICATION, params);
+    }
+  }, {
+    key: "closeNotification",
+    value: function closeNotification(key) {
+      this.sendEvent(_constant.FcrUIAction.COLSE_NOTIFICATION, key);
+    }
+  }, {
+    key: "showChatToast",
+    value: function showChatToast(params) {
+      this.sendEvent(_constant.FcrUIAction.SHOW_TOAST, _objectSpread(_objectSpread({}, params), {}, {
+        customRootClass: _chat.CHAT_WRAPPER_CLASS
+      }));
+    }
+  }, {
+    key: "addObserver",
+    value: function addObserver(observer) {
+      this._observable.addObserver(observer);
+    }
+  }, {
+    key: "removeObserver",
+    value: function removeObserver(observer) {
+      this._observable.removeObserver(observer);
+    }
+  }]);
+}();
+(0, _base.registerDependency)('messageProvider');

package/lib/providers/monitor-provider.d.ts

@@ -1,6 +1,11 @@
 import { FcrPerformanceInfo } from 'fcr-core/lib/type';
 import { FcrMonitorControl } from 'fcr-core';
 export interface FcrUIMonitorObserver {
+    /**
+     * 性能信息更新，包括 CPU、内存统计信息
+     * @param status
+     * @returns
+     */
     onPerformanceInfoUpdated?: (status: FcrPerformanceInfo) => void;
 }
 export interface FcrUIMonitorProvider {

package/lib/providers/phone-audio-provider.d.ts

@@ -0,0 +1,131 @@
+import { FcrBaseRoomControl } from 'fcr-core';
+import { FcrUIDeviceProvider } from './device-provider';
+import { FcrPhoneConnectorSession, FcrRoomConnectorPhoneInfo, FcrRoomConnectorSessionReason, FcrRoomConnectorSessionState } from 'fcr-core/lib/room-control/room-connector-control/type';
+import { FcrUIConnectType } from '../type';
+import { ConnectorRegion } from '../modules/connection-gateway/enums';
+import { FcrUIMessageProvider } from './message-provider';
+export interface FcrUIPhoneAudioConnectorProvider {
+    /**
+     * @getter 接听状态
+     * @returns boolean
+     */
+    get accepted(): boolean;
+    /**
+     * @getter 电话拨入的房间信息
+     * @returns FcrRoomConnectorPhoneInfo[]
+     */
+    get connectInfo(): FcrRoomConnectorPhoneInfo;
+    /**
+     * @getter 当前电话的呼叫状态
+     * @returns FcrRoomConnectorSessionState
+     */
+    get phoneCallState(): FcrRoomConnectorSessionState;
+    /**
+     * @getter 当前电话呼叫中断原因
+     * @returns FcrRoomConnectorSessionReason
+     */
+    get phoneCallReason(): FcrRoomConnectorSessionReason;
+    /**
+     * @getter 当前电话连接 session
+     * @returns FcrPhoneConnectorSession | null
+     */
+    get connectSession(): FcrPhoneConnectorSession | null;
+    /**
+     * @getter 是否正在呼叫
+     * @returns boolean
+     */
+    get calling(): boolean;
+    /**
+     * @getter 是否为呼出电话
+     * @returns boolean
+     */
+    get outgoingCall(): boolean;
+    /**
+     * @getter 是否已挂断电话
+     * @returns boolean
+     */
+    get isHangup(): boolean;
+    /**
+     * @getter 是否有 PSTN 流
+     * @returns boolean
+     */
+    get hasPstnStream(): boolean;
+    /**
+     * @getter 是否有自己的 PSTN 流
+     * @returns boolean
+     */
+    get hasOwnPstnStream(): boolean;
+    /**
+     * @getter 是否需要合并流
+     * @returns boolean
+     */
+    get hasNeedMergedStream(): boolean;
+    /**
+     * @getter 当前连接类型
+     * @returns FcrUIConnectType
+     */
+    get connectType(): FcrUIConnectType;
+    /**
+     * @method 获取电话接入房间信息
+     */
+    getConnectorInfo(): void;
+    /**
+     * @method 设置电话接入房间的信息
+     * @param region - 连接区域
+     */
+    setConnectionInfo(region: ConnectorRegion): void;
+    /**
+     * @method 开始拨号呼叫
+     * @param phoneNumber - 电话号码
+     */
+    startCall(phoneNumber: string): void;
+    /**
+     * @method 挂断电话呼叫
+     */
+    stopCall(): void;
+    /**
+     * @method 释放资源
+     */
+    release(): void;
+}
+export declare class FcrUIPhoneAudioConnectorProviderImpl implements FcrUIPhoneAudioConnectorProvider {
+    private _roomControl;
+    private _userControl;
+    private _disposers;
+    private _messageProvider;
+    private _deviceProvider;
+    private _streamControl;
+    private _roomOberver;
+    private _streamObserver;
+    private _failureTimer;
+    private _sessionId;
+    accessor accepted: boolean;
+    accessor connectionPhoneInfos: FcrRoomConnectorPhoneInfo[];
+    accessor connectInfo: FcrRoomConnectorPhoneInfo;
+    accessor phoneCallState: FcrRoomConnectorSessionState;
+    accessor phoneCallReason: FcrRoomConnectorSessionReason;
+    accessor connectSession: FcrPhoneConnectorSession | null;
+    accessor calling: boolean;
+    accessor outgoingCall: boolean;
+    accessor isHangup: boolean;
+    accessor hasPstnStream: boolean;
+    accessor hasOwnPstnStream: boolean;
+    accessor hasNeedMergedStream: boolean;
+    get connectType(): FcrUIConnectType;
+    constructor({ roomControl, messageProvider, deviceProvider, }: {
+        roomControl: FcrBaseRoomControl;
+        messageProvider: FcrUIMessageProvider;
+        deviceProvider: FcrUIDeviceProvider;
+    });
+    getConnectorInfo(): Promise<void>;
+    setConnectionInfo(region?: ConnectorRegion): void;
+    startCall(phoneNumber: string): Promise<void>;
+    stopCall(): Promise<void>;
+    release(): void;
+    private _setResetTimer;
+    private _phoneCallUpdated;
+    private _phoneCallReason;
+    private _setStreamState;
+    private _handleStreamsAddedOrUpdated;
+    private _handleStreamsRemoved;
+}