fcr-ui-scene 3.6.1 → 3.6.3

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

@@ -1,9 +1,14 @@
 import { FcrUIDeviceProvider } from './device-provider';
-import { FcrUIDisplayCaptureSource, FcrUIWindowCaptureSource } from '../modules/share-screen/types';
-import { FcrUIDialogProvider } from './dialog-provider';
 import { FcrUIRoomProvider } from './room-provider';
+import { FcrScreenTrack } from 'fcr-core/lib/media-control/type';
+import { AgoraRtcScreenCaptureType } from 'agora-rte-sdk/lib/core/rtc/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';
-interface FcrUIScreenShareObserver {
+export interface FcrUIScreenShareObserver {
     /**
      * 本地屏幕开启采集
      * @returns
@@ -14,75 +19,167 @@ interface FcrUIScreenShareObserver {
      * @returns
      */
     onScreenCaptureStopped?: () => void;
+    /**
+     * 本地屏幕抢占 开始
+     * @returns
+     */
+    onScreenShareReplaceBegin?: (id: string, type: AgoraRtcScreenCaptureType, bounds: CurrentShareBounds) => void;
 }
 export interface FcrUIScreenShareProvider {
     /**
-     * 可共享应用列表
+     * 获取当前屏幕共享是否被锁定
+     * @returns 如果屏幕共享被锁定（仅允许特定用户共享）返回 true，否则返回 false
      */
-    get applicationCaptureSources(): FcrUIWindowCaptureSource[];
+    get shareLock(): boolean;
     /**
-     * 可共享屏幕列表
+     * 设置屏幕共享锁定状态
+     * @param lock - 布尔值，true 表示锁定屏幕共享（仅允许特定用户共享），false 表示解锁
      */
-    get screenCaptureSources(): FcrUIDisplayCaptureSource[];
+    setShareLock(lock: boolean): void;
     /**
-     * 是否正在共享屏幕
+     * 根据指定的选择ID创建屏幕共享流
+     * @param selectionId - 要共享的内容ID（如窗口ID或屏幕ID）
+     * @returns 返回一个Promise，成功时解析为共享流ID，失败时返回undefined
      */
-    get isSharingScreen(): boolean;
+    createScreenShareWithSelectionId(selectionId: string, currentBounds: CurrentShareBounds): Promise<string | undefined>;
     /**
-     * 是否是抢占流
+     * 启动屏幕共享
      */
-    get isSeizeStream(): boolean;
-    get screenSharingOwner(): FcrUserInfo | undefined;
+    bootstrap(): void;
     /**
-     * 设置共享的用户
+     * 关闭屏幕共享
      */
-    set screenSharingOwner(owner: FcrUserInfo | undefined);
+    stop(): void;
     /**
      * 开始屏幕共享
+     * @param id - 要共享的内容ID（如窗口ID或屏幕ID）
+     * @param type - 共享内容的类型（屏幕或窗口）
+     * @param withAudio - 是否同时共享音频
+     * @param isReplace - 是否替换当前已有的共享
+     * @returns 返回一个Promise，成功时解析为屏幕共享轨道对象，失败时返回null
      */
-    startShareScreen(): void;
+    startShareScreen(id: string, type: AgoraRtcScreenCaptureType, withAudio: boolean, isReplace: boolean): Promise<FcrScreenTrack | null>;
     /**
      * 停止屏幕共享
+     * @param targetScreenTrack - 可选参数，要停止的屏幕共享轨道对象，默认停止当前活动的共享
      */
-    stopShareScreen(): void;
+    stopShareScreen(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
     /**
      * 开始白板共享
+     * 此方法将启动白板共享功能，使其他用户可以看到当前用户的白板操作
      */
     startShareWhiteboard(): void;
     /**
      * 停止白板共享
+     * 此方法将停止当前的白板共享，其他用户将无法继续查看白板内容
      */
     stopShareWhiteboard(): 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;
+    /**
+     * 获取正在屏幕共享的用户
+     * @returns FcrUserInfo
+     */
+    getCurrentScreenSharingOwner(): FcrUserInfo | null;
+    /**
+     * 替换当前的屏幕共享内容
+     * @param id - 新的共享内容ID
+     * @param type - 新的共享内容类型
+     * @param withAudio - 是否包含音频
+     * @param bounds - 共享区域的边界信息
+     */
+    replaceScreenShare(id: string, type: AgoraRtcScreenCaptureType, withAudio: boolean, bounds: CurrentShareBounds): 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 _dialogProvider;
+    private _eventProvider;
     private _roomProvider;
+    private _sharingProvider;
+    private _sharedScreenShareSharedDataSource;
+    private _sharedMemberDataSource;
     protected logger: import("agora-foundation/lib/logger").Logger;
+    shareLock: boolean;
+    private _sharingControl?;
+    private _previewDom;
     private _observable;
-    private _controlBarDialogId;
-    private _streamControlObserver;
-    accessor applicationCaptureSources: FcrUIWindowCaptureSource[];
-    accessor screenCaptureSources: FcrUIDisplayCaptureSource[];
-    accessor shareSelectionDialogId: string;
-    accessor isSharingScreen: boolean;
-    accessor isSeizeStream: boolean;
-    accessor screenSharingOwner: FcrUserInfo | undefined;
-    constructor(_deviceProvider: FcrUIDeviceProvider, _dialogProvider: FcrUIDialogProvider, _roomProvider: FcrUIRoomProvider);
-    private _handleStreamAdded;
-    private _handleStreamUpdated;
-    private _handleStreamRemoved;
+    private _streamObserver;
+    private _screenCaptureObserver;
+    private _streamControl?;
+    get shareWithAudio(): boolean;
+    get audioSourceId(): string;
+    constructor(_deviceProvider: FcrUIDeviceProvider, _eventProvider: FcrUIEventProvider, _roomProvider: FcrUIRoomProvider, _sharingProvider: FcrUISharingProvider, _sharedScreenShareSharedDataSource: FcrUIScreenShareSharedDataSource, _sharedMemberDataSource: FcrUIMemberSharedDataSourceImpl);
+    getCurrentScreenSharingOwner(): FcrUserInfo | null;
+    stop(): void;
+    bootstrap(): void;
+    private _handleWebScreenCaptureStateUpdated;
+    private _handleScreenCaptureStateUpdated;
+    private _handleShareStopWithAudio;
+    replaceScreenShare(id: string, type: AgoraRtcScreenCaptureType, withAudio: boolean, bounds: CurrentShareBounds): void;
+    private _setIsReplaceScreen;
+    get isReplaceScreen(): boolean;
+    get localUserId(): string;
+    get shareAudioTrack(): import("fcr-core/lib/media-control/type").FcrLoopbackTrack | null;
+    get loopbackAudioSourceId(): string;
+    get currentShareId(): string;
+    get screenTrack(): FcrScreenTrack | null;
+    get currentShareStreamId(): string;
+    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 _handleStreamPublic;
+    setScreenTrack(screenTrack: FcrScreenTrack | null): void;
     addObserver(observer: FcrUIScreenShareObserver): void;
     removeObserver(observer: FcrUIScreenShareObserver): void;
     startShareWhiteboard(): void;
     stopShareWhiteboard(): void;
     release(): void;
-    startShareScreen(): void;
-    stopShareScreen(): void;
-    private _closeControlBar;
-    private _openShareScreenSelection;
+    startShareScreen(id: string, type: AgoraRtcScreenCaptureType, withAudio: boolean, isReplace: boolean): Promise<FcrScreenTrack | null>;
+    stopShareScreen(targetScreenTrack?: FcrScreenTrack | null | undefined): void;
+    private _handleShareStartWithAudio;
+    toggleScreenshareWithAudio(withAudio: boolean): void;
+    private _getExcludeWindows;
+    removeScreenStream(): boolean;
+    private _screenTrackStop;
 }
-export {};