educast-classroom-sdk 1.0.0

package/lib/infra/stores/common/device-setting/index.d.ts

@@ -0,0 +1,68 @@
+import { EduUIStoreBase } from '../base';
+import { ClassroomState } from 'agora-edu-core';
+export declare type SettingToast = {
+    id: string;
+    type: 'video' | 'audio_recording' | 'audio_playback' | 'error';
+    info: string;
+};
+export declare class DeviceSettingUIStore extends EduUIStoreBase {
+    private _defaultSystemAudioRecordingDeviceId?;
+    private _defaultSystemAudioPlaybackDeviceId?;
+    private _userHasSelectedAudioRecordingDevice;
+    private _userHasSelectedAudioPlaybackDevice;
+    private _disposers;
+    onInstall(): void;
+    /**
+     * 获取视频设备信息
+     **/
+    /** @en
+     * get camera accessors
+     */
+    get cameraAccessors(): {
+        classroomState: ClassroomState;
+        cameraDeviceId: string | undefined;
+        localCameraStreamUuid: string | undefined;
+    };
+    /**
+     * 音频设备信息
+     **/
+    /** @en
+     * mic Accessors
+     */
+    get micAccessors(): {
+        classroomState: ClassroomState;
+        recordingDeviceId: string | undefined;
+        localMicStreamUuid: string | undefined;
+    };
+    /**
+     * 是否可设置隐藏/显示讲台区域
+     */
+    get deviceStage(): boolean | undefined;
+    get stageVisible(): boolean;
+    /**
+     * 设置当前使用摄像头设备
+     * @param id
+     */
+    setCameraDevice(id: string): void;
+    /**
+     * 设置当前使用麦克风设备
+     * @param id
+     */
+    setRecordingDevice(id: string): void;
+    /**
+     * 设置当前使用扬声器设备
+     * @param id
+     */
+    setPlaybackDevice(id: string): void;
+    setUserHasSelectedAudioRecordingDevice(): void;
+    setUserHasSelectedAudioPlaybackDevice(): void;
+    /**
+     * 设置讲台开关
+     * 停止轮询 业务逻辑
+     * @param stage
+     */
+    setStageVisible(stage: boolean): Promise<void>;
+    private _enableLocalVideo;
+    private _enableLocalAudio;
+    onDestroy(): void;
+}

package/lib/infra/stores/common/getters.d.ts

@@ -0,0 +1,61 @@
+import { EduStream } from 'agora-edu-core';
+import { EduClassroomUIStore } from '.';
+export declare class Getters {
+    private _classroomUIStore;
+    constructor(_classroomUIStore: EduClassroomUIStore);
+    get classroomUIStore(): EduClassroomUIStore;
+    /**
+     * 讲台
+     */
+    get layoutMaskCode(): number;
+    /**
+     * 讲台是否显示
+     */
+    get stageVisible(): boolean;
+    /**
+     * 扩展屏是否已开启
+     */
+    get videoGalleryStarted(): boolean;
+    /**
+     * 分组讨论是否已开启
+     */
+    get breakoutRoomStarted(): boolean;
+    /**
+     * 小窗用户ID
+     */
+    get windowStreamUserUuids(): (string | undefined)[];
+    /**
+     * 扩展屏流ID
+     */
+    get galleryVideoStreamUuids(): string[];
+    /**
+     * 台上用户ID
+     */
+    get stageUserUuids(): string[];
+    /**
+     * 老师流信息
+     * @returns
+     */
+    get teacherCameraStream(): EduStream;
+    /**
+     * 学生流信息列表
+     * @returns
+     */
+    get studentCameraStreams(): EduStream[];
+    /**
+     * 台上人员流列表
+     */
+    get stageCameraStreams(): EduStream[];
+    /**
+     * 是否在分组房间
+     */
+    get isInSubRoom(): boolean;
+    /**
+     * 本地摄像头视频流
+     */
+    get localCameraStream(): EduStream | undefined;
+    /**
+     * 本地屏幕视频流
+     */
+    get localScreenStream(): EduStream | undefined;
+}

package/lib/infra/stores/common/group/index.d.ts

@@ -0,0 +1,139 @@
+import { GroupDetail, GroupState } from 'agora-edu-core';
+import { EduUIStoreBase } from '../base';
+export declare enum GroupMethod {
+    AUTO = 0,
+    MANUAL = 1
+}
+export declare class GroupUIStore extends EduUIStoreBase {
+    private _disposers;
+    private _groupSeq;
+    joiningSubRoom: boolean;
+    isCopyContent: boolean;
+    localGroups: Map<string, GroupDetail>;
+    private _groupNum;
+    private _dialogsMap;
+    MAX_USER_COUNT: number;
+    /**
+     * 分组列表
+     */
+    get groups(): {
+        id: string;
+        text: string;
+        children: {
+            id: string;
+            text: string;
+        }[];
+    }[];
+    get groupDetails(): Map<string, GroupDetail>;
+    /**
+     * 获取学生所在组ID
+     * @param userUuid
+     */
+    getUserGroupUuid(userUuid: string): string | undefined;
+    /**
+     * 获取学生信息
+     * @param userUuid
+     */
+    getGroupUserByUuid(userUuid: string): import("agora-edu-core").GroupUser | undefined;
+    /**
+     * 学生列表
+     */
+    get students(): {
+        userUuid: string;
+        userName: string;
+        groupUuid: string | undefined;
+    }[];
+    /**
+     *
+     */
+    get notGroupedCount(): number;
+    get numberToBeAssigned(): number;
+    get userData(): {
+        users: Map<string, import("agora-edu-core").EduUserStruct>;
+        teacherList: Map<string, import("agora-edu-core").EduUserStruct>;
+        studentList: Map<string, import("agora-edu-core").EduUserStruct>;
+        assistantList: Map<string, import("agora-edu-core").EduUserStruct>;
+        rewards: Map<string, number>;
+        userCount: number;
+    };
+    /**
+     * 当前是否开放分组
+     */
+    get groupState(): GroupState;
+    /**
+     * 当前房间
+     */
+    get currentSubRoom(): string | undefined;
+    /**
+     * 设置分组用户列表
+     * @param groupUuid
+     * @param users
+     */
+    setGroupUsers(groupUuid: string, users: string[]): void;
+    /**
+     * 重命名组
+     * @param from 原名字
+     * @param to 新名字
+     */
+    renameGroupName(groupUuid: string, groupName: string): void;
+    /**
+     * 新增组
+     */
+    addGroup(): void;
+    /**
+     * 删除组
+     * @param groupUuid 组id
+     */
+    removeGroup(groupUuid: string): void;
+    /**
+     * 移动用户
+     * @param fromGroupUuid
+     * @param toGroupUuid
+     * @param user
+     */
+    moveUserToGroup(fromGroupUuid: string, toGroupUuid: string, userUuid: string): void;
+    toastFullOfStudents: () => void;
+    /**
+     * 用户组互换
+     * @param userUuid1
+     * @param userUuid2
+     */
+    interchangeGroup(userUuid1: string, userUuid2: string): void;
+    startGroup(): Promise<void>;
+    /**
+     * 结束分组
+     */
+    stopGroup(cb: () => void): Promise<void>;
+    /**
+     * 创建分组
+     * @param type
+     * @param group
+     */
+    createGroups(type: GroupMethod, count: number): void;
+    private _isGroupExisted;
+    getGroupUserCount(groupUuid: string): number | undefined;
+    /**
+     * 加入子房间
+     * @param groupUuid
+     */
+    joinSubRoom(groupUuid: string): void;
+    broadcastMessage(message: string): Promise<void>;
+    private _generateGroupName;
+    private setConnectionState;
+    private _waitUntilLeft;
+    private _waitUntilConnected;
+    private _waitUntilJoined;
+    private _grantWhiteboard;
+    private _joinSubRoom;
+    private _copyRoomContent;
+    private _leaveSubRoom;
+    private _changeSubRoom;
+    /**
+     * 设置是否要复制内容到讨论组
+     * @param v 开启或关闭
+     */
+    setCopyContent(v: boolean): void;
+    onInstall(): void;
+    private _handleClassroomEvent;
+    onDestroy(): void;
+}

package/lib/infra/stores/common/hand-up/index.d.ts

@@ -0,0 +1,119 @@
+import { EduRoleTypeEnum } from 'agora-edu-core';
+import { EduUIStoreBase } from '../base';
+import { OnPodiumStateEnum } from './type';
+import { FetchUserParam, FetchUserType } from '../roster/type';
+export declare type UserWaveArmInfo = {
+    userUuid: string;
+    userName: string;
+    onPodium: boolean;
+};
+export declare type UserHandUpInfo = {
+    name: string;
+    uid: string;
+    role: EduRoleTypeEnum;
+    onPodiumState: OnPodiumStateEnum;
+};
+export declare class HandUpUIStore extends EduUIStoreBase {
+    private _disposers;
+    onInstall(): void;
+    private _curInvitedInfo;
+    private _refuseInvitedTs;
+    /**
+     * 持续挥手时间
+     */
+    get waveArmDurationTime(): number;
+    /**
+     * 查询下一页的参数
+     */
+    get fetchUserListParams(): {
+        nextId: string | number | undefined;
+        count: number;
+        type: FetchUserType;
+    };
+    /**
+     * 查询下一页的ID
+     */
+    private _nextPageId;
+    /**
+     * 分页查询到的用户列表
+     */
+    private _userList;
+    get isOnPodiuming(): boolean;
+    get isWavingArm(): boolean;
+    get userList(): UserHandUpInfo[];
+    /**
+     * 是否被邀请上台
+     * @returns
+     */
+    get beingInvited(): boolean;
+    /**
+     * 挥手用户列表
+     * @returns
+     */
+    get userWaveArmList(): UserWaveArmInfo[];
+    /**
+     * 是否有用户在挥手
+     * @returns
+     */
+    get hasWaveArmUser(): boolean;
+    /**
+     * 挥手用户数
+     * @returns
+     */
+    get waveArmCount(): number;
+    /**
+     * 老师的唯一标识
+     * @returns
+     */
+    get teacherUuid(): string;
+    /**
+     * 学生上台(接受学生举手)
+     * @param userUuid
+     */
+    onPodium: (userUuid: string) => void;
+    /**
+     * 邀请学生上台
+     * @param userUuid
+     */
+    invite(userUuid: string, duration: number, payload?: any): void;
+    /**
+     * 学生同意上台
+     * @param userUuid
+     */
+    confirmInvited(): void;
+    /**
+     * 学生拒绝上台邀请
+     * @param userUuid
+     */
+    refuseInvited(): void;
+    /**
+     * 学生下台
+     * @param userUuid
+     */
+    offPodium: (userUuid: string) => void;
+    /**
+     * 老师拒绝学生上台
+     * @param userUuid
+     */
+    rejectHandUp(userUuid: string): void;
+    /**
+     * 学生取消举手
+     */
+    cancelHandUp(): Promise<void>;
+    /**
+     * 学生挥手
+     *
+     * @param teacherUuid
+     * @param duration 挥手的时间，单位：秒，-1 为持续举手
+     */
+    waveArm(teacherUuid: string, duration: number, payload?: any): void;
+    /**
+     * 获取下一页的用户列表
+     */
+    fetchUsersList(override?: Partial<FetchUserParam>, reset?: boolean): void;
+    /**
+     * 重置学生列表及查询条件
+     */
+    resetStudentList(): void;
+    onDestroy(): void;
+}

package/lib/infra/stores/common/hand-up/type.d.ts

@@ -0,0 +1,18 @@
+export declare enum OnPodiumStateEnum {
+    /**
+     * 正在台上
+     */
+    onPodiuming = 1,
+    /**
+     * 正在挥手
+     */
+    waveArming = 2,
+    /**
+     * 正在被邀请
+     */
+    inviteding = 3,
+    /**
+     * 空闲中
+     */
+    idleing = 4
+}

package/lib/infra/stores/common/index.d.ts

@@ -0,0 +1,78 @@
+import { AgoraRteScene } from 'agora-rte-sdk';
+import { BoardUIStore } from './board';
+import { CloudUIStore } from './cloud-drive';
+import { DeviceSettingUIStore } from './device-setting/index';
+import { HandUpUIStore } from './hand-up';
+import { NavigationBarUIStore } from './nav';
+import { RosterUIStore } from './roster';
+import { EduShareUIStore } from './share';
+import { StreamUIStore } from './stream';
+import { ToolbarUIStore } from './toolbar';
+import { LayoutUIStore } from './layout';
+import { NotificationUIStore } from './notification';
+import { StreamWindowUIStore } from './stream-window';
+import { PretestUIStore } from './pretest';
+import { EduClassroomStore } from 'agora-edu-core';
+import { WidgetUIStore } from './widget';
+import { GroupUIStore } from './group';
+import { SubscriptionUIStore } from './subscription';
+import { VideoGalleryUIStore } from './video-gallery';
+import { Getters } from './getters';
+export declare class EduClassroomUIStore {
+    protected _classroomStore: EduClassroomStore;
+    protected _boardUIStore: BoardUIStore;
+    protected _shareUIStore: EduShareUIStore;
+    protected _cloudUIStore: CloudUIStore;
+    protected _streamUIStore: StreamUIStore;
+    protected _rosterUIStore: RosterUIStore;
+    protected _handUpUIStore: HandUpUIStore;
+    protected _deviceSettingUIStore: DeviceSettingUIStore;
+    protected _navigationBarUIStore: NavigationBarUIStore;
+    protected _toolbarUIStore: ToolbarUIStore;
+    protected _layoutUIStore: LayoutUIStore;
+    protected _notificationUIStore: NotificationUIStore;
+    protected _pretestUIStore: PretestUIStore;
+    protected _widgetUIStore: WidgetUIStore;
+    protected _groupUIStore: GroupUIStore;
+    protected _streamWindowUIStore: StreamWindowUIStore;
+    protected _subscriptionUIStore: SubscriptionUIStore;
+    protected _videoGalleryUIStore: VideoGalleryUIStore;
+    protected _getters: Getters;
+    private _installed;
+    constructor(store: EduClassroomStore);
+    /**
+     * getters
+     */
+    get classroomStore(): EduClassroomStore;
+    get shareUIStore(): EduShareUIStore;
+    get boardUIStore(): BoardUIStore;
+    get cloudUIStore(): CloudUIStore;
+    get streamUIStore(): StreamUIStore;
+    get rosterUIStore(): RosterUIStore;
+    get handUpUIStore(): HandUpUIStore;
+    get deviceSettingUIStore(): DeviceSettingUIStore;
+    get navigationBarUIStore(): NavigationBarUIStore;
+    get toolbarUIStore(): ToolbarUIStore;
+    get layoutUIStore(): LayoutUIStore;
+    get notificationUIStore(): NotificationUIStore;
+    get pretestUIStore(): PretestUIStore;
+    get widgetUIStore(): WidgetUIStore;
+    get groupUIStore(): GroupUIStore;
+    get streamWindowUIStore(): StreamWindowUIStore;
+    get videoGalleryUIStore(): VideoGalleryUIStore;
+    get getters(): Getters;
+    /**
+     * 初始化所有 UIStore
+     * @returns
+     */
+    initialize(): void;
+    enableDualStream(fromScene?: AgoraRteScene): Promise<void>;
+    /**
+     * 加入教室，之后加入 RTC 频道
+     */
+    join(): Promise<void>;
+    /**
+     * 销毁所有 UIStore
+     */
+    destroy(): void;
+}

package/lib/infra/stores/common/layout/helper.d.ts

@@ -0,0 +1,4 @@
+export declare const getRootDimensions: (containerNode: Window | HTMLElement) => {
+    width: number;
+    height: number;
+};

package/lib/infra/stores/common/layout/index.d.ts

@@ -0,0 +1,20 @@
+import { EduUIStoreBase } from '../base';
+export declare class LayoutUIStore extends EduUIStoreBase {
+    awardAnims: {
+        id: string;
+    }[];
+    get isInSubRoom(): boolean;
+    get loadingText(): string;
+    /**
+     * 所在房间名称
+     */
+    get currentSubRoomName(): string | null | undefined;
+    onInstall(): void;
+    private _handleClassroomEvents;
+    removeAward(id: string): void;
+    /**
+     * 教室加载状态
+     */
+    get loading(): boolean;
+    onDestroy(): void;
+}

package/lib/infra/stores/common/nav/index.d.ts

@@ -0,0 +1,184 @@
+import { ClassState, RecordMode, RecordStatus } from 'agora-edu-core';
+import { AGNetworkQuality } from 'agora-rte-sdk';
+import { SvgIconEnum } from '@classroom/ui-kit';
+import { EduUIStoreBase } from '../base';
+export interface EduNavAction<P = undefined> {
+    id: 'Record' | 'AskForHelp' | 'Settings' | 'Exit' | 'Camera' | 'Mic' | 'Share';
+    title: string;
+    iconType: SvgIconEnum;
+    iconColor?: string;
+    onClick?: () => void;
+    payload?: P;
+}
+export interface EduNavRecordActionPayload {
+    text: string;
+    recordStatus: RecordStatus;
+}
+export declare class NavigationBarUIStore extends EduUIStoreBase {
+    private _disposers;
+    onInstall(): void;
+    shareVisible: boolean;
+    get recordStatus(): RecordStatus;
+    get isRecording(): boolean;
+    get isRecordStarting(): boolean;
+    get isRecordStoped(): boolean;
+    /**
+     * 是否选择摄像头设备
+     * @returns
+     */
+    get localCameraOff(): boolean;
+    /**
+     * 是否选择麦克风设备
+     */
+    get localMicOff(): boolean;
+    get hasStreamWindow(): boolean;
+    /**
+     * 当前 camera 的状态根据讲台的隐藏展示 + camera 的状态来更新状态
+     * stage --> 讲台
+     * camera --> camera 状态
+     *
+     * stage === true 那么控制摄像头开关
+     * stage === flase 控制老师窗口的展示和关闭
+     */
+    get localNavCameraOff(): boolean;
+    /**
+     * 顶部导航栏按钮列表
+     * @returns
+     */
+    get actions(): EduNavAction<EduNavRecordActionPayload | undefined>[];
+    get teacherInCurrentRoom(): boolean | "" | undefined;
+    /**
+     * 老师所在房间
+     */
+    get teacherGroupUuid(): string | false | undefined;
+    /**
+     * 教室时间信息
+     * @returns
+     */
+    get classroomSchedule(): import("agora-edu-core/lib/stores/domain/common/room/type").ClassroomSchedule;
+    /**
+     * 教室状态
+     * @returns
+     */
+    get classState(): ClassState | undefined;
+    /**
+     * 服务器时间
+     * @returns
+     */
+    get calibratedTime(): number;
+    /**
+     * 教室持续时间
+     * @returns
+     */
+    get classTimeDuration(): number;
+    /**
+     * 教室状态文字
+     * @returns
+     */
+    get classStatusText(): string;
+    /**
+     * 教室状态文字颜色
+     * @returns
+     */
+    get classStatusTextColor(): "#F04C36" | "#677386" | undefined;
+    /**
+     * 是否为开始上课
+     * @returns
+     */
+    get isBeforeClass(): boolean;
+    /**
+     * 网络质量状态
+     * @returns
+     */
+    get networkQualityClass(): string;
+    /**
+     * 网络质量状态图标
+     * @returns
+     */
+    get networkQualityIcon(): {
+        icon: SvgIconEnum;
+        color: string;
+    };
+    /**
+     * 网络质量状态
+     * @returns
+     */
+    get networkQualityLabel(): string;
+    /**
+     * CPU 用量
+     * @returns
+     */
+    get cpuValue(): number;
+    /**
+     * CPU 负载百分比
+     * @returns
+     */
+    get cpuLabel(): string;
+    /**
+     * 丢包率
+     * @returns
+     */
+    get packetLoss(): string;
+    /**
+     * 网络质量状态
+     * @returns
+     */
+    get networkQuality(): AGNetworkQuality;
+    /**
+     * 网络延时
+     * @returns
+     */
+    get delay(): string;
+    /**
+     * 导航栏标题
+     * @returns
+     */
+    get navigationTitle(): string;
+    /**
+     * 当前屏幕分享人名称
+     */
+    get currScreenShareTitle(): string | undefined;
+    /**
+     * 所在房间名称
+     */
+    get currentSubRoomName(): string | null | undefined;
+    get recordArgs(): {
+        webRecordConfig: {
+            rootUrl: string;
+            videoBitrate: number;
+        };
+        mode: RecordMode;
+        retryTimeout: number;
+    };
+    /**
+     * 倒计时格式化
+     * @param ms
+     * @param mode
+     * @returns
+     */
+    private formatCountDown;
+    closeShare(): void;
+    /**
+     * 开始上课
+     */
+    startClass(): Promise<void>;
+    /**
+     * 切换本地摄像头设备开关状态
+     */
+    private _toggleLocalVideo;
+    /**
+     * 切换本地麦克风设备开关状态
+     */
+    private _toggleLocalAudio;
+    /**
+     * 打开关闭老师的 streamWindow
+     */
+    private _toggleStreamWindow;
+    /**
+     * stage === true 那么控制摄像头开关
+     * stage === flase 控制老师窗口的展示和关闭
+     */
+    private _toggleNavCamera;
+    private _leaveSubRoom;
+    onDestroy(): void;
+}