fcr-ui-scene 3.7.8 → 3.7.9-alpha

package/lib/shared-data-source/screen-share-data.d.ts

@@ -1,364 +0,0 @@
-import { FcrConnectionState, FcrMediaSourceState } from 'fcr-core';
-import { FcrUserInfo } from 'fcr-core/lib/type';
-import { FcrScreenScenarioType } from 'fcr-core/lib/imports';
-import { FcrUIDisplayCaptureSource } from '../modules/share-screen/types';
-import { AudioProcessingChannel } from 'agora-ui-foundation/lib/components/room-screen-share-state-bar/share-audio';
-import { FcrDisplayInfo, FcrWindowInfo, FcrScreenCaptureType } from 'fcr-core/lib/type';
-import { CurrentShareBounds } from '../modules/control-bar/types';
-import { FcrUIConnectionProvider } from '../providers/room-provider';
-import { FcrLoopbackTrack, FcrScreenTrack } from 'fcr-core/lib/media-control/type';
-import { FcrUIDeviceProvider } from '../providers/device-provider';
-import { FcrRemoteVideoStats } from 'fcr-core/lib/room-control/stream-control/type';
-export interface FcrUIScreenShareSharedDataSource {
-    /**
-     * 获取当前屏幕共享的媒体流状态
-     * @returns 当前屏幕共享的媒体流状态，枚举类型 FcrMediaSourceState
-     */
-    get localUserScreenSharingState(): FcrMediaSourceState;
-    /**
-     * 获取可用于应用窗口捕获的源列表
-     * @returns 本地用户可用于应用窗口捕获的源列表，每个元素包含窗口信息
-     */
-    get applicationCaptureSources(): FcrWindowInfo[];
-    /**
-     * 获取可用于屏幕捕获的源列表
-     * @returns 本地用户可用于屏幕捕获的源列表，每个元素包含显示设备信息
-     */
-    get screenCaptureSources(): FcrUIDisplayCaptureSource[];
-    /**
-     * 获取当前屏幕共享的音频处理声道模式
-     * @returns 当前设置的音频声道模式：MONO（单声道）或 STEREO（立体声）
-     */
-    get currentShareAudioProcessingChannel(): AudioProcessingChannel;
-    /**
-     * 获取当前选中的共享内容标识符
-     * @returns 当前选中的共享内容唯一标识符（如窗口ID或屏幕ID）
-     */
-    get currentSelectionId(): string;
-    /**
-     * 获取当前选中的共享内容类型
-     * @returns 当前选中的共享内容类型：SCREEN(1) 表示整个屏幕，WINDOW(2) 表示应用窗口
-     */
-    get currentSelectionType(): FcrScreenCaptureType;
-    /**
-     * 检查当前屏幕共享是否包含音频
-     * @returns 如果屏幕共享包含音频流则返回 true，否则返回 false
-     */
-    get shareWithAudio(): boolean;
-    /**
-     * 获取当前选中的共享区域边界信息
-     * @returns 当前选中的共享区域的位置和尺寸信息
-     */
-    get currentSelectionBounds(): CurrentShareBounds;
-    /**
-     * 获取当前屏幕共享的连接状态
-     * @returns 当前屏幕共享的连接状态，枚举类型 FcrConnectionState
-     */
-    get connectionState(): FcrConnectionState;
-    /**
-     * 获取当前屏幕共享会话的唯一标识符
-     * @returns 当前屏幕共享会话的唯一标识符
-     */
-    get currentShareId(): string;
-    /**
-     * 获取当前屏幕共享内容的类型
-     * @returns 当前屏幕共享内容的类型：SCREEN(1) 或 WINDOW(2)
-     */
-    get currentShareType(): FcrScreenCaptureType;
-    /**
-     * 获取当前屏幕共享流的唯一标识符
-     * @returns 当前屏幕共享流的唯一标识符
-     */
-    get currentShareStreamId(): string;
-    /**
-     * 获取当前屏幕共享的媒体轨道对象
-     * @returns 当前屏幕共享的媒体轨道对象，如果未开始共享则返回 null
-     */
-    get screenTrack(): FcrScreenTrack | null;
-    /**
-     * 异步获取可用的应用窗口列表
-     * @returns 返回一个 Promise，解析为可用的应用窗口信息列表
-     */
-    get appWindowList(): Promise<FcrWindowInfo[]>;
-    /**
-     * 异步获取可用的显示设备列表
-     * @returns 返回一个 Promise，解析为可用的显示设备信息列表
-     */
-    get displayList(): Promise<FcrDisplayInfo[]>;
-    /**
-     * 获取当前环路back音频源的标识符, 用于设置屏幕共享开启共享音频时的音频源
-     * @returns 当前环路back音频源的唯一标识符
-     */
-    get loopbackAudioSourceId(): string | null;
-    /**
-     * 获取当前屏幕共享的音频轨道对象
-     * @returns 当前屏幕共享的音频轨道对象，如果未共享音频则返回 null
-     */
-    get shareWithAudioTrack(): FcrLoopbackTrack | null;
-    /**
-     * 检查当前是否处于抢占屏幕共享状态
-     * @returns 如果正在抢占屏幕共享内容则返回 true，否则返回 false
-     */
-    get isSeizeStream(): boolean;
-    /**
-     * 检查当前是否正在进行屏幕共享
-     * @returns 如果有用户正在进行屏幕共享则返回 true，否则返回 false
-     */
-    get isSharingScreen(): boolean;
-    /**
-     * 获取当前屏幕共享的所有者信息
-     * @returns 当前屏幕共享的所有者用户信息，如果没有正在进行的共享则返回 undefined
-     */
-    get screenSharingOwner(): FcrUserInfo | undefined;
-    /**
-     * 屏幕共享的缩放倍数
-     */
-    get screenShareScalcValue(): number;
-    /**
-     * 屏幕共享的宽高比
-     */
-    get screenShareVideoRatio(): number;
-    /**
-     * 屏幕共享的尺寸
-     */
-    get screenShareVideoSize(): FcrRemoteVideoStats['dimensions'] | null;
-    /**
-     * 屏幕共享的演讲者的节点的尺寸
-     */
-    get screenShareSpeakerViewSize(): {
-        width: number;
-        height: number;
-    };
-    /**
-     * 屏幕共享是否是共享的原尺寸
-     */
-    get isCurrentOriginal(): boolean;
-    /**
-     * 屏幕共享是否已经放大到最大倍数
-     */
-    get isZoomMaxmum(): boolean;
-    /**
-     * 屏幕共享是否已经缩小到最小倍数
-     */
-    get isZoomMinimum(): boolean;
-    /**
-     * 设置屏幕共享的宽高比
-     */
-    setScreenShareVideoRatio(ratio: number): void;
-    /**
-     * 设置屏幕共享的video尺寸
-     */
-    setScreenShareVideoSize(size: FcrRemoteVideoStats['dimensions'] | null): void;
-    /**
-     * 设置屏幕共享的缩放倍数
-     */
-    setScreenShareScalcValue(scalcValue: number): void;
-    /**
-     * 设置当前屏幕共享流是否是抢占流
-     * @param seize - 布尔值, 抢占与否
-     *
-     */
-    /**
-     * 获取当前屏幕共享的清晰策略
-     * @returns AgoraRtcScreenScenarioType，1.是清晰度优先 2.是流畅度优先
-     */
-    get screenShareScenarioType(): FcrScreenScenarioType;
-    /**
-     * 获取当前屏幕共享是否是流畅度优先策略
-     * @returns boolean
-     */
-    get isCurrentScreenShareInSmoothType(): boolean;
-    /**
-     * 获取当前是否在屏幕共享替换中状态
-     * @returns boolean
-     */
-    get sharingInReplace(): boolean;
-    /**
-     * 获取当前engine是否是连接状态
-     * @returns boolean
-     */
-    get isEngineConnected(): boolean;
-    /**
-     * 设置当前是否在屏幕共享替换中状态
-     */
-    setSharingInReplace(isInReplace: boolean): void;
-    setScreenShareScenarioType(type: FcrScreenScenarioType): void;
-    setIsSeizeStream(seize: boolean): void;
-    /**
-     * 设置当前是否正在进行屏幕共享的状态
-     * @param isSharing - 布尔值，表示是否正在进行屏幕共享
-     */
-    setIsSharingScreen(isSharing: boolean): void;
-    /**
-     * 设置当前屏幕共享的所有者信息
-     * @param owner - 用户信息对象，表示屏幕共享的所有者，传入 undefined 表示停止共享
-     */
-    setScreenSharingOwner(owner: FcrUserInfo | undefined): void;
-    /**
-     * 设置当前屏幕共享的音频轨道
-     * @param shareAudioTrack - 音频轨道对象，表示屏幕共享的音频轨道，传入 null 表示不共享音频
-     */
-    setShareWithAudioTrack(shareWithAudioTrack: FcrLoopbackTrack | null): void;
-    /**
-     * 设置当前环路back音频源的标识符
-     * @param sourceId - 音频源的唯一标识符
-     */
-    setLoopbackAudioSourceId(sourceId: string): void;
-    /**
-     * 设置当前屏幕共享的媒体轨道
-     * @param screenTrack - 屏幕共享的媒体轨道对象，传入 null 表示停止共享屏幕
-     */
-    setScreenTrack(screenTrack: FcrScreenTrack | null): void;
-    /**
-     * 设置当前屏幕共享会话的唯一标识符
-     * @param id - 屏幕共享会话的唯一标识符
-     */
-    setCurrentShareId(id: string): void;
-    /**
-     * 设置当前屏幕共享内容的类型
-     * @param type - 屏幕共享内容的类型：SCREEN(1) 或 WINDOW(2)
-     */
-    setCurrentShareType(type: FcrScreenCaptureType): void;
-    /**
-     * 设置当前屏幕共享流的唯一标识符
-     * @param streamId - 屏幕共享流的唯一标识符
-     */
-    setCurrentShareStreamId(streamId: string): void;
-    /**
-     * 设置屏幕共享是否包含音频
-     * @param status - 布尔值，表示是否在屏幕共享中包含音频
-     */
-    setShareWithAudio(status: boolean): void;
-    /**
-     * 设置当前选中的共享内容标识符
-     * @param id - 共享内容的唯一标识符（如窗口ID或屏幕ID）
-     */
-    setCurrentSelectionId(id: string): void;
-    /**
-     * 设置当前选中的共享内容类型
-     * @param type - 共享内容的类型：SCREEN(1) 或 WINDOW(2)
-     */
-    setCurrentSelectionType(type: FcrScreenCaptureType): void;
-    /**
-     * 设置当前选中的共享区域边界信息
-     * @param bounds - 共享区域的位置和尺寸信息
-     */
-    setCurrentSelectionBounds(bounds: CurrentShareBounds): void;
-    /**
-     * 一次性设置当前选中的共享内容信息
-     * @param id - 共享内容的唯一标识符
-     * @param type - 共享内容的类型
-     * @param bounds - 共享区域的边界信息
-     */
-    setCurrentSelection(id: string, type: FcrScreenCaptureType, bounds?: CurrentShareBounds): void;
-    /**
-     * 设置当前屏幕共享的完整信息
-     * @param id - 共享会话的唯一标识符
-     * @param type - 共享内容的类型
-     * @param bounds - 共享区域的边界信息
-     */
-    setCurrentShareIdInfos(id: string, type: FcrScreenCaptureType, bounds: CurrentShareBounds): void;
-    /**
-     * 设置当前屏幕共享的媒体流状态
-     * @param state - 屏幕共享的媒体流状态，枚举类型 FcrMediaSourceState
-     */
-    setLocalUserScreenSharingState(state: FcrMediaSourceState): void;
-    /**
-     * 设置可用的应用窗口捕获源列表
-     * @param windowInfos - 应用窗口信息列表
-     */
-    setApplicationCaptureSources(windowInfos: FcrWindowInfo[]): void;
-    /**
-     * 设置可用的屏幕捕获源列表
-     * @param sources - 屏幕捕获源信息列表
-     */
-    setScreenCaptureSources(sources: FcrUIDisplayCaptureSource[]): void;
-    /**
-     * 设置当前屏幕共享的音频处理声道模式
-     * @param channel - 音频声道模式：MONO（单声道）或 STEREO（立体声）
-     */
-    setCurrentShareAudioProcessingChannel(channel: AudioProcessingChannel): void;
-    /**
-     * 保存当前屏幕共享speakerView节点的宽高
-     */
-    setScreenShareSpeakerViewSize(width: number, height: number): void;
-    /**
-     * 释放屏幕共享相关资源
-     * 清理所有订阅和资源，通常在组件卸载时调用
-     */
-    release(): void;
-}
-export declare class FcrUIScreenShareSharedDataSourceImpl implements FcrUIScreenShareSharedDataSource {
-    private _connectionProvider;
-    private _deviceProvider;
-    protected logger: import("agora-foundation/lib/logger").Logger;
-    private _disposers;
-    private _connectionObserver;
-    accessor isSharingScreen: boolean;
-    accessor screenSharingOwner: FcrUserInfo | undefined;
-    accessor localUserScreenSharingState: FcrMediaSourceState;
-    accessor applicationCaptureSources: FcrWindowInfo[];
-    accessor screenCaptureSources: FcrUIDisplayCaptureSource[];
-    accessor currentShareAudioProcessingChannel: AudioProcessingChannel;
-    accessor currentSelectionId: string;
-    accessor currentSelectionType: FcrScreenCaptureType;
-    accessor shareWithAudio: boolean;
-    accessor boardOwnerUser: FcrUserInfo | undefined;
-    accessor currentSelectionBounds: CurrentShareBounds;
-    accessor connectionState: FcrConnectionState;
-    accessor isSeizeStream: boolean;
-    accessor screenShareScalcValue: number;
-    accessor screenShareVideoRatio: number;
-    accessor screenShareVideoSize: FcrRemoteVideoStats['dimensions'] | null;
-    accessor screenShareSpeakerViewSize: {
-        width: number;
-        height: number;
-    };
-    private _maxScalcValue;
-    private _minScalcValue;
-    accessor screenShareScenarioType: FcrScreenScenarioType;
-    accessor isCurrentScreenShareInSmoothType: boolean;
-    accessor sharingInReplace: boolean;
-    screenTrack: FcrScreenTrack | null;
-    shareWithAudioTrack: FcrLoopbackTrack | null;
-    currentShareId: string;
-    currentShareType: FcrScreenCaptureType;
-    currentShareStreamId: string;
-    loopbackAudioSourceId: string | null;
-    get appWindowList(): Promise<import("fcr-core/lib/imports").AgoraRtcWindowInfo[]>;
-    get displayList(): Promise<import("fcr-core/lib/imports").AgoraRtcDisplayInfo[]>;
-    get isZoomMaxmum(): boolean;
-    get isZoomMinimum(): boolean;
-    get isFullScreenAdaptived(): boolean;
-    get isCurrentOriginal(): boolean;
-    get isEngineConnected(): boolean;
-    constructor(_connectionProvider: FcrUIConnectionProvider, _deviceProvider: FcrUIDeviceProvider);
-    setScreenShareScenarioType(type: FcrScreenScenarioType): void;
-    setScreenShareSpeakerViewSize(width: number, height: number): void;
-    setScreenShareVideoRatio(ratio: number): void;
-    setScreenShareVideoSize(size: FcrRemoteVideoStats['dimensions'] | null): void;
-    setScreenShareScalcValue(scalcValue: number): void;
-    setIsSeizeStream(seized: boolean): void;
-    setIsSharingScreen(isSharing: boolean): void;
-    setSharingInReplace(isInReplace: boolean): void;
-    setScreenSharingOwner(owner: FcrUserInfo | undefined): void;
-    setShareWithAudioTrack(shareWithAudioTrack: FcrLoopbackTrack | null): void;
-    setLoopbackAudioSourceId(sourceId: string): void;
-    setScreenTrack(screenTrack: FcrScreenTrack | null): void;
-    setCurrentShareType(type: FcrScreenCaptureType): void;
-    setCurrentShareId(id: string): void;
-    setCurrentShareStreamId(streamId: string): void;
-    setCurrentShareAudioProcessingChannel(channel: AudioProcessingChannel): void;
-    setScreenCaptureSources(sources: FcrUIDisplayCaptureSource[]): void;
-    setApplicationCaptureSources(windowInfos: FcrWindowInfo[]): void;
-    setLocalUserScreenSharingState(state: FcrMediaSourceState): void;
-    setCurrentShareIdInfos(currentShareId: string, type: FcrScreenCaptureType, bounds: CurrentShareBounds): void;
-    setCurrentSelection(id: string, type: FcrScreenCaptureType, bounds?: CurrentShareBounds): void;
-    setCurrentSelectionId(id: string): void;
-    setCurrentSelectionType(type: FcrScreenCaptureType): void;
-    setCurrentSelectionBounds(bounds: CurrentShareBounds): void;
-    setShareWithAudio(withAudio: boolean): void;
-    release(): void;
-    private _handleOnConnectionStateUpdated;
-    private _setLoopbackAudioSourceId;
-}