@tencentcloud/tuiroom-engine-js 1.6.1-beta.0 → 1.7.0

package/index.d.ts

@@ -269,30 +269,23 @@ declare class TUIRoomEngine {
         userId: string;
     }): Promise<any>;
     /**
-     * 设置本地流的渲染位置
-     * @param {object} options 设置本地流的渲染位置的参数
-     * @param {TUIVideoStreamType} options.streamType 本地流类型
-     * @param {string | Array<string>} options.view streamType 对应的流渲染的 div 元素的 id
+     * 设置本地视频流的渲染位置
+     * @param {object} options 设置本地视频流的渲染位置的参数
+     * @param {string | Array<string>} options.view 本地视频流的渲染位置
      * @returns {Promise<void>}
+     * @desc 自 v1.6.1 版本起，setLocalVideoView 不再需要传入 streamType 参数
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
      *
      * // 设置本地摄像头流的播放区域为 id 是 'preview-camera' 的 div 元素
      * roomEngine.setLocalVideoView({
-     *  streamType: TUIVideoStreamType.kCameraStream,
      *  view: 'preview-camera',
      * });
-     *
-     * // 设置本地屏幕分享流的播放区域为 id 是 'preview-screen' 的 div 元素
-     * roomEngine.setLocalVideoView({
-     *  streamType: TUIVideoStreamType.kScreenStream,
-     *  view: 'preview-screen',
-     * });
      */
     setLocalVideoView(options: {
-        streamType: TUIVideoStreamType;
         view: string | Array<string>;
+        streamType?: TUIVideoStreamType;
     }): void;
     /**
      * 打开本地摄像头，开始视频流采集
@@ -1018,22 +1011,21 @@ declare class TUIRoomEngine {
      * 开始屏幕共享
      * @param {object=} options
      * @param {boolean=} [options.screenAudio=false] web 端屏幕共享是否可选共享系统声音, screenAudio 默认值为 false
+     * @param {string=} options.view 非必填，本地预览屏幕分享的 dom 元素的 id
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * // 设置本地屏幕分享流的播放区域为 id 是 'preview-screen' 的 div 元素, 可以不设置
-     * await roomEngine.setLocalRenderView({
-     *  streamType: TUIVideoStreamType.kScreenStream,
-     *  view: 'preview-screen',
-     * });
      * // example 1: 开始屏幕分享
      * await roomEngine.startScreenSharing();
      * // example 2: 开始屏幕分享(可采集系统音频)
      * await roomEngine.startScreenSharing({ screenAudio: true });
+     * // example 3: 开始屏幕分享并在本地预览
+     * await roomEngine.startScreenSharing({ view: 'screen-preview' });
      */
     startScreenSharing(options?: {
         screenAudio?: boolean;
+        view?: string;
     }): Promise<void>;
     /**
      * 停止屏幕共享
@@ -1046,15 +1038,23 @@ declare class TUIRoomEngine {
     stopScreenSharing(): Promise<void>;
     /**
      * 开始屏幕共享 Electron
-     * @param {string} targetId 分享窗口 id, 可从 getScreenSharingTarget 获取
+     * @param {object} options Electron 开始屏幕共享参数
+     * @param {string} options.targetId 分享窗口 id, 可从 getScreenSharingTarget 获取
+     * @param {string=} options.view 非必填，本地预览屏幕分享的 dom 元素的 id
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.startScreenSharingElectron('xxx');
+     * // example 1: 开始屏幕共享
+     * await roomEngine.startScreenSharingElectron({ targetId: 'xxx' });
+     * // example 2: 开始屏幕共享并在本地预览
+     * await roomEngine.startScreenSharingElectron({ targetId: 'xxx', view: 'screen-preview' });
      *
      */
-    startScreenSharingElectron(targetId: string): Promise<void>;
+    startScreenSharingElectron(options: {
+        targetId: string;
+        view?: string;
+    } | string): Promise<void>;
     /**
      * 停止屏幕共享 Electron
      * @returns {Promise<void>}
@@ -1075,15 +1075,18 @@ declare class TUIRoomEngine {
     getScreenSharingTarget(): Promise<Array<TRTCScreenCaptureSourceInfo>>;
     /**
      * 切换屏幕分享窗口 Electron
-     * @param {string} targetId 分享窗口 id, 可从 getScreenSharingTarget 获取
+     * @param {object} options Electron 切换屏幕分享窗口参数
+     * @param {string} options.targetId 分享窗口 id, 可从 getScreenSharingTarget 获取
      *
      * @returns {Promise<void>}
      *
      * @example
      * const roomEngine = new TUIRoomEngine();
-     * await roomEngine.selectScreenSharingTarget('xxx');
+     * await roomEngine.selectScreenSharingTarget({ targetId: 'xxx' });
      */
-    selectScreenSharingTarget(targetId: string): Promise<void>;
+    selectScreenSharingTarget(options: {
+        targetId: string;
+    } | string): Promise<void>;
     /**
      * 监听 roomEngine 的事件
      * @param event TUIRoomEvents