educast-classroom-sdk 2.4.2 → 2.4.3

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

@@ -0,0 +1,299 @@
+import { AGBeautyEffect, AgoraRteMediaSourceState } from 'agora-rte-sdk';
+import { EduUIStoreBase } from '../base';
+import { BeautyType } from 'agora-edu-core';
+import { CameraPlaceholderType } from '../stream/struct';
+export declare type PretestToast = {
+    id: string;
+    type: 'video' | 'audio_recording' | 'audio_playback' | 'error';
+    info: string;
+};
+declare type AddToastArgs = Omit<PretestToast, 'id'>;
+declare type EffectType = 'beauty' | 'virtualBackground';
+declare type DeviceType = 'audio' | 'video';
+export declare class PretestUIStore extends EduUIStoreBase {
+    private _disposers;
+    currentEffectType: EffectType;
+    beautyEffectOptions: AGBeautyEffect;
+    currentPretestTab: DeviceType | 'stage';
+    aiDenoiserEnabled: boolean;
+    backgroundImage: never[];
+    currentVirtualBackground: string;
+    private _virtualBackgroundProcessor?;
+    private _beautyEffectProcessor?;
+    private _aiDenoiserProcessor?;
+    private _virtualBackgroundProcessorForPreview?;
+    private _beautyEffectProcessorForPreview?;
+    private _aiDenoiserProcessorForPreview?;
+    onInstall(): void;
+    get virtualBackgroundSupported(): boolean;
+    get beautySupported(): boolean;
+    get aiDenoiserSupported(): boolean;
+    /**
+     * 交互事件通知
+     * @param type
+     */
+    private _handleInteractionEvents;
+    private _timer;
+    /**
+     * Toast 消息列表
+     */
+    toastQueue: PretestToast[];
+    /**
+     * 美颜类型
+     */
+    activeBeautyType: BeautyType | 'none';
+    /**
+     * 是否正在测试扬声器
+     */
+    playbackTesting: boolean;
+    /**
+     * 视频消息 Toast 列表
+     * @returns
+     */
+    get videoToastQueue(): PretestToast[];
+    /**
+     * 扬声器消息 Toast 列表
+     * @returns
+     */
+    get audioPlaybackToastQueue(): PretestToast[];
+    /**
+     * 麦克风消息 Toast 列表
+     * @returns
+     */
+    get audioRecordingToastQueue(): PretestToast[];
+    /**
+     * 错误消息 Toast 列表
+     * @returns
+     */
+    get errorToastQueue(): PretestToast[];
+    /**
+     * 摄像头设备列表
+     * @returns
+     */
+    get cameraDevicesList(): {
+        label: string;
+        value: string;
+    }[];
+    /**
+     * 麦克风设备列表
+     * @returns
+     */
+    get recordingDevicesList(): {
+        label: string;
+        value: string;
+    }[];
+    /**
+     * 扬声器设备列表
+     * @returns
+     */
+    get playbackDevicesList(): {
+        label: string;
+        value: string;
+    }[];
+    /**
+     * 当前摄像头设备ID
+     * @returns
+     */
+    get currentCameraDeviceId(): string;
+    /**
+     * 当前麦克风设备ID
+     * @returns
+     */
+    get currentRecordingDeviceId(): string;
+    /**
+     * 当前扬声器设备ID
+     * @returns
+     */
+    get currentPlaybackDeviceId(): string;
+    /**
+     * 麦克风音量
+     * @returns 音量 0 ~ 1
+     */
+    get localVolume(): number;
+    /**
+     * 本地音量（设备检测）
+     * @returns
+     */
+    get localPreviewVolume(): number;
+    /**
+     * 扬声器测试音量
+     * @returns 音量 0 ~ 1
+     */
+    get localPlaybackTestVolume(): number;
+    /**
+     * 本地摄像头设备状态
+     * @returns
+     */
+    get localCameraTrackState(): AgoraRteMediaSourceState;
+    /**
+     * 本地麦克风设备状态
+     * @returns
+     */
+    get localMicTrackState(): AgoraRteMediaSourceState;
+    /**
+     * 本地摄像头设备状态（设备检测）
+     * @returns
+     */
+    get localPreviewCameraTrackState(): AgoraRteMediaSourceState;
+    /**
+     * 本地摄像头是否开启
+     * @returns
+     */
+    get localCameraOff(): boolean;
+    /**
+     * 本地麦克风设备是否开启
+     * @returns
+     */
+    get localMicOff(): boolean;
+    /**
+     * 本地摄像头是否开启（设备检测）
+     */
+    get localPreviewCameraOff(): boolean;
+    /**
+     * 本地音频设备状态显示的 Icon 类型
+     * microphone-off 麦克风开启
+     * microphone-on  麦克风关闭
+     * @returns Icon 类型
+     */
+    get localMicIconType(): "microphone-on" | "microphone-off";
+    /**
+     * 本地视频状态显示的占位符类型
+     * @returns
+     */
+    get localCameraPlaceholder(): CameraPlaceholderType;
+    /**
+     * 本地视频状态显示的占位符类型（设备检测）
+     * @returns
+     */
+    get localPreviewCameraPlaceholder(): CameraPlaceholderType;
+    /**
+     * @ignore
+     */
+    get disable(): boolean;
+    /**
+     * 是否开启镜像
+     * @returns
+     */
+    get isMirror(): boolean;
+    /**
+     * 美白参数 (0 ~ 100)
+     * @returns
+     */
+    get whiteningValue(): number;
+    /**
+     * 红润参数 (0 ~ 100)
+     * @returns
+     */
+    get ruddyValue(): number;
+    /**
+     * 磨皮参数 (0 ~ 100)
+     * @returns
+     */
+    get buffingValue(): number;
+    /**
+     * 美颜调整参数类型
+     * @returns
+     */
+    get activeBeautyValue(): number;
+    /**
+     * 显示 Toast 信息
+     * @param toast
+     */
+    addToast(toast: AddToastArgs): void;
+    /**
+     * 移除 Toast 信息
+     * @param id
+     * @returns
+     */
+    removeToast(id: string): string;
+    /**
+     * 设置镜像开启或关闭
+     * @param v 开启或关闭
+     */
+    setMirror(v: boolean): void;
+    /**
+     * 开始扬声器测试
+     * @param url
+     */
+    startPlaybackDeviceTest(url: string): void;
+    /**
+     * 停止扬声器测试
+     */
+    stopPlaybackDeviceTest(): void;
+    /**
+     * 开始麦克风测试
+     */
+    startRecordingDeviceTest(): void;
+    /**
+     * 停止麦克风测试
+     */
+    stopRecordingDeviceTest(): void;
+    /**
+     * 打开本地摄像头
+     * @param value 开启或关闭
+     */
+    enableLocalVideo(value: boolean): void;
+    /**
+     * 打开本地麦克风
+     * @param value 开启或关闭
+     */
+    enableLocalAudio(value: boolean): void;
+    /**
+     * 设置当前使用摄像头设备
+     * @param id
+     */
+    setCameraDevice(id: string): void;
+    /**
+     * 设置当前使用麦克风设备
+     * @param id
+     */
+    setRecordingDevice(id: string): void;
+    /**
+     * 设置美颜类型
+     * @param value
+     */
+    setActiveBeautyType(value: BeautyType | 'none'): void;
+    /**
+     * 设置美颜参数
+     * @param value (0 ~ 100)
+     */
+    setActiveBeautyValue(value: number): void;
+    /**
+     * 设置当前使用扬声器设备
+     * @param id
+     */
+    setPlaybackDevice(id: string): void;
+    /**
+     * 渲染本地视频
+     * @param dom
+     * @param mirror
+     */
+    setupLocalVideo(dom: HTMLElement, mirror: boolean): void;
+    /**
+     * 设置单当前效果tab
+     */
+    setCurrentEffectOption(type: EffectType): void;
+    setCurrentTab(type: DeviceType | 'stage'): void;
+    handleBackgroundChange(key: string, value?: {
+        type: 'img';
+        url: string;
+    } | {
+        type: 'video';
+        url: string;
+    }): void;
+    setAIDenoiser(enable: boolean): void;
+    setVirtualBackground({ type, source, }: {
+        type: 'img';
+        source: HTMLImageElement;
+    } | {
+        type: 'video';
+        source: HTMLVideoElement;
+    }): void;
+    startCameraPreview(): void;
+    stopCameraPreview(): void;
+    startAudioRecordingPreview(): void;
+    stopAudioRecordingPreview(): void;
+    setupLocalVideoPreview(dom: HTMLElement, mirror: boolean): void;
+    onDestroy(): void;
+}
+export {};

package/lib/infra/stores/common/pretest/type.d.ts

@@ -0,0 +1,8 @@
+export declare enum DeviceStateChangedReason {
+    cameraFailed = "pretest.device_not_working",
+    micFailed = "pretest.device_not_working",
+    newDeviceDetected = "new_device_detected",
+    cameraUnplugged = "pretest.camera_move_out",
+    micUnplugged = "pretest.mic_move_out",
+    playbackUnplugged = "pretest.playback_move_out"
+}

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

@@ -0,0 +1,163 @@
+import { IReactionDisposer } from 'mobx';
+import { EduUIStoreBase } from '../base';
+import { DeviceState, Operation, Profile } from './type';
+import { BoardGrantState } from '@classroom/ui-kit';
+export declare class RosterUIStore extends EduUIStoreBase {
+    /**
+     * width: 花名册窗口宽度
+     */
+    get uiOverrides(): {
+        width: number;
+    };
+    protected _disposers: IReactionDisposer[];
+    onInstall(): void;
+    /** Observables */
+    /**
+     * 检索字符串
+     */
+    searchKeyword: string;
+    /**
+     * 轮播参数
+     */
+    carousel: {
+        isOpenCarousel: boolean;
+        mode: string;
+        randomValue: string;
+        times: string;
+    };
+    /** Methods */
+    /**
+     * 开始轮播
+     * @param start
+     */
+    private startCarousel;
+    /**
+     * 轮播参数事件
+     * @param propKey
+     * @returns
+     */
+    private updatePartial;
+    /**
+     * 获取主流
+     * @param userUuid
+     * @returns
+     */
+    protected getMainStream(userUuid: string): import("agora-edu-core").EduStream | null | undefined;
+    /**
+     * 是否不可点击操作
+     * @param deviceState
+     * @returns
+     */
+    protected shouldBlockMediaAction(deviceState: DeviceState): boolean;
+    /**
+     * 更新轮播参数
+     * @param carousel
+     */
+    /** Actions */
+    updateCarousel(carousel: RosterUIStore['carousel']): void;
+    /**
+     * 设置检索字符串
+     * @param keyword
+     */
+    setSearchKeyword(keyword: string): void;
+    /**
+     * 花名册功能按钮点击
+     * @param operation
+     * @param profile
+     */
+    clickRowAction: (operation: Operation, profile: Profile) => void;
+    clickInvitePodium: (profile: Profile) => void;
+    clickPodium: (profile: Profile) => void;
+    clickGrantBoard: (profile: Profile) => void;
+    clickCamera: (profile: Profile) => void;
+    clickMicrophone: (profile: Profile) => void;
+    clickStar: (profile: Profile) => void;
+    clickKick: (profile: Profile) => void;
+    /** Computed */
+    /**
+     * 老师名称
+     * @returns
+     */
+    get teacherName(): string;
+    /**
+     * 学生列表
+     * @returns
+     */
+    get userList(): {
+        uid: string;
+        name: string;
+        isOnPodium: boolean;
+        boardGrantState: BoardGrantState;
+        isChatMuted: boolean;
+        cameraState: DeviceState;
+        microphoneState: DeviceState;
+        stars: number;
+        operations: Partial<Record<Operation, {
+            interactable: boolean;
+        }>>;
+    }[];
+    /**
+     * 花名册功能列表
+     * @returns
+     */
+    get rosterFunctions(): ("search" | "stars" | "kick" | "podium" | "grant-board" | "supervise-student" | "carousel")[];
+    /**
+     * 轮播组件属性
+     * @returns
+     */
+    get carouselProps(): {
+        onTimesChange: (val: string, eventType?: "blur" | "change" | undefined) => void;
+        onModeChange: (val: string, eventType?: "blur" | "change" | undefined) => void;
+        onRandomValueChange: (val: string, eventType?: "blur" | "change" | undefined) => void;
+        onOpenCarousel: (val: boolean, eventType?: "blur" | "change" | undefined) => void;
+        isOpenCarousel: boolean;
+        mode: string;
+        randomValue: string;
+        times: string;
+    };
+    get groupStarted(): boolean;
+    /** Getters */
+    /**
+     * 是否有踢人权限
+     * @returns
+     */
+    get canKickOut(): boolean;
+    /**
+     * 是否有白板授权权限
+     * @returns
+     */
+    get canGrantWhiteboardPermissions(): boolean;
+    /**
+     * 是否可以操作上下台
+     * @returns
+     */
+    get canOperatePodium(): boolean;
+    /**
+     * 是否可以禁言IM
+     * @returns
+     */
+    get canMuteChat(): boolean;
+    /**
+     * 是否可以开启和关闭学生音视频
+     * @returns
+     */
+    get canOperateMedia(): boolean;
+    /**
+     * 是否可以操作轮播
+     * @returns
+     */
+    get canOperateCarousel(): boolean;
+    /**
+     * 是否可以检索
+     * @returns
+     */
+    get canSearchInRoster(): boolean;
+    /**
+     * 是否可以发奖励
+     * @returns
+     */
+    get canSendRewards(): boolean;
+    get canSubscribeUser(): boolean;
+    get canSuperviseStudent(): boolean;
+    onDestroy(): void;
+}

package/lib/infra/stores/common/roster/type.d.ts

@@ -0,0 +1,55 @@
+import { EduRoleTypeEnum } from 'agora-edu-core';
+export declare enum DeviceState {
+    enabled = 0,
+    disabled = 1,
+    unavailable = 2,
+    unauthorized = 3
+}
+export declare type Operation = 'podium' | 'invite-podium' | 'grant-board' | 'camera' | 'microphone' | 'kick' | 'chat' | 'star' | 'supervise-student';
+export declare type Operations = Partial<Record<Operation, {
+    interactable: boolean;
+}>>;
+export declare type Profile = {
+    uid: string | number;
+    isOnPodium: boolean;
+    cameraState: DeviceState;
+    microphoneState: DeviceState;
+};
+/**
+ * 分页查询用户参数
+ */
+export interface FetchUserParam {
+    /**
+     * 下一页的ID
+     */
+    nextId: string | number | null | undefined;
+    /**
+     * 一页查询多少条
+     */
+    count: number;
+    /**
+     * 筛选类型 0:全部 1:禁言
+     */
+    type: FetchUserType;
+    /**
+     * 查询角色
+     */
+    role: EduRoleTypeEnum;
+    /**
+     * 查询的用户名称，模糊查询
+     */
+    userName?: string;
+}
+/**
+ * 筛选用户类型 0:全部 1:禁言
+ */
+export declare enum FetchUserType {
+    /**
+     * 筛选全部的用户
+     */
+    all = "0",
+    /**
+     * 筛选禁言的用户
+     */
+    mute = "1"
+}

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

@@ -0,0 +1,151 @@
+import { WindowID } from '@classroom/infra/api';
+import { AGError, Logger } from 'agora-rte-sdk';
+import { ConfirmDialogAction, OrientationEnum } from '../type';
+export declare enum DialogCategory {
+    CloudDriver = 0,
+    Roster = 1,
+    LectureRoster = 2,
+    KickOut = 3,
+    ErrorGeneric = 4,
+    Confirm = 5,
+    DeviceSetting = 6,
+    ScreenPicker = 7,
+    BreakoutRoom = 8,
+    Quit = 9,
+    ScreenShare = 10,
+    RemoteControlConfirm = 11,
+    VideoGallery = 12,
+    InvitePodium = 13,
+    InviteConfirm = 14,
+    Guide = 15
+}
+export interface ToastType {
+    id: string;
+    desc: string;
+    type?: ToastTypeEnum;
+}
+export declare type ToastTypeEnum = 'success' | 'error' | 'warning' | 'info' | 'normal';
+export interface DialogType {
+    id: string;
+    category: DialogCategory;
+    props?: unknown;
+}
+export declare class EduShareUIStore {
+    protected readonly logger: Logger;
+    readonly classroomViewportClassName = "classroom-viewport";
+    readonly classroomViewportTransitionDuration = 300;
+    get navHeight(): 72 | 27;
+    get bottomBarHeight(): 0 | 104;
+    private _viewportAspectRatio;
+    private _classroomMinimumSize;
+    private _containerNode;
+    private _matchMedia;
+    private _resizeEventListenerAdded;
+    /**
+     * 教室UI布局完毕
+     */
+    layoutReady: boolean;
+    /**
+     * 模态框列表
+     */
+    dialogQueue: DialogType[];
+    /**
+     * Toast 列表
+     */
+    toastQueue: ToastType[];
+    /**
+     * 视口尺寸信息
+     */
+    classroomViewportSize: {
+        width: number;
+        height: number;
+        h5Width?: number;
+        h5Height?: number;
+    };
+    orientation: OrientationEnum;
+    forceLandscape: boolean;
+    get isLandscape(): boolean;
+    setForceLandscape(forceLandscape: boolean): void;
+    /**
+     * 添加一条 单例 Toast 信息
+     * @param desc
+     * @returns
+     */
+    addSingletonToast(desc: string, type: ToastTypeEnum): string;
+    /**
+     * 显示一条 Toast 信息
+     * @param desc
+     * @param type
+     * @returns
+     */
+    addToast(desc: string, type?: ToastTypeEnum): string;
+    /**
+     * 移除 Toast 信息
+     * @param id
+     * @returns
+     */
+    removeToast(id: string): string;
+    /**
+     * 显示错误提示模态框
+     * @param error
+     * @param opts
+     */
+    addGenericErrorDialog(error: AGError, opts?: {
+        onOK?: () => void;
+        okBtnText?: string;
+    }): void;
+    /**
+     * 显示确认模态框
+     * @param title
+     * @param content
+     * @param onOK
+     * @param actions
+     * @param onCancel
+     */
+    addConfirmDialog(title: string, content: string, { onOK, actions, onCancel, btnText, timeout, }?: {
+        onOK?: () => void | Promise<void>;
+        actions?: ConfirmDialogAction[];
+        onCancel?: () => void;
+        btnText?: Record<ConfirmDialogAction, string>;
+        timeout?: number;
+    }): string;
+    /**
+     * 显示模态框
+     * @param category
+     * @param props
+     * @returns
+     */
+    addDialog(category: DialogCategory, props?: any): any;
+    /**
+     * 移除模态框
+     * @param id
+     */
+    removeDialog(id: string): void;
+    /** Actions */
+    /**
+     * 更新教室视口尺寸信息
+     */
+    updateClassroomViewportSize(): void;
+    handleOrientationchange(): void;
+    /**
+     设置 Resize 事件处理器
+     */
+    addWindowResizeEventListener(): void;
+    /**
+     * 移除 Resize 事件处理器
+     */
+    removeWindowResizeEventListener(): void;
+    addOrientationchange(): void;
+    removeOrientationchange(): void;
+    showWindow(windowID: WindowID): void;
+    hideWindow(windowID: WindowID): void;
+    openWindow(windowID: WindowID, payload: {
+        args?: Record<string, string | number | boolean>;
+        options?: Record<string, string | number | boolean>;
+    }): void;
+    moveWindowToTargetScreen(windowID: WindowID, screenId: string, options: Record<string, string | number | boolean>): void;
+    moveWindowAlignToWindow(windowID: WindowID, windowIDAlignTo: WindowID, options: Record<string, string | number | boolean>): void;
+    closeWindow(windowID: WindowID): void;
+    addViewportResizeObserver(callback: () => void): ResizeObserver;
+    setLayoutReady(ready: boolean): void;
+}