fcr-ui-scene 1.0.20 → 3.1.0

package/lib/modules/layout/type.d.ts

@@ -0,0 +1,64 @@
+import { FcrUserRole, FcrRoomConnectorType, FcrVideoSourceType } from 'agora-edu-core/lib/type';
+export declare enum FcrUIVideoWindowLayoutType {
+    /** Show a carousel on top and a big video on the rest of the screen. */
+    Speaker = "speaker",
+    /** Show videos in grid, filling the screen. */
+    Gallery = "gallery"
+}
+export declare enum GalleryMaxSize {
+    Normal = 16,
+    Large = 25
+}
+export interface FcrUIVideoWindowData {
+    windowId: string;
+    type: FcrUIWindowType;
+    videoStreamId?: string;
+    audioStreamId?: string;
+    hasMicrophoneAudioStream: boolean;
+    hasLoopbackAudioStream: boolean;
+    hasVideoStream: boolean;
+    hasScreenSharing: boolean;
+    audioStreamConnectorType: FcrRoomConnectorType;
+    videoStreamConnectorType: FcrRoomConnectorType;
+    userId: string;
+    userName: string;
+    isMySelf: boolean;
+    isPin: boolean;
+    isSpeakerSpotlight: boolean;
+    videoSourceType: FcrVideoSourceType;
+    ownerRoleType: FcrUserRole;
+    sortingPriority: number;
+    phoneMicEnabled?: boolean;
+}
+export declare const VideoRatio: number;
+export declare enum FcrUIVideoWindowMainSortingPriority {
+    NONE = 0,
+    MICROPHONE_OPEN = 1,
+    CAMERA_OPEN = 2,
+    BOTH_OPEN = 3,
+    CO_HOST = 4,
+    MYSELF = 5,
+    HOST = 6,
+    SCREEN_SHARING_OWNER = 7,
+    SPEAKER_SPOTLIGHT = 8,
+    FOCUS = 9,
+    HIGHEST = 10
+}
+export declare enum FcrUIVideoWindowFoldSortingPriority {
+    NONE = 0,
+    MICROPHONE_OPEN = 1,
+    CAMERA_OPEN = 2,
+    BOTH_OPEN = 3,
+    CO_HOST = 4,
+    MYSELF = 5,
+    HOST = 6,
+    SCREEN_SHARING_OWNER = 7,
+    SCREEN_SHARING_STREAM = 8,
+    PIN = 9,
+    FOCUS = 10,
+    HIGHEST = 11
+}
+export declare enum FcrUIWindowType {
+    VIDEO = 1,
+    BOARD = 2
+}

package/lib/modules/layout/type.js

@@ -0,0 +1,52 @@
+"use strict";
+
+require("core-js/modules/es.object.define-property.js");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.VideoRatio = exports.GalleryMaxSize = exports.FcrUIWindowType = exports.FcrUIVideoWindowMainSortingPriority = exports.FcrUIVideoWindowLayoutType = exports.FcrUIVideoWindowFoldSortingPriority = void 0;
+var FcrUIVideoWindowLayoutType = exports.FcrUIVideoWindowLayoutType = /*#__PURE__*/function (FcrUIVideoWindowLayoutType) {
+  FcrUIVideoWindowLayoutType["Speaker"] = "speaker";
+  FcrUIVideoWindowLayoutType["Gallery"] = "gallery";
+  return FcrUIVideoWindowLayoutType;
+}({});
+var GalleryMaxSize = exports.GalleryMaxSize = /*#__PURE__*/function (GalleryMaxSize) {
+  GalleryMaxSize[GalleryMaxSize["Normal"] = 16] = "Normal";
+  GalleryMaxSize[GalleryMaxSize["Large"] = 25] = "Large";
+  return GalleryMaxSize;
+}({});
+var VideoRatio = exports.VideoRatio = 19 / 32;
+var FcrUIVideoWindowMainSortingPriority = exports.FcrUIVideoWindowMainSortingPriority = /*#__PURE__*/function (FcrUIVideoWindowMainSortingPriority) {
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["NONE"] = 0] = "NONE";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["MICROPHONE_OPEN"] = 1] = "MICROPHONE_OPEN";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["CAMERA_OPEN"] = 2] = "CAMERA_OPEN";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["BOTH_OPEN"] = 3] = "BOTH_OPEN";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["CO_HOST"] = 4] = "CO_HOST";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["MYSELF"] = 5] = "MYSELF";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["HOST"] = 6] = "HOST";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["SCREEN_SHARING_OWNER"] = 7] = "SCREEN_SHARING_OWNER";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["SPEAKER_SPOTLIGHT"] = 8] = "SPEAKER_SPOTLIGHT";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["FOCUS"] = 9] = "FOCUS";
+  FcrUIVideoWindowMainSortingPriority[FcrUIVideoWindowMainSortingPriority["HIGHEST"] = 10] = "HIGHEST";
+  return FcrUIVideoWindowMainSortingPriority;
+}({});
+var FcrUIVideoWindowFoldSortingPriority = exports.FcrUIVideoWindowFoldSortingPriority = /*#__PURE__*/function (FcrUIVideoWindowFoldSortingPriority) {
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["NONE"] = 0] = "NONE";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["MICROPHONE_OPEN"] = 1] = "MICROPHONE_OPEN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["CAMERA_OPEN"] = 2] = "CAMERA_OPEN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["BOTH_OPEN"] = 3] = "BOTH_OPEN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["CO_HOST"] = 4] = "CO_HOST";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["MYSELF"] = 5] = "MYSELF";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["HOST"] = 6] = "HOST";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["SCREEN_SHARING_OWNER"] = 7] = "SCREEN_SHARING_OWNER";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["SCREEN_SHARING_STREAM"] = 8] = "SCREEN_SHARING_STREAM";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["PIN"] = 9] = "PIN";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["FOCUS"] = 10] = "FOCUS";
+  FcrUIVideoWindowFoldSortingPriority[FcrUIVideoWindowFoldSortingPriority["HIGHEST"] = 11] = "HIGHEST";
+  return FcrUIVideoWindowFoldSortingPriority;
+}({});
+var FcrUIWindowType = exports.FcrUIWindowType = /*#__PURE__*/function (FcrUIWindowType) {
+  FcrUIWindowType[FcrUIWindowType["VIDEO"] = 1] = "VIDEO";
+  FcrUIWindowType[FcrUIWindowType["BOARD"] = 2] = "BOARD";
+  return FcrUIWindowType;
+}({});

package/lib/modules/layout/video-window-datasource.d.ts

@@ -0,0 +1,119 @@
+import { FcrUIVideoWindowData, FcrUIVideoWindowFoldSortingPriority, FcrUIVideoWindowLayoutType, FcrUIVideoWindowMainSortingPriority, FcrUIWindowType } from './type';
+import { FcrRoomConnectorType, FcrStreamInfo, FcrUserInfo, FcrUserRole } from 'agora-edu-core/lib/type';
+import { AgoraRtcVideoSourceType } from 'agora-rte-sdk/lib/core/rtc/type';
+export declare class FcrUIVideoWindowDataImpl implements FcrUIVideoWindowData {
+    private _placement;
+    private _isMySelf;
+    private _boardUserInfo?;
+    private _layoutType;
+    private accessor _videoStream;
+    private accessor _audioStream;
+    private accessor _spotlightEnabled;
+    private accessor _isSpeakerSpotlight;
+    private accessor _boardCanEdit;
+    needToSort: boolean;
+    type: FcrUIWindowType;
+    accessor isPin: boolean;
+    accessor hasScreenSharing: boolean;
+    get isSpeakerSpotlight(): boolean;
+    get windowId(): string;
+    get videoStreamId(): string | undefined;
+    get audioStreamId(): string | undefined;
+    get audioStreamConnectorType(): FcrRoomConnectorType;
+    get videoStreamConnectorType(): FcrRoomConnectorType;
+    get hasMicrophoneAudioStream(): boolean;
+    get phoneMicEnabled(): boolean;
+    get hasVideoStream(): boolean;
+    get hasLoopbackAudioStream(): boolean;
+    get userId(): string;
+    get userName(): string;
+    get ownerRoleType(): FcrUserRole;
+    get videoSourceType(): AgoraRtcVideoSourceType;
+    get isMySelf(): boolean;
+    get sortingPriority(): FcrUIVideoWindowMainSortingPriority | FcrUIVideoWindowFoldSortingPriority;
+    constructor(type: FcrUIWindowType, { videoStream, audioStream, boardUserInfo, }: {
+        videoStream?: FcrStreamInfo;
+        audioStream?: FcrStreamInfo;
+        boardUserInfo?: FcrUserInfo;
+    }, _placement: 'main-list' | 'fold-list', _isMySelf: boolean, layoutType: FcrUIVideoWindowLayoutType | undefined, spotlightEnabled: boolean, canEdit?: boolean);
+    setLayoutType(layoutType: FcrUIVideoWindowLayoutType): void;
+    setVideoStream(videoStream: FcrStreamInfo | undefined): void;
+    setVideoStreamOwnerInfo(userInfo: FcrUserInfo): void;
+    setAudioStream(audioStream: FcrStreamInfo | undefined): void;
+    setAudioStreamOwnerInfo(userInfo: FcrUserInfo): void;
+    setPin(pin: boolean): void;
+    setSpotlightEnabled(enabled: boolean): void;
+    setSpeakerSpotlight(speakerSpotlight: boolean): void;
+    setHasScreenSharing(screenSharing: boolean): void;
+    setBoardCanEdit(canEdit: boolean): void;
+}
+export interface FcrUIVideoWindowDataSourceObserver {
+    onLayoutUpdated: (layout: FcrUIVideoWindowLayoutType) => void;
+    onMainListAdded: (index: number) => void;
+    onMainListUpdated: (index: number) => void;
+    onMainListRemoved: (index: number) => void;
+    onFoldListAdded: (index: number) => void;
+    onFoldListUpdated: (index: number) => void;
+    onFoldListRemoved: (index: number) => void;
+    onSpotlightAdded: (streamId: string) => void;
+    onSpotlightRemoved: (streamId: string) => void;
+}
+export declare class FcrUIVideoWindowDataSource {
+    private _observer;
+    private _spotlightPool;
+    accessor spotlightEnabled: boolean;
+    accessor layoutType: FcrUIVideoWindowLayoutType;
+    accessor pinLimitedCount: number;
+    accessor mainListLimitedCount: number;
+    accessor foldListLimitedCount: number;
+    accessor mainList: FcrUIVideoWindowDataImpl[];
+    accessor foldList: FcrUIVideoWindowDataImpl[];
+    constructor();
+    setSpotlightEnabled(enabled: boolean): void;
+    setLayout(layout: FcrUIVideoWindowLayoutType): void;
+    onSpotlightRemoved(streamId: string): void;
+    resetList(): void;
+    addBoard(userInfo: FcrUserInfo, isMySelf: boolean, canEdit?: boolean): void;
+    updateBoard(canEdit: boolean): void;
+    removeBoard(): void;
+    private _mergePstnStreamOrInsertNewData;
+    add(stream: FcrStreamInfo, isMySelf: boolean): void;
+    update(stream: FcrStreamInfo): void;
+    update(user: FcrUserInfo): void;
+    delete(stream: FcrStreamInfo): void;
+    addPin(streamId: string): boolean;
+    removePin(streamId: string): true | undefined;
+    setSpeakerSpotlight(streamId: string): void;
+    toggleMainStream(windowId: string): boolean;
+    clearSpeakerSpotlight(): void;
+    addObserver(observer: Partial<FcrUIVideoWindowDataSourceObserver>): void;
+    removeObserver(observer: Partial<FcrUIVideoWindowDataSourceObserver>): void;
+    private _syncHasScreenSharing;
+    private _insertByPriority;
+    private _insertBeginningByPriority;
+    private _insertEndByPriority;
+    private _findInsertBeginningIndex;
+    private _findInsertEndIndex;
+    private _findItemIndexWithWindowId;
+    private _findItemIndexWithUserId;
+    private _findItemIndexWithAudioStreamId;
+    private _insertBoard;
+    private _insertNewData;
+}
+export declare class FcrUISpeakerSpotlightPool {
+    streams: Map<string, number>;
+    limitCount: number;
+    duration: number;
+    private _timer;
+    private _observer;
+    constructor();
+    add(streamId: string): boolean;
+    private _scan;
+    clear(): void;
+    addObserver(observer: {
+        onRemoved: (streamId: string) => void;
+    }): void;
+    removeObserver(observer: {
+        onRemoved: (streamId: string) => void;
+    }): void;
+}