educast-classroom-sdk 2.4.3 → 2.4.5

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

@@ -1,192 +0,0 @@
-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;
-    externalRecordStatus?: RecordStatus;
-    recordStartPending: boolean;
-    private _recordLogId;
-    private _recordAlwaysLog;
-    private _recordTrace;
-    private _recordDebugEnabled;
-    private _waitExternalRecordingStarted;
-    get hasRecordingIntegration(): boolean;
-    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;
-}

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

@@ -1,55 +0,0 @@
-import { EduUIStoreBase } from '../base';
-import { ClassState } from 'agora-edu-core';
-import { Duration } from 'dayjs/plugin/duration';
-export declare class NotificationUIStore extends EduUIStoreBase {
-    private _notificationTask?;
-    private _prevClassState;
-    private _disposers;
-    private _isMobile;
-    leaveClass: boolean;
-    setLeaveRoom(leaveClass: boolean): void;
-    /** Observables */
-    /** Methods */
-    private _filterUsers;
-    onInstall(): void;
-    private _handleClassroomEvent;
-    onDestroy(): void;
-    /**
-     * add class state notification
-     * @param state
-     * @param minutes
-     */
-    protected addClassStateNotification(state: ClassState, minutes: number): void;
-    /** Actions */
-    /**
-     * check classroom notification
-     */
-    protected checkClassroomNotification(): void;
-    private _checkMinutesThrough;
-    /** Computed */
-    /**
-     * 根据课堂状态获取时长，
-     * 未开始：距开始时间
-     * 进行中：距离结束时间
-     * 课程结束：距离教室关闭时间
-     * @returns
-     */
-    get classDuration(): number;
-    /**
-     * 距离教室关闭的时间
-     * @returns
-     */
-    get durationToRoomClose(): Duration;
-    /**
-     * 距离课程结束的时间
-     * @returns
-     */
-    get durationToClassEnd(): Duration;
-    /** others */
-    /** 错误提示信息
-     * get state error reason
-     * @param reason
-     * @returns
-     */
-    private _getStateErrorReason;
-}

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

@@ -1 +0,0 @@
-export declare const matchVirtualSoundCardPattern: (deviceName: string) => boolean;

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

@@ -1,299 +0,0 @@
-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

@@ -1,8 +0,0 @@
-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

@@ -1,163 +0,0 @@
-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;
-}