educast-classroom-sdk 2.4.1 → 2.4.3

package/lib/infra/stores/common/stream-window/struct.d.ts

@@ -0,0 +1,95 @@
+/**
+ * streamWindow widget
+ */
+export declare class StreamWindowWidget {
+    width: number;
+    height: number;
+    x: number;
+    y: number;
+    /**
+     * view 层级关系
+     */
+    zIndex: number;
+    /**
+     * 是否填充到多视频区域
+     */
+    contain: boolean;
+    constructor({ width, height, x, y, zIndex, contain, }: {
+        width?: number;
+        height?: number;
+        x?: number;
+        y?: number;
+        zIndex?: number;
+        contain?: boolean;
+    });
+    get information(): {
+        width?: number;
+        height?: number;
+        x?: number;
+        y?: number;
+        zIndex?: number;
+        contain?: boolean;
+    };
+    set information({ width, height, x, y, zIndex, contain, }: {
+        width?: number;
+        height?: number;
+        x?: number;
+        y?: number;
+        zIndex?: number;
+        contain?: boolean;
+    });
+}
+/**
+ * 从服务端来的 widget 数据
+ */
+export declare class WidgetInfo {
+    state: 1 | 0;
+    ownerUserUuid: string;
+    position: {
+        xaxis: number;
+        yaxis: number;
+    };
+    size: {
+        width: number;
+        height: number;
+    };
+    extra: {
+        contain: boolean;
+        zIndex: number;
+        userUuid: string;
+    };
+    constructor({ position, size, extra, ownerUserUuid, state, }: {
+        ownerUserUuid: string;
+        position: {
+            xaxis: number;
+            yaxis: number;
+        };
+        size: {
+            width: number;
+            height: number;
+        };
+        extra: {
+            contain: boolean;
+            zIndex: number;
+            userUuid: string;
+        };
+        state: 1 | 0;
+    });
+    get information(): {
+        state: 0 | 1;
+        ownerUserUuid: string;
+        position: {
+            xaxis: number;
+            yaxis: number;
+        };
+        size: {
+            width: number;
+            height: number;
+        };
+        extra: {
+            contain: boolean;
+            zIndex: number;
+            userUuid: string;
+        };
+    };
+}

package/lib/infra/stores/common/stream-window/type.d.ts

@@ -0,0 +1,32 @@
+export interface StreamWindow {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    /**
+     * view 层级关系
+     */
+    zIndex: number;
+    /**
+     * 是否填充到多视频区域
+     */
+    contain: boolean;
+}
+export declare type StreamWindowBounds = Omit<StreamWindow, 'userUuid'>;
+export interface WidgetTrackStruct {
+    state: number;
+    position: {
+        xaxis: number;
+        yaxis: number;
+    };
+    size: {
+        width: number;
+        height: number;
+    };
+    extra: {
+        contain: boolean;
+        zIndex: number;
+        userUuid: string;
+        [key: string]: any;
+    };
+}

package/lib/infra/stores/common/subscription/abstract.d.ts

@@ -0,0 +1,43 @@
+import { AgoraMediaControl, AgoraRteScene, AgoraStream, AGRtcChannel, AGRtcConnectionType, Logger } from 'agora-rte-sdk';
+import { IReactionDisposer } from 'mobx';
+import { Getters } from '../getters';
+import { RemoteStreamMuteStatus } from './type';
+export declare abstract class SceneSubscription {
+    protected scene: AgoraRteScene;
+    protected getters: Getters;
+    logger: Logger;
+    protected _disposers: IReactionDisposer[];
+    protected _active: boolean;
+    protected _rtcChannel: AGRtcChannel;
+    protected _mediaControl: AgoraMediaControl;
+    protected _muteRegistry: Map<string, {
+        muteVideo: boolean;
+        muteAudio: boolean;
+    }>;
+    get active(): boolean;
+    get subscribeAll(): boolean;
+    constructor(scene: AgoraRteScene, getters: Getters);
+    protected abstract handleLocalStreamAdded(streams: AgoraStream[]): void;
+    protected abstract handleLocalStreamUpdated(streams: AgoraStream[]): void;
+    protected abstract handleLocalStreamRemoved(streams: AgoraStream[]): void;
+    protected abstract handleRemoteStreamAdded(streams: AgoraStream[]): void;
+    protected abstract handleRemoteStreamUpdated(streams: AgoraStream[]): void;
+    protected abstract handleRemoteStreamRemoved(streams: AgoraStream[]): void;
+    setActive(active: boolean): void;
+    destroy(): void;
+    printStat(): void;
+    private _handleUserRemoved;
+    protected putRegistry(streamUuid: string, { muteVideo, muteAudio }: {
+        muteVideo?: boolean;
+        muteAudio?: boolean;
+    }): void;
+    protected removeRegistry(streamUuid: string): void;
+    protected isMuted(stream: AgoraStream): {
+        muteVideo: boolean;
+        muteAudio: boolean;
+    };
+    protected muteRemoteStream(scene: AgoraRteScene, stream: AgoraStream, muteStatus: RemoteStreamMuteStatus): RemoteStreamMuteStatus;
+    protected getStreamConnType(stream: AgoraStream): AGRtcConnectionType;
+    protected muteLocalStream(scene: AgoraRteScene, stream: AgoraStream): void;
+    protected muteRemoteStreams(scene: AgoraRteScene, streams: AgoraStream[]): void;
+}

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

@@ -0,0 +1,14 @@
+import { AgoraRteScene } from 'agora-rte-sdk';
+import { SceneSubscription } from './abstract';
+import { EduUIStoreBase } from '../base';
+export declare class SubscriptionUIStore extends EduUIStoreBase {
+    private _disposers;
+    private _sceneSubscriptions;
+    setActive(sceneId: string): void;
+    createSceneSubscription(scene: AgoraRteScene): SceneSubscription | undefined;
+    removeSceneSubscription(scene: AgoraRteScene): void;
+    clearSubscription(): void;
+    printStat(): void;
+    onInstall(): void;
+    onDestroy(): void;
+}

package/lib/infra/stores/common/subscription/main-room.d.ts

@@ -0,0 +1,14 @@
+import { AgoraStream } from 'agora-rte-sdk';
+import { SceneSubscription } from './abstract';
+export declare class MainRoomSubscription extends SceneSubscription {
+    protected handleLocalStreamAdded(streams: AgoraStream[]): void;
+    protected handleLocalStreamUpdated(streams: AgoraStream[]): void;
+    protected handleLocalStreamRemoved(streams: AgoraStream[]): void;
+    protected handleRemoteStreamAdded(streams: AgoraStream[]): void;
+    protected handleRemoteStreamUpdated(streams: AgoraStream[]): void;
+    protected handleRemoteStreamRemoved(streams: AgoraStream[]): void;
+    get active(): boolean;
+    setActive(active: boolean): void;
+    protected unsubscribeAll(): void;
+    protected subscribe(): void;
+}

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

@@ -0,0 +1,10 @@
+import { AgoraRteVideoSourceType, AGRtcConnectionType } from 'agora-rte-sdk';
+export declare type RemoteStreamMuteStatus = {
+    muteVideo?: boolean;
+    muteAudio?: boolean;
+};
+export declare type LocalVideoStreamSubscribeOption = {
+    mute: boolean;
+    connectionType: AGRtcConnectionType;
+    sourceType: AgoraRteVideoSourceType;
+};

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

@@ -0,0 +1,145 @@
+import { EduUIStoreBase } from '../base';
+import { EduStreamUI } from '../stream/struct';
+import { CabinetItem, ToolbarItem } from './type';
+export declare class ToolbarUIStore extends EduUIStoreBase {
+    readonly defaultColors: string[];
+    readonly defaultPens: string[];
+    readonly paletteMap: Record<string, string>;
+    readonly module: string;
+    readonly allowedCabinetItems: string[];
+    private _disposers;
+    onInstall(): void;
+    activeMap: Record<string, boolean>;
+    private _activeCabinetItems;
+    /**
+     * 当前激活的工具
+     * @returns
+     */
+    get activeTool(): "circle" | "line" | "text" | "square" | "triangle" | "arrow" | "pentagram" | "rhombus" | "pen" | "eraser" | "clicker" | "selection" | "hand" | "laser" | undefined;
+    /**
+     * 当前激活的画笔类工具
+     * @returns
+     */
+    get selectedPenTool(): "circle" | "line" | "text" | "square" | "triangle" | "arrow" | "pentagram" | "rhombus" | "pen" | "eraser" | "clicker" | "selection" | "hand" | "laser" | undefined;
+    /**
+     * 画笔工具是否激活
+     * @returns
+     */
+    get isPenToolActive(): boolean | undefined;
+    /**
+     * 选中的画笔颜色
+     * @returns
+     */
+    get currentColor(): string;
+    /**
+     * 选中的画笔粗细
+     * @returns
+     */
+    get strokeWidth(): number;
+    /**
+     * 是否正在进行屏幕共享
+     * @returns
+     */
+    get isScreenSharing(): boolean;
+    /**
+     * 是否打开白板
+     * @returns
+     */
+    get isWhiteboardOpening(): boolean;
+    handleBoradCleaner(id: string): void;
+    /**
+     * 老师流信息列表
+     * @returns
+     */
+    get teacherStreams(): Set<EduStreamUI>;
+    /**
+     * 老师流信息（教室内只有一个老师时使用，如果有一个以上老师请使用 teacherStreams）
+     * @returns
+     */
+    get teacherCameraStream(): EduStreamUI | undefined;
+    startLocalScreenShare(): void;
+    selectScreenShareDevice(): Promise<void>;
+    /**
+     * 打开内建工具
+     * @param id
+     */
+    openBuiltinCabinet(id: string): Promise<void>;
+    handleSliceItem(id: string): void;
+    /**
+     * 选中工具
+     * @param tool
+     * @returns
+     */
+    setTool(tool: string): void;
+    private _openCloudDrive;
+    private _openRoster;
+    private _saveBoardSnapshot;
+    private _setToolActive;
+    private _setToolInactive;
+    readonly penTools: string[];
+    /**
+     * 设置画笔粗细
+     * @param value
+     * @returns
+     */
+    changeStroke(value: number): void;
+    /**
+     * 设置画笔颜色，支持 RGB 色值
+     * @param value
+     * @returns
+     */
+    changeHexColor(value: string): void;
+    /**
+     * 当前激活的工具
+     * @returns
+     */
+    get activeCabinetItems(): Set<string>;
+    /**
+     * 工具箱列表
+     * @returns
+     */
+    get cabinetItems(): CabinetItem[];
+    /**
+     * 白板清除选项列表
+     * @returns
+     */
+    get boardCleanerItems(): CabinetItem[];
+    /**
+     * 工具栏工具列表
+     * @returns
+     */
+    get tools(): ToolbarItem[];
+    /**
+     * 截图选项列表
+     * @returns
+     */
+    get sliceItems(): CabinetItem[];
+    /**
+     * 老师工具栏工具列表
+     * @returns
+     */
+    get teacherTools(): ToolbarItem[];
+    /**
+     * 学生工具栏工具列表
+     * @returns
+     */
+    get studentTools(): ToolbarItem[];
+    /**
+     * 转 Edu 工具 对象
+     * @param tool
+     * @returns
+     */
+    private _convertUITools2EduTools;
+    /**
+     * 转 UI 工具对象
+     * @param tool
+     * @returns
+     */
+    private _convertEduTools2UITools;
+    /**
+     * 把截图贴到白板中
+     * @param dataURL
+     */
+    private _pastToBoard;
+    onDestroy(): void;
+}

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

@@ -0,0 +1,45 @@
+export declare enum ToolbarItemCategory {
+    PenPicker = 0,
+    ColorPicker = 1,
+    Cabinet = 2,
+    Eraser = 3,
+    Slice = 4,
+    Roster = 5,
+    Text = 6,
+    Clicker = 7,
+    Selector = 8,
+    CloudStorage = 9,
+    Save = 10,
+    Hand = 11
+}
+export declare enum CabinetItemEnum {
+    ScreenShare = "screenShare",
+    BreakoutRoom = "breakoutRoom",
+    Laser = "laser",
+    Whiteboard = "whiteboard",
+    VideoGallery = "videoGallery"
+}
+export interface CabinetItem {
+    id: string;
+    name: string;
+    iconType?: string;
+}
+export declare class ToolbarItem {
+    static fromData(data: {
+        value: string;
+        label: string;
+        icon: string;
+        category: ToolbarItemCategory;
+        className?: string;
+    }): ToolbarItem;
+    value: string;
+    label: string;
+    icon: string;
+    category: ToolbarItemCategory;
+    className?: string;
+    constructor(icon: string, value: string, label: string, category: ToolbarItemCategory, className?: string);
+}
+export declare enum ScreenShareRoleType {
+    Teacher = "teacher",
+    Student = "student"
+}

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

@@ -0,0 +1,10 @@
+export declare enum OrientationEnum {
+    portrait = "portrait",
+    landscape = "landscape"
+}
+export declare type ConfirmDialogAction = 'ok' | 'cancel';
+export declare enum LayoutMaskCode {
+    None = 0,
+    StageVisible = 1,
+    VideoGalleryVisible = 2
+}

package/lib/infra/stores/common/video-gallery/index.d.ts

@@ -0,0 +1,42 @@
+import { EduUIStoreBase } from '../base';
+import { EduStreamUI } from '../stream/struct';
+export declare class VideoGalleryUIStore extends EduUIStoreBase {
+    private _disposers;
+    private _dialogId?;
+    readonly videoGalleryConfig: {
+        '2x2': number;
+        '3x3': number;
+        '4x4': number;
+    };
+    curPage: number;
+    pageSize: number;
+    loading: boolean;
+    open: boolean;
+    externalOpen: boolean;
+    localPreview: boolean;
+    get localCameraStream(): EduStreamUI | null;
+    get isLocalRendered(): boolean;
+    get stageUserUuids(): string[];
+    get videoGalleryConfigOptions(): {
+        text: string;
+        value: number;
+    }[];
+    get allVideoUserList(): string[];
+    get totalPageNum(): number;
+    get curVideoUserList(): string[];
+    get curStreamList(): EduStreamUI[];
+    nextPage(): void;
+    prevPage(): void;
+    setPageSize(pageSize: number): void;
+    setOpen(open: boolean, id?: string): void;
+    private _updateUsers;
+    openExternalWindow(): void;
+    closeExternalWindow(): void;
+    private _setLoading;
+    private _setCurPage;
+    private _setLocalPreview;
+    private _rtcRawDataCallback;
+    private _sendVideoGalleryState;
+    onInstall(): void;
+    onDestroy(): void;
+}

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

@@ -0,0 +1,40 @@
+import { AgoraCloudClassWidget as AgoraWidgetBase } from 'agora-common-libs';
+import { EduUIStoreBase } from '../base';
+export declare class WidgetUIStore extends EduUIStoreBase {
+    private _disposers;
+    private _registeredWidgets;
+    private _viewportResizeObserver?;
+    private _widgetInstances;
+    private _stateListener;
+    get ready(): boolean;
+    get registeredWidgetNames(): string[];
+    get widgetInstanceList(): AgoraWidgetBase[];
+    get z0Widgets(): AgoraWidgetBase[];
+    get z10Widgets(): AgoraWidgetBase[];
+    createWidget(widgetId: string, defaults?: Record<'properties' | 'userProperties' | 'trackProperties', any>): void;
+    destroyWidget(widgetId: string): void;
+    private _extractWidgetNameId;
+    private _handleWidgetActive;
+    private _handleWidgetInactive;
+    private _handlePropertiesUpdate;
+    private _handleUserPropertiesUpdate;
+    private _handleTrackUpdate;
+    private _callWidgetCreate;
+    private _callWidgetSetInstanceId;
+    private _callWidgetPropertiesUpdate;
+    private _callWidgetUserPropertiesUpdate;
+    private _callWidgetDestroy;
+    private _callWidgetUpdateTrack;
+    private _getWidgetTrackMode;
+    private _callWidgetInstall;
+    private _callWidgetUninstall;
+    private _installWidgets;
+    private _uninstallWidgets;
+    private _handleBecomeActive;
+    private _handleBecomeInactive;
+    private _getEnabledWidgets;
+    private _notifyViewportChange;
+    private _createUiCapable;
+    onInstall(): void;
+    onDestroy(): void;
+}

package/lib/infra/stores/interactive/board.d.ts

@@ -0,0 +1,6 @@
+import { BoardUIStore } from '../common/board';
+export declare class InteractiveBoardUIStore extends BoardUIStore {
+    protected get uiOverrides(): {
+        heightRatio: number;
+    };
+}

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

@@ -0,0 +1,7 @@
+import { EduClassroomStore } from 'agora-edu-core';
+import { EduClassroomUIStore } from '../common';
+import { InteractiveRoomStreamUIStore } from './stream';
+export declare class EduInteractiveUIClassStore extends EduClassroomUIStore {
+    constructor(store: EduClassroomStore);
+    get streamUIStore(): InteractiveRoomStreamUIStore;
+}

package/lib/infra/stores/interactive/stream.d.ts

@@ -0,0 +1,33 @@
+import { StreamUIStore } from '../common/stream';
+import { EduStreamUI } from '../common/stream/struct';
+import { EduStreamTool } from '../common/stream/tool';
+export declare class InteractiveRoomStreamUIStore extends StreamUIStore {
+    private _carouselShowCount;
+    private _gapInPx;
+    carouselPosition: number;
+    get videoStreamSize(): {
+        width: number;
+        height: number;
+    };
+    get carouselStreams(): EduStreamUI[];
+    get teacherCameraStream(): EduStreamUI | undefined;
+    /**
+     * 所有人离开组件区域
+     */
+    localOffAllStreamWindow: () => EduStreamTool;
+    get localStreamTools(): EduStreamTool[];
+    /**
+     * 讲台区域开关
+     */
+    get stageVisible(): boolean;
+    remoteStreamTools: (stream: EduStreamUI) => EduStreamTool[];
+    get gap(): number;
+    get carouselStudentShowCount(): number;
+    carouselNext(): void;
+    carouselPrev(): void;
+    get scrollable(): boolean;
+    get toolbarOffset(): number[];
+    get fullScreenToolbarOffset(): number[];
+    onInstall(): void;
+    onDestroy(): void;
+}

package/lib/infra/stores/lecture/board.d.ts

@@ -0,0 +1,7 @@
+import { BoardUIStore } from '../common/board';
+export declare class LectureBoardUIStore extends BoardUIStore {
+    protected get uiOverrides(): {
+        heightRatio: number;
+    };
+    onInstall(): void;
+}

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

@@ -0,0 +1,9 @@
+import { EduClassroomStore } from 'agora-edu-core';
+import { EduClassroomUIStore } from '../common';
+import { LectureRosterUIStore } from './roster';
+import { LectureRoomStreamUIStore } from './stream';
+export declare class EduLectureUIStore extends EduClassroomUIStore {
+    constructor(store: EduClassroomStore);
+    get streamUIStore(): LectureRoomStreamUIStore;
+    get rosterUIStore(): LectureRosterUIStore;
+}

package/lib/infra/stores/lecture/roster.d.ts

@@ -0,0 +1,57 @@
+import { FetchUserParam, FetchUserType, EduRoleTypeEnum } from 'agora-edu-core';
+import { RosterUIStore } from '../common/roster';
+import { DeviceState, Profile } from '../common/roster/type';
+import { BoardGrantState } from '@classroom/ui-kit';
+export declare class LectureRosterUIStore extends RosterUIStore {
+    get uiOverrides(): {
+        width: number;
+    };
+    /**
+     * 查询下一页的参数
+     */
+    get fetchUsersListParams(): {
+        nextId: string | number | undefined;
+        count: number;
+        type: FetchUserType;
+        role: EduRoleTypeEnum;
+    };
+    /**
+     * 查询下一页的ID
+     */
+    private _usersNextPageId;
+    /**
+     * 分页查询到的用户列表
+     */
+    private _usersList;
+    /**
+     * 获取下一页的用户列表
+     */
+    fetchNextUsersList(override?: Partial<FetchUserParam>, reset?: boolean): void;
+    /**
+     * 重置用户列表及查询条件
+     */
+    resetUsersList(): void;
+    clickKick: (profile: Profile) => void;
+    /**
+     * 用户列表
+     */
+    get userList(): {
+        uid: never;
+        name: never;
+        isOnPodium: boolean;
+        boardGrantState: BoardGrantState;
+        isChatMuted: boolean;
+        cameraState: DeviceState;
+        microphoneState: DeviceState;
+        stars: number;
+        operations: Partial<Record<import("../common/roster/type").Operation, {
+            interactable: boolean;
+        }>>;
+    }[];
+    /**
+     * 是否还有更多用户等待查询
+     */
+    get hasMoreUsers(): boolean;
+    get rosterFunctions(): ("search" | "stars" | "kick" | "podium" | "invite-podium" | "grant-board" | "supervise-student" | "carousel")[];
+    onInstall(): void;
+}

package/lib/infra/stores/lecture/stream.d.ts

@@ -0,0 +1,31 @@
+import { StreamUIStore } from '../common/stream';
+import { EduStreamUI } from '../common/stream/struct';
+import { EduStreamTool } from '../common/stream/tool';
+export declare class LectureRoomStreamUIStore extends StreamUIStore {
+    private _teacherWidthRatio;
+    private _teacherWidthMinPx;
+    private _teacherWidthMaxPx;
+    private _carouselShowCount;
+    private _gapInPx;
+    carouselPosition: number;
+    carouselNext(): void;
+    carouselPrev(): void;
+    get localStreamTools(): EduStreamTool[];
+    get carouselStreams(): EduStreamUI[];
+    remoteStreamTools: (stream: EduStreamUI) => EduStreamTool[];
+    get teacherVideoStreamSize(): {
+        width: number;
+        height: number;
+    };
+    get studentVideoStreamSize(): {
+        width: number;
+        height: number;
+    };
+    get gap(): number;
+    get scrollable(): boolean;
+    get layerItems(): string[];
+    get toolbarPlacement(): 'bottom' | 'left';
+    get toolbarOffset(): number[];
+    get fullScreenToolbarOffset(): number[];
+    onInstall(): void;
+}

package/lib/infra/stores/lecture/toolbar.d.ts

@@ -0,0 +1,11 @@
+import { ToolbarUIStore } from '../common/toolbar';
+import { ToolbarItem } from '../common/toolbar/type';
+export declare class LectrueToolbarUIStore extends ToolbarUIStore {
+    readonly allowedCabinetItems: string[];
+    /**
+     * 老师工具栏工具列表
+     * @returns
+     */
+    get teacherTools(): ToolbarItem[];
+    get studentTools(): ToolbarItem[];
+}