fcr-ui-scene 3.4.2 → 3.4.4

package/lib/schema.js

@@ -0,0 +1,77 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "fcrRenderViewSchema", {
+  enumerable: true,
+  get: function get() {
+    return _schema.fcrRenderViewSchema;
+  }
+});
+exports.fcrUserRoleSchema = exports.fcrUISceneFailureCallbackSchema = exports.fcrUISceneConfigSchema = exports.fcrUISceneCallbackSchema = exports.fcrUIResourceSchema = void 0;
+require("core-js/modules/es.error.cause.js");
+require("core-js/modules/es.error.to-string.js");
+var _fcrCore = require("fcr-core");
+var _schema = require("fcr-core/lib/schema");
+var fcrUserRoleSchema = exports.fcrUserRoleSchema = _schema.z.nativeEnum(_fcrCore.FcrUserRole);
+var fcrUIResourceSchema = exports.fcrUIResourceSchema = _schema.z.object({
+  virtualBackgroundImages: _schema.stringArraySchema.optional(),
+  virtualBackgroundVideos: _schema.stringArraySchema.optional(),
+  soundEffectAudios: _schema.stringArraySchema.optional()
+});
+var fcrUISceneConfigSchema = exports.fcrUISceneConfigSchema = _schema.z.object({
+  /**
+   * The token for authentication.
+   */
+  roomToken: _schema.stringSchema,
+  /**
+   * The ID of the room.
+   */
+  roomId: _schema.stringSchema,
+  /**
+   * The name of the user.
+   */
+  userName: _schema.stringSchema,
+  /**
+   * The role of the user.
+   */
+  userRole: fcrUserRoleSchema,
+  /**
+   * The language of the user interface. Supported languages are: 'en', 'zh'.
+   */
+  language: _schema.stringSchema,
+  /**
+   * Link to share the room.
+   */
+  inviteLink: _schema.stringSchema,
+  /**
+   * Flexible properties of the user.
+   */
+  userProperties: _schema.stringKeyUnknownValueSchema.optional(),
+  /**
+   * UI Resources such as virtual background images and videos.
+   */
+  resource: fcrUIResourceSchema.optional(),
+  /**
+   * The password for the room.
+   */
+  password: _schema.stringSchema.optional()
+});
+var fcrErrorSchema = _schema.z.object({
+  code: _schema.z.string(),
+  message: _schema.z.string(),
+  origin: _schema.z.union([_schema.z["instanceof"](Error), _schema.z.undefined()]).optional()
+});
+
+// Zod Schema 定义
+var fcrUISceneCallbackSchema = exports.fcrUISceneCallbackSchema = _schema.z["function"]().args(_schema.z.string()) // 定义参数类型
+.returns(_schema.z["void"]()) // 定义返回值类型
+.describe('A callback function that takes a roomId and returns void');
+// Zod Schema 定义
+var fcrUISceneFailureCallbackSchema = exports.fcrUISceneFailureCallbackSchema = _schema.z["function"]().args(_schema.z.string(),
+// roomId: string
+fcrErrorSchema // error: FcrError
+).returns(_schema.z["void"]()) // 返回 void
+.describe('A callback function for handling scene failure events');

package/lib/shared-data-source/member-data.d.ts

@@ -0,0 +1,126 @@
+import { FcrUIMemberDataImpl } from '../modules/participant/member-list-data-source';
+import { FcrStreamControl, FcrUserRole } from 'fcr-core';
+import { FcrUserControl } from 'fcr-core/lib/room-control/user-control/type';
+import { FcrLanguage } from 'fcr-core/lib/room-control/interpreter-control/types';
+import { FcrWhiteboardControl } from 'fcr-core/lib/room-control/whiteboard-control/types';
+import { FcrUserInfo } from 'fcr-core/lib/type';
+export interface FcrUIMemberSharedDataSource {
+    /**
+     * 整个房间的人数。
+     * @returns 来自onAllUserCountUpdated 的回调 。
+     */
+    get totalUserCount(): number;
+    /**
+     * 获取本地用户的数据。
+     * @returns 本地用户的数据，类型为 FcrUIMemberDataImpl。
+     */
+    get localUserMemberData(): FcrUIMemberDataImpl;
+    /**
+     * 获取本地用户的数据。
+     * @returns 本地用户的数据，类型为 FcrUserInfo。
+     */
+    get localUser(): FcrUserInfo;
+    /**
+     * 获取本地用户的角色。
+     * @returns 本地用户的角色，类型为 FcrUserRole。
+     */
+    get localUserRole(): FcrUserRole;
+    /**
+     * 获取本地用户的角色名称。
+     * @returns 本地用户的角色名称，类型为 string。
+     */
+    get localUserRoleString(): string;
+    /**
+     * 检查本地用户是否处于 PSTN（公共交换电话网络）模式。
+     * @returns 如果本地用户处于 PSTN 模式则返回 true，否则返回 false。
+     */
+    get hasOwnPstnStream(): boolean;
+    /**
+     * 检查本地用户是否是主持人。
+     * @returns 如果本地用户是主持人或联系主持人 模式则返回 true，否则返回 false。
+     */
+    get isLocalUserHost(): boolean;
+    /**
+     * 获取远程用户的列表。
+     * @returns 远程用户的列表数据，类型为 FcrUIMemberDataImpl。
+     */
+    get remoteMembers(): FcrUIMemberDataImpl[];
+    /**
+     * 获取远程用户的列表。
+     * @returns 远程用户的列表数据，类型为 FcrUserInfo。
+     */
+    get remoteMembersUserInfosList(): FcrUserInfo[];
+    /**
+     * 获取主房间参与者列表的纯数组形式。
+     * @returns 主房间参与者列表，元素类型为 FcrUIMemberDataImpl。
+     */
+    get memberList(): FcrUIMemberDataImpl[];
+    /**
+     * 获取主房间参与者FcrUserInfo的纯数组形式。
+     * @returns 主房间参与者列表，元素类型为 FcrUserInfo。
+     */
+    get memberUserInfoList(): FcrUserInfo[];
+    /**
+     * 获取音频音量映射。
+     * 键为用户 ID，值为对应的音频音量。
+     * @returns 音频音量映射，类型为 Map<string, number>。
+     */
+    get audioVolumeMap(): Map<string, number>;
+    /**
+     * 根据白板状态更新主房间参与者列表。
+     * 此方法用于同步参与者列表与白板状态。
+     */
+    updateMemberListWithBoardState(): void;
+    /**
+     * 释放数据源占用的资源。
+     * 当不再需要使用该数据源时，调用此方法进行资源清理。
+     */
+    release(): void;
+}
+export declare class FcrUIMemberSharedDataSourceImpl implements FcrUIMemberSharedDataSource {
+    private _mainRoomUserControl;
+    private _streamControl;
+    private _whiteBoardControl?;
+    private _dataSource;
+    protected logger: import("agora-foundation/lib/logger").Logger;
+    private _disposers;
+    private _userObserver;
+    private _streamsObserver;
+    private accessor serverPushTotalUserCount;
+    private accessor _audioVolumeMap;
+    private accessor _isLocalUserInPstn;
+    private accessor _interpreterInputLanguageList;
+    constructor(_mainRoomUserControl: FcrUserControl, _streamControl: FcrStreamControl, _whiteBoardControl?: FcrWhiteboardControl | undefined);
+    get totalUserCount(): number;
+    get hasOwnPstnStream(): boolean;
+    get interpreterInputLanguageList(): {
+        userId: string;
+        language: FcrLanguage;
+    }[];
+    get audioVolumeMap(): Map<string, number>;
+    setIsLocalUserInPstn(): void;
+    get localUserMemberData(): FcrUIMemberDataImpl;
+    get localUser(): FcrUserInfo;
+    private _forceAddLocalUserWithControl;
+    private _handleAllUserCountUpdated;
+    private _getLocalUserInPureList;
+    private get localUserId();
+    get localUserRole(): FcrUserRole;
+    get localUserRoleString(): "participant" | "host" | "cohost" | "audience" | "observer" | "robot";
+    get isLocalUserHost(): boolean;
+    get remoteMembers(): FcrUIMemberDataImpl[];
+    get remoteMembersUserInfosList(): FcrUserInfo[];
+    private _initUserList;
+    get memberList(): FcrUIMemberDataImpl[];
+    get memberUserInfoList(): FcrUserInfo[];
+    private _handleUserInfoUpdated;
+    private _syncParticipants;
+    private _onAudioVolumeUpdated;
+    private _handleRemoteUserJoined;
+    private _handleRemoteUserLeft;
+    private _handleStreamsAdded;
+    private _handleStreamsUpdated;
+    private _handleStreamsRemoved;
+    updateMemberListWithBoardState(): void;
+    release(): void;
+}