fcr-ui-scene 1.0.0

package/lib/fcr-ui-scene/src/type.d.ts

@@ -0,0 +1,347 @@
+import { ConversionOption, EduRegion, EduRoleTypeEnum, EduRoomTypeEnum, EduRtcConfig } from 'agora-edu-core';
+import { AGMediaOptions, AgoraLatencyLevel, AGVideoEncoderConfiguration } from 'agora-rte-sdk';
+import { FcrMultiThemeMode } from 'agora-common-libs';
+import { FcrUISceneWidget } from 'agora-common-libs';
+import { IBaseProcessor, IExtension } from 'agora-rte-extension';
+import { CloudDriveResourceConvertProgress } from './uistores/cloud/struct';
+export declare type BoardWindowAnimationOptions = {
+    minFPS?: number;
+    maxFPS?: number;
+    resolution?: number;
+    autoResolution?: boolean;
+    autoFPS?: boolean;
+    maxResolutionLevel?: number;
+    forceCanvas?: boolean;
+};
+/**
+ * 启动参数
+ */
+/** @en
+ * Options to launch SDK
+ */
+export declare type LaunchOptions = {
+    /**
+     * App ID
+     */
+    /** @en
+     * App ID
+     */
+    appId: string;
+    /**
+     * 教育服务区域
+     */
+    /** @en
+     * Edu service region
+     */
+    region: EduRegion;
+    /**
+     * 进入教室的令牌
+     */
+    /** @en
+     * API Token used to join the room
+     */
+    token: string;
+    /**
+     * 界面语言
+     */
+    /** @en
+     * UI language
+     */
+    language: Language;
+    /**
+     * 用户唯一标识
+     */
+    /** @en
+     * User identifier
+     */
+    userUuid: string;
+    /**
+     * 用户昵称
+     */
+    /** @en
+     * User nickname
+     */
+    userName: string;
+    /**
+     * 用户角色
+     */
+    /** @en
+     * User role
+     */
+    roleType: EduRoleTypeEnum;
+    /**
+     * 房间唯一标识
+     */
+    /** @en
+     * Room identifier
+     */
+    roomUuid: string;
+    /**
+     * 房间名称
+     */
+    /** @en
+     * Room name
+     */
+    roomName: string;
+    /**
+     * 房间类型
+     */
+    /** @en
+     * Room type
+     */
+    roomType: EduRoomTypeEnum;
+    /**
+     * 开始时间
+     */
+    /** @en
+     * Start timestamp of the room
+     */
+    startTime?: number;
+    /**
+     * 房间时长
+     */
+    /** @en
+     * Time duration of the room
+     */
+    duration: number;
+    /**
+     * 设备检测是否启用
+     */
+    /** @en
+     * Wether device pretest is enabled
+     */
+    devicePretest: boolean;
+    /**
+     * 公共课件列表
+     */
+    /** @en
+     * Public courseware list listing in the cloud drive
+     */
+    coursewareList?: CoursewareList;
+    /**
+     * 用户自定义属性
+     */
+    /** @en
+     * User flexible properties
+     */
+    userFlexProperties?: {
+        [key: string]: unknown;
+    };
+    /**
+     * RTC 延迟等级
+     */
+    /** @en
+     * RTC latency level
+     */
+    latencyLevel?: AgoraLatencyLevel;
+    /**
+     * 录制页面地址
+     */
+    /** @en
+     * Recording page URL
+     */
+    recordUrl?: string;
+    /**
+     * 录制重试间隔
+     */
+    /** @en
+     * Time duration to wait before retrying when recording is failed to start
+     */
+    recordRetryTimeout?: number;
+    /**
+     * UI 主题
+     */
+    /** @en
+     * UI Theme
+     */
+    uiMode?: FcrMultiThemeMode;
+    /**
+     * 分享链接
+     */
+    /** @en
+     * Room share link
+     */
+    shareUrl?: string;
+    /**
+     * 虚拟背景图片
+     */
+    /** @en
+     * Virtual background image assets
+     */
+    virtualBackgroundImages?: string[];
+    /**
+     * 虚拟背景视频
+     */
+    /** @en
+     * Virtual background video assets
+     */
+    virtualBackgroundVideos?: string[];
+    /**
+     * 声网 WebRTC SDK 扩展插件包路径前缀
+     */
+    /** @en
+     * URL prefix of extension binary assets of Agora WebRTC SDK
+     */
+    webrtcExtensionBaseUrl?: string;
+    /**
+     * 音视频编解码配置
+     */
+    /** @en
+     * Configurations for video and audio codecs
+     */
+    mediaOptions?: LaunchMediaOptions;
+    /**
+     * 使用插件
+     */
+    /** @en
+     * Widgets to use with SDK
+     */
+    widgets?: Record<string, typeof FcrUISceneWidget>;
+    /**
+     * 白板录制选项
+     */
+    /** @en
+     * BoardRecordOptions
+     */
+    recordOptions?: BoardWindowAnimationOptions;
+};
+/**
+ * 支持的语言
+ */
+/** @en
+ * Supported languages
+ */
+export declare type Language = 'en' | 'zh';
+/**
+ * 课件页信息
+ */
+/** @en
+ * Page info of slides
+ */
+export declare type CoursewarePageInfo = {
+    /**
+     * 预览图
+     */
+    /** @en
+     * URL of the preview image of the page showing at nav bar of a slide window
+     */
+    preview?: string;
+    /**
+     * 图片资源链接
+     */
+    /** @en
+     * URL of the page image
+     */
+    src: string;
+    /**
+     * 图片资源宽度
+     */
+    /** @en
+     * Width of the page image
+     */
+    width: number;
+    /**
+     * 图片资源高度
+     */
+    /** @en
+     * Height of the page image
+     */
+    height: number;
+};
+/**
+ * 课件信息
+ */
+/** @en
+ * Courseware slide info
+ */
+export declare type CoursewareItem = {
+    /**
+     *
+     */
+    /**
+     *
+     */
+    resourceName: string;
+    resourceUuid: string;
+    ext: string;
+    url?: string;
+    size: number;
+    updateTime: number;
+    taskUuid?: string;
+    taskProgress?: CloudDriveResourceConvertProgress;
+    conversion?: ConversionOption;
+    initOpen?: boolean;
+};
+/**
+ * 公共课件列表
+ */
+/** @en
+ *
+ */
+export declare type CoursewareList = CoursewareItem[];
+/**
+ * 设备采集编码配置
+ */
+/** @en
+ *
+ */
+export declare type ConvertMediaOptionsConfig = EduRtcConfig & {
+    defaultLowStreamCameraEncoderConfigurations?: AGVideoEncoderConfiguration;
+};
+/**
+ * 音视频编解码配置
+ */
+/** @en
+ *
+ */
+export declare type LaunchMediaOptions = AGMediaOptions & {
+    lowStreamCameraEncoderConfiguration?: AGVideoEncoderConfiguration;
+};
+/**
+ * WebRTC 扩展初始化器
+ */
+/** @en
+ *
+ */
+export declare type ExtensionInitializer = {
+    createInstance: () => IExtension<IBaseProcessor>;
+    createProcessor: (extension: IExtension<IBaseProcessor>) => Promise<IBaseProcessor>;
+};
+/**
+ * 音视频处理器初始化器
+ */
+/** @en
+ *
+ */
+export declare type ProcessorInitializer<T extends IBaseProcessor> = {
+    name: string;
+    createProcessor: () => Promise<T>;
+};
+/**
+ * 虚拟背景参数
+ */
+/** @en
+ * Virtual background options
+ */
+export declare type VirtualBackgroundOptions = {
+    url: string;
+    type: 'image' | 'video';
+};
+/**
+ * 美颜参数
+ */
+/** @en
+ * Beauty filter options
+ */
+export declare type BeautyFilterOptions = {
+    smooth: number;
+    brightening: number;
+    blush: number;
+};
+/**
+ * 工具函数
+ */
+/** @en
+ *
+ */
+export { isElectron, isWeb, isProduction } from './utils/check';

package/lib/fcr-ui-scene/src/uistores/action-bar.d.ts

@@ -0,0 +1,58 @@
+import { EduUIStoreBase } from './base';
+import { ShareStreamStateKeeper } from '@ui-scene/utils/stream/state-keeper';
+import { ClassroomState, RecordMode } from 'agora-edu-core';
+import { AgoraRteMediaSourceState } from 'agora-rte-sdk';
+export declare class ActionBarUIStore extends EduUIStoreBase {
+    private _handsUpTask;
+    isHandsUp: boolean;
+    raiseHand(): void;
+    lowerHand(userUuid?: string): void;
+    handsUpMap: Map<string, number>;
+    private _handsUpListScanTask;
+    addHandsUpStudent(userUuid: string): void;
+    removeHandsUpStudent(userUuid: string): void;
+    clearHandsUpStudent(): void;
+    isHandsUpByUserUuid: (userUuid: string) => boolean;
+    startHandsUpMapScan(): void;
+    stopHandsUpListScan(): void;
+    lowerAllHands(): void;
+    get isHost(): boolean;
+    get showEndClassButton(): boolean;
+    get showToolBox(): boolean;
+    get showWhiteBoard(): boolean;
+    get showScreenShare(): boolean;
+    get showRecord(): boolean;
+    get showRaiseHands(): boolean;
+    get showCloud(): boolean;
+    showLeaveOption: boolean;
+    leaveFlag: number;
+    shareScreenStateKeeperMap: Map<string, ShareStreamStateKeeper>;
+    get isScreenSharing(): boolean;
+    get isLocalScreenSharing(): boolean;
+    openChatDialog(): void;
+    closeChatDialog(): void;
+    setPrivateChat(userId: string): void;
+    setShowLeaveOption(show: boolean, flag: number): void;
+    startRecording(): void;
+    stopRecording(): void;
+    get recordArgs(): {
+        webRecordConfig: {
+            rootUrl: string;
+            videoBitrate: number;
+        };
+        mode: RecordMode;
+        retryTimeout: number;
+    };
+    startLocalScreenShare(): void;
+    preCheckScreenShareStatus(): void;
+    stopLocalScreenShare(): void;
+    get screenShareStateAccessor(): {
+        trackState: AgoraRteMediaSourceState;
+        classroomState: ClassroomState;
+    };
+    leaveClassroom(): void;
+    private _onReceiveChannelMessage;
+    private _onReceivePeerMessage;
+    onDestroy(): void;
+    onInstall(): void;
+}

package/lib/fcr-ui-scene/src/uistores/base.d.ts

@@ -0,0 +1,58 @@
+import { EduClassroomStore } from 'agora-edu-core';
+import { Logger } from 'agora-common-libs';
+import { Getters } from './getters';
+/**
+ *
+ */
+/** @en
+ *
+ */
+export declare abstract class EduUIStoreBase {
+    protected _disposers: (() => void)[];
+    /**
+     *
+     */
+    /** @en
+     *
+     */
+    protected readonly logger: Logger;
+    /**
+     *
+     */
+    /** @en
+     *
+     */
+    protected readonly getters: Getters;
+    /**
+     * 当前 EduClassroomStore 实例
+     */
+    /** @en
+     *
+     */
+    readonly classroomStore: EduClassroomStore;
+    /**
+     * 构造函数
+     * @param store
+     * @param shareUIStore
+     */
+    /** @en
+     * 构造函数
+     * @param store
+     * @param shareUIStore
+     */
+    constructor(store: EduClassroomStore, getters: Getters);
+    /**
+     * UIStore 初始化
+     */
+    /** @en
+     *
+     */
+    abstract onInstall(): void;
+    /**
+     * UIStore 销毁
+     */
+    /** @en
+     *
+     */
+    abstract onDestroy(): void;
+}

package/lib/fcr-ui-scene/src/uistores/breakout.d.ts

@@ -0,0 +1,225 @@
+import { EduUIStoreBase } from './base';
+import { GroupDetail, GroupState } from 'agora-edu-core';
+export declare class BreakoutUIStore extends EduUIStoreBase {
+    /**
+     * 每个分组学生最大15人
+     */
+    static readonly MAX_USER_COUNT = 15;
+    /**
+     * 总分组数
+     */
+    static readonly MAX_GROUP_COUNT = 20;
+    /**
+     * 当前分组序号
+     */
+    private _groupSeq;
+    /**
+     * 请求中状态
+     */
+    private _requestLock;
+    /**
+     * 分组邀请所对应的窗口ID
+     */
+    private _dialogsMap;
+    /**
+     * 消息提示
+     */
+    private _toasts;
+    /**
+     * 请求帮助列表
+     */
+    private _helpRequestList;
+    /**
+     * 分组窗口是否打开
+     */
+    private _dialogVisible;
+    /**
+     * 创建步骤:
+     * 0 选择自动\手动分组界面
+     * 1 分组界面
+     */
+    private _wizardState;
+    /**
+     * 正在加入分组中
+     */
+    private _isJoiningSubRoom;
+    /**
+     * 本地分组暂存信息
+     */
+    private _localGroups;
+    /**
+     * 正在加入分组
+     */
+    get isJoiningSubRoom(): boolean;
+    /**
+     * 请求列表
+     */
+    get helpRequestList(): {
+        groupName: string;
+        groupUuid: string;
+    }[];
+    /**
+     * 分组窗口
+     */
+    get breakoutDialogVisible(): boolean;
+    /**
+     * 当前创建步骤
+     */
+    get wizardState(): number;
+    /**
+     * 提示列表
+     */
+    get toasts(): {
+        text: string;
+        id: string;
+    }[];
+    /**
+     * 分组列表
+     */
+    get groups(): {
+        id: string;
+        text: string;
+        sort: number;
+        children: {
+            id: string;
+            text: string;
+        }[];
+    }[];
+    /**
+     * 分组详情
+     */
+    get groupDetails(): Map<string, GroupDetail>;
+    /**
+     * 学生列表
+     */
+    get students(): {
+        userUuid: string;
+        userName: string;
+        groupUuid: string | undefined;
+    }[];
+    /**
+     * 未分组学生列表
+     */
+    get ungroupedCount(): number;
+    get numberToBeAssigned(): number;
+    get mainRoomUsers(): Map<any, any>;
+    get mainRoomStudents(): Map<any, any>;
+    get mainRoomTeachers(): Map<any, any>;
+    get mainRoomAssistants(): Map<any, any>;
+    /**
+     * 未分组用户列表
+     */
+    get ungroupedList(): {
+        id: string;
+        text: string;
+    }[];
+    /**
+     * 当前是否开放分组
+     */
+    get groupState(): GroupState;
+    /**
+     * 当前房间
+     */
+    get currentSubRoomInfo(): GroupDetail | undefined;
+    /**
+     * 老师所在房间
+     */
+    get teacherGroupUuid(): string | undefined;
+    setDialogVisible(visible: boolean): void;
+    setWizardState(state: 0 | 1): void;
+    /**
+     * 获取学生所在组ID
+     * @param userUuid
+     */
+    getUserGroupUuid(userUuid: string): string | undefined;
+    /**
+     * 获取学生信息
+     * @param userUuid
+     */
+    getGroupUserByUuid(userUuid: string): import("agora-edu-core").GroupUser | undefined;
+    /**
+     * 设置分组用户列表
+     * @param groupUuid
+     * @param users
+     */
+    setGroupUsers(groupUuid: string, users: string[]): void;
+    /**
+     * 重命名组
+     * @param groupUuid 分组ID
+     * @param groupName 新分组名
+     */
+    renameGroupName(groupUuid: string, groupName: string): void;
+    getLastOrder(): number;
+    /**
+     * 新增组
+     */
+    addGroup(): void;
+    addToast(message: {
+        text: string;
+    }): void;
+    /**
+     * 删除组
+     * @param groupUuid 组id
+     */
+    removeGroup(groupUuid: string): void;
+    /**
+     * 移动用户
+     * @param fromGroupUuid
+     * @param toGroupUuid
+     * @param user
+     */
+    moveUserToGroup(fromGroupUuid: string, toGroupUuid: string, userUuid: string): void;
+    /**
+     * 用户组互换
+     * @param userUuid1
+     * @param userUuid2
+     */
+    interchangeGroup(userUuid1: string, userUuid2: string): void;
+    startGroup({ copyBoardState }: {
+        copyBoardState: boolean;
+    }): Promise<void>;
+    /**
+     * 结束分组
+     */
+    stopGroup(): Promise<void>;
+    /**
+     * 创建分组
+     * @param type 1 auto 2 manual MANUAL
+     * @param group
+     */
+    createGroups(type: 1 | 2, count: number): void;
+    /**
+     * 获取分组内当前人数
+     * @param groupUuid
+     * @returns
+     */
+    getGroupUserCount(groupUuid: string): number | undefined;
+    /**
+     * 加入子房间
+     * @param groupUuid
+     */
+    joinSubRoom(groupUuid: string): Promise<void>;
+    /**
+     * 发送广播消息
+     * @param message
+     * @returns
+     */
+    broadcastMessage(message: string): void;
+    acceptInvite(groupUuid: string): void;
+    rejectInvite(groupUuid: string): void;
+    leaveSubRoom(): Promise<void>;
+    private _isGroupExisted;
+    private _generateGroupName;
+    private _setConnectionState;
+    private _waitUntilLeft;
+    private _waitUntilConnected;
+    private _waitUntilJoined;
+    private _grantWhiteboard;
+    private _joinSubRoom;
+    private _copyRoomContent;
+    private _leaveSubRoom;
+    private _changeSubRoom;
+    private _handleClassroomEvent;
+    onInstall(): void;
+    onDestroy(): void;
+}

package/lib/fcr-ui-scene/src/uistores/cloud/helper.d.ts

@@ -0,0 +1,26 @@
+import { CloudDriveResource, ConversionOption } from 'agora-edu-core';
+import { CloudDriveResourceConvertProgress } from './struct';
+export declare type CourseWareItem = {
+    resourceName: string;
+    resourceUuid: string;
+    ext: string;
+    url?: string;
+    size: number;
+    updateTime: number;
+    taskUuid?: string;
+    taskProgress?: CloudDriveResourceConvertProgress;
+    conversion?: ConversionOption;
+    initOpen?: boolean;
+};
+export declare const h5Type = "ah5";
+export declare const linkType = "alf";
+export declare const imageTypes: string[];
+export declare const mediaVideoTypes: string[];
+export declare const mediaAudioTypes: string[];
+export declare const convertableTypes: string[];
+export declare const convertableDynamicTypes: string[];
+export declare const supportedTypes: string[];
+export declare const createCloudResource: (data: CourseWareItem) => CloudDriveResource | never;
+export declare const conversionOption: (ext: string, scale?: number | undefined) => ConversionOption | undefined;
+export declare const extractFileExt: (name: string) => string | undefined;
+export declare const fileExt2ContentType: (fileExt: string) => string;