fcr-ui-scene 3.7.7 → 3.7.8-rc.2

package/lib/providers/screen-share-provider.d.ts

@@ -1,245 +0,0 @@
-import { FcrUIDeviceProvider } from './device-provider';
-import { FcrUIRoomProvider } from './room-provider';
-import { FcrScreenScenarioType } from 'fcr-core/lib/imports';
-import { FcrScreenTrack } from 'fcr-core/lib/media-control/type';
-import { FcrScreenCaptureType } from 'fcr-core/lib/type';
-import { FcrUISharingProvider } from './sharing-provider';
-import { FcrUIScreenShareSharedDataSource } from '../shared-data-source/screen-share-data';
-import { FcrUIEventProvider } from './event-provider';
-import { FcrUIMemberSharedDataSourceImpl } from '../shared-data-source/member-data';
-import { CurrentShareBounds } from '../modules/control-bar/types';
-import { FcrUserInfo } from 'fcr-core/lib/type';
-import { FcrUIPrivilegeProvider } from './privilege-provider';
-export interface FcrUIScreenShareObserver {
-    /**
-     * 本地屏幕开启采集
-     * @returns
-     */
-    onScreenCaptureStarted?: () => void;
-    /**
-     * 本地屏幕停止采集
-     * @returns
-     */
-    onScreenCaptureStopped?: () => void;
-    /**
-     * 本地屏幕替换开始
-     * @returns
-     */
-    onScreenShareReplaceBegin?: (id: string, type: FcrScreenCaptureType, bounds: CurrentShareBounds) => void;
-    /**
-     * 本地屏幕替换开始
-     * @returns
-     */
-    onScreenShareSeize?: () => void;
-}
-export interface FcrUIScreenShareProvider {
-    /**
-     * 获取当前屏幕共享是否被锁定
-     * @returns 如果屏幕共享被锁定（仅允许特定用户共享）返回 true，否则返回 false
-     */
-    get shareLock(): boolean;
-    /** 获取当前屏幕共享是否已等比缩放
-     * @returns 返回 true，否则返回 false
-     */
-    get isAspectRatioPreserved(): boolean;
-    /**
-     * 获取正在屏幕共享的用户
-     * @returns FcrUserInfo
-     */
-    get currentScreenSharingOwner(): FcrUserInfo | null;
-    /**
-     * 判断正在屏幕共享的用户是否是当前用户
-     * @returns FcrUserInfo
-     */
-    get currentScreenSharingOwnerIsMySelf(): boolean;
-    /**
-     * 设置单词屏幕共享的流程状态
-     * @param isInReplace - 布尔值，true 表示开始，false 表示已结束
-     */
-    setSharingInReplace(isInReplace: boolean): void;
-    /**
-     * 设置屏幕共享锁定状态
-     * @param lock - 布尔值，true 表示锁定屏幕共享（仅允许特定用户共享），false 表示解锁
-     */
-    setShareLock(lock: boolean): void;
-    /**
-     * 根据指定的选择ID创建屏幕共享流
-     * @param selectionId - 要共享的内容ID（如窗口ID或屏幕ID）
-     * @returns 返回一个Promise，成功时解析为共享流ID，失败时返回undefined
-     */
-    createScreenShareWithSelectionId(selectionId: string, currentBounds: CurrentShareBounds): Promise<string | undefined>;
-    /**
-     * 启动屏幕共享
-     */
-    bootstrap(): void;
-    /**
-     * 关闭屏幕共享
-     */
-    stop(): void;
-    /**
-     * 开始屏幕共享
-     * @param id - 要共享的内容ID（如窗口ID或屏幕ID）
-     * @param type - 共享内容的类型（屏幕或窗口）
-     * @param withAudio - 是否同时共享音频
-     * @param isReplace - 是否替换当前已有的共享
-     * @returns 返回一个Promise，成功时解析为屏幕共享轨道对象，失败时返回null
-     */
-    startShareScreen(id: string, type: FcrScreenCaptureType, withAudio: boolean, isReplace: boolean): Promise<void>;
-    /**
-     * 停止屏幕共享
-     * @param targetScreenTrack - 可选参数，要停止的屏幕共享轨道对象，默认停止当前活动的共享
-     */
-    stopShareScreen(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    /**
-     * 停止屏幕共享，用于离开房间
-     * @param targetScreenTrack - 可选参数，要移除的屏幕共享轨道对象，默认移除当前活动的轨道
-     * @returns 如果成功移除返回 true，否则返回 false
-     */
-    stopShareScreenByExitRoom(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    /**
-     * 开始白板共享
-     * 此方法将启动白板共享功能，使其他用户可以看到当前用户的白板操作
-     */
-    startShareWhiteboard(): void;
-    /**
-     * 开始渲染屏幕共享预览画面
-     * @param dom - 用于渲染预览画面的DOM元素
-     * @param targetScreenTrack - 可选参数，要渲染预览的屏幕共享轨道对象，默认使用当前活动的轨道
-     */
-    startRenderSharePreview(dom: HTMLElement, targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    /**
-     * 停止渲染屏幕共享预览画面
-     * @param targetScreenTrack - 可选参数，要停止渲染预览的屏幕共享轨道对象，默认使用当前活动的轨道
-     */
-    stopRenderSharePreview(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    /**
-     * 切换屏幕共享的音频状态
-     * @param withAudio - 布尔值，true 表示启用音频共享，false 表示禁用
-     */
-    toggleScreenshareWithAudio(withAudio: boolean): void;
-    /**
-     * 手动移除屏幕共享流
-     * @param targetScreenTrack - 可选参数，要移除的屏幕共享轨道对象，默认移除当前活动的轨道
-     * @returns 如果成功移除返回 true，否则返回 false
-     */
-    removeScreenStream(targetScreenTrack?: FcrScreenTrack | null | undefined): boolean;
-    /**
-     * 替换当前的屏幕共享内容
-     * @param id - 新的共享内容ID
-     * @param type - 新的共享内容类型
-     * @param withAudio - 是否包含音频
-     * @param bounds - 共享区域的边界信息
-     */
-    replaceScreenShare(id: string, type: FcrScreenCaptureType, withAudio: boolean, bounds: CurrentShareBounds): void;
-    /**
-     * 屏幕共享缩小窗口
-     */
-    zoomIn(): void;
-    /**
-     * 屏幕共享放大窗口
-     */
-    zoomOut(): void;
-    /**
-     * 接收端方法，用于设置标注窗口的缩放比例
-     */
-    fullContainer(): void;
-    /**
-     * 接收端方法，用于设置标注窗口的缩放比例
-     */
-    setOriginScalc(): void;
-    /**
-     * 添加屏幕共享事件观察者
-     * @param observer - 实现了 FcrUIScreenShareObserver 接口的观察者对象
-     */
-    addObserver(observer: FcrUIScreenShareObserver): void;
-    /**
-     * 移除屏幕共享事件观察者
-     * @param observer - 要移除的观察者对象
-     */
-    removeObserver(observer: FcrUIScreenShareObserver): void;
-    /**
-     * 释放屏幕共享提供者资源
-     * 清理所有订阅和资源，通常在组件卸载时调用
-     */
-    release(): void;
-}
-export declare class FcrUIScreenShareProviderImpl implements FcrUIScreenShareProvider {
-    private _deviceProvider;
-    private _eventProvider;
-    private _roomProvider;
-    private _sharingProvider;
-    private _sharedScreenShareSharedDataSource;
-    private _sharedMemberDataSource;
-    private _privilegeProvider;
-    protected logger: import("agora-foundation/lib/logger").Logger;
-    shareLock: boolean;
-    private _sharingControl;
-    private _previewDom;
-    private _prevFullScalc;
-    private _observable;
-    private _streamObserver;
-    private _screenCaptureObserver;
-    private _streamControl;
-    private _maxScalcValue;
-    private _minScalcValue;
-    private _diffScalcValue;
-    private _hasStop;
-    private _isReplaceScreen;
-    get shareWithAudio(): boolean;
-    get audioSourceId(): string;
-    get screenShareScalcValue(): number;
-    get screenShareVideoRatio(): number;
-    get screenShareSpeakerViewSize(): {
-        width: number;
-        height: number;
-    };
-    get screenShareScenarioType(): FcrScreenScenarioType;
-    private get _currentRoomControl();
-    constructor(_deviceProvider: FcrUIDeviceProvider, _eventProvider: FcrUIEventProvider, _roomProvider: FcrUIRoomProvider, _sharingProvider: FcrUISharingProvider, _sharedScreenShareSharedDataSource: FcrUIScreenShareSharedDataSource, _sharedMemberDataSource: FcrUIMemberSharedDataSourceImpl, _privilegeProvider: FcrUIPrivilegeProvider);
-    setSharingInReplace(isInReplace: boolean): void;
-    zoomOut(): void;
-    zoomIn(): void;
-    fullContainer(): void;
-    get isAspectRatioPreserved(): boolean;
-    setOriginScalc(): void;
-    get currentScreenSharingOwner(): FcrUserInfo | null;
-    get currentScreenSharingOwnerIsMySelf(): boolean;
-    stop(): void;
-    bootstrap(): void;
-    private _handleWebScreenCaptureStateUpdated;
-    private _handleScreenCaptureStateUpdated;
-    replaceScreenShare(id: string, type: FcrScreenCaptureType, withAudio: boolean, bounds: CurrentShareBounds): void;
-    private _handleRemoteVideoStatsUpdated;
-    get localUserId(): string;
-    get shareAudioTrack(): import("fcr-core/lib/media-control/type").FcrLoopbackTrack | null;
-    get currentShareId(): string;
-    get screenTrack(): FcrScreenTrack | null;
-    get currentShareStreamId(): string | undefined;
-    get currentSelectionBounds(): CurrentShareBounds;
-    setShareLock(lock: boolean): void;
-    createScreenShareWithSelectionId(videoSourceId: string, bounds: CurrentShareBounds): Promise<string>;
-    private _isStoppedFor;
-    private _addEventListeners;
-    private _removeEventListeners;
-    private _syncShareStreamState;
-    private _handleStreamUpdate;
-    startRenderSharePreview(dom: HTMLElement, targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    stopRenderSharePreview(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    private _syncScreenShareStreamInfos;
-    setScreenTrack(screenTrack: FcrScreenTrack | null): void;
-    addObserver(observer: FcrUIScreenShareObserver): void;
-    removeObserver(observer: FcrUIScreenShareObserver): void;
-    startShareWhiteboard(): void;
-    release(): void;
-    startShareScreen(id: string, type: FcrScreenCaptureType, withAudio: boolean, isReplace: boolean): Promise<void>;
-    stopShareScreen(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    stopShareScreenByExitRoom(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
-    private _updateShareAudioPrivilege;
-    private _handleShareStopWithAudio;
-    private _handleShareStartWithAudio;
-    toggleScreenshareWithAudio(withAudio: boolean): void;
-    private _getExcludeWindows;
-    removeScreenStream(): boolean;
-    private _stopScreenTrack;
-    private _cleanShareWithAudioDataSource;
-}