trtc-sdk-v5 5.0.0 → 5.0.2-beta.1

package/README.md

@@ -14,7 +14,7 @@ An object-oriented WebRTC SDK library
 
 </div>
 
-English | [简体中文](https://github.com/LiteAVSDK/TRTC_Web/blob/main/SDK/README-zh_CN.md)
+English | [简体中文](https://github.com/LiteAVSDK/TRTC_Web/blob/main/v5/SDK/README-zh_CN.md)
 
 ## Introduction
 
@@ -67,7 +67,7 @@ Explore SDK documents：[TRTC Web SDK](https://web.sdk.qcloud.com/trtc/webrtc/v5
   - Turn off camera [trtc.stopLocalVideo](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/TRTC.html#stopLocalVideo)
   - Turn off microphone [trtc.stopLocalAudio](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/TRTC.html#stopLocalAudio)
   - Play remote video [trtc.startRemoteVideo](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/TRTC.html#startRemoteVideo)
-  - Stop playing rmeote video [trtc.stopRemoteVideo](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/TRTC.html#stopRemoteVideo)
+  - Stop playing remote video [trtc.stopRemoteVideo](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/TRTC.html#stopRemoteVideo)
   - Mute/unmute remote audio [trtc.muteRemoteAudio](https://web.sdk.qcloud.com/trtc/webrtc/v5/doc/en/TRTC.html#muteRemoteAudio)
 
 ## Directory

package/index.d.ts

@@ -1,7 +1,7 @@
 /// <reference path="./core.d.ts" />
 
 	declare interface LocalVideoConfig {
-	    view: string | HTMLElement | null;
+	    view?: string | HTMLElement | HTMLElement[] | null;
 	    publish?: boolean;
 	    option?: {
 	        cameraId?: string;
@@ -41,7 +41,7 @@
 	    userDefineRecordId?: string;
 	}
 	declare interface ScreenShareConfig {
-	    view?: string | HTMLElement | null;
+	    view?: string | HTMLElement | HTMLElement[] | null;
 	    publish?: boolean;
 	    option?: {
 	        profile?: keyof typeof screenProfileMap | VideoProfile;
@@ -62,7 +62,7 @@
 	    };
 	}
 	declare interface RemoteVideoConfig {
-	    view: string | HTMLElement | null;
+	    view?: string | HTMLElement | HTMLElement[] | null;
 	    userId: string;
 	    streamType: TRTCStreamType;
 	    option?: {
@@ -72,7 +72,7 @@
 	    };
 	}
 	declare interface UpdateRemoteVideoConfig extends Omit<RemoteVideoConfig, 'view'> {
-	    view?: string | HTMLElement | null;
+	    view?: string | HTMLElement | HTMLElement[] | null;
 	}
 	declare interface StopRemoteVideoConfig {
 	    userId: string;
@@ -738,7 +738,8 @@
 	     * @param {string=} options.userDefineRecordId 用于设置云端录制的 userDefineRecordId(选填）。
 	     * - 【推荐取值】限制长度为64字节，只允许包含大小写英文字母（a-zA-Z）、数字（0-9）及下划线和连词符。
 	     * - 【参考文档】[云端录制](https://cloud.tencent.com/document/product/647/16823)。
-	     * @param {string|ProxyServer} [options.proxy] 设置代理服务器
+	     * @param {string|ProxyServer} [options.proxy] 设置代理服务器。参考最佳实践：{@tutorial 34-advanced-proxy}。
+	     * @param {boolean} [options.privateMapKey] 进房钥匙，若需要权限控制请携带该参数（传空或传错会导致进房失败）。<br>[privateMapKey 权限设置](https://cloud.tencent.com/document/product/647/32240)
 	     * @throws
 	     * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
 	     * - {@link module:ERROR_CODE.OPERATION_FAILED OPERATION_FAILED}
@@ -920,7 +921,7 @@
 	    * - 一个 trtc 实例只能开启一路摄像头。若您需要在已经开启一路摄像头的情况下，再开启一路摄像头用于测试，可以创建多个 trtc 实例实现。
 	    *
 	    * @param {object} [config]
-	    * @param {string | HTMLElement | null} [config.view] - 本地视频预览的 HTMLElement 实例或者 Id， 如果不传或传入 null， 则不会播放视频。
+	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 本地视频预览的 HTMLElement 实例或者 Id， 如果不传或传入 null， 则不会播放视频。
 	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布（若 publish=true）。
 	    * @param {object} [config.option] - 本地视频配置
 	    * @param {string} [config.option.cameraId] - 指定使用哪个摄像头，用于切换摄像头。
@@ -972,7 +973,7 @@
 	    * - 该接口可以多次调用。
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
-	    * @param {string | HTMLElement | null} [config.view] - 预览摄像头的 HTMLElement 实例或者 Id， 如果不传或传入null， 则不会渲染视频， 但会仍然会推流消耗带宽的容器
+	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 预览摄像头的 HTMLElement 实例或者 Id， 如果不传或传入null， 则不会渲染视频， 但会仍然会推流消耗带宽的容器
 	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布。
 	    * @param {boolean} [config.mute] - 是否暂停摄像头采集，参考：[开关麦克风、摄像头](./tutorial-15-basic-dynamic-add-video.html)
 	    * @param {object} [config.option] - 本地视频配置
@@ -1040,7 +1041,7 @@
 	    *
 	    * - 开启屏幕分享后，房间内其他用户会收到 {@link module:EVENT.REMOTE_VIDEO_AVAILABLE REMOTE_VIDEO_AVAILABLE} 事件，streamType 为 {@link module:TYPE.STREAM_TYPE_SUB STREAM_TYPE_SUB}，其他用户可以通过 {@link TRTC#startRemoteVideo startRemoteVideo} 播放屏幕分享。
 	    * @param {object} [config]
-	    * @param {string | HTMLElement | null} [config.view] - 预览本地屏幕分享的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染本地屏幕分享。
+	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 预览本地屏幕分享的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染本地屏幕分享。
 	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布。
 	    * @param {object} [config.option] - 屏幕分享配置
 	    * @param {boolean} [config.option.systemAudio] - 是否采集系统声音，默认为 false。
@@ -1066,7 +1067,7 @@
 	    * - 该接口可以多次调用。
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
-	    * @param {string | HTMLElement | null} [config.view] - 屏幕分享预览的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染屏幕分享。
+	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 屏幕分享预览的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染屏幕分享。
 	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中
 	    * @param {object} [config.option] - 屏幕分享配置
 	    * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。默认为 `contain`，参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
@@ -1099,7 +1100,7 @@
 	    *
 	    * - 调用时机：在收到 {@link module:EVENT.REMOTE_VIDEO_AVAILABLE TRTC.on(TRTC.EVENT.REMOTE_VIDEO_AVAILABLE)} 事件后调用。
 	    * @param {object} [config]
-	    * @param {string | HTMLElement | null} [config.view] - 用于播放远端视频的 HTMLElement 实例或者 Id， 如果不传或传入null， 则不会渲染视频， 但会仍然会拉流消耗带宽
+	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 用于播放远端视频的 HTMLElement 实例或者 Id， 如果不传或传入null， 则不会渲染视频， 但会仍然会拉流消耗带宽
 	    * @param {string} config.userId - 远端用户Id
 	    * @param {TRTC.TYPE.STREAM_TYPE_MAIN|TRTC.TYPE.STREAM_TYPE_SUB} config.streamType - 远端流类型
 	    * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: 主流（远端用户的摄像头）（远端用户的摄像头）
@@ -1128,7 +1129,7 @@
 	    * - 该方法可多次调用。
 	    * - 该方法采用增量更新的方式，只需要传入需要更新的配置项即可。
 	    * @param {object} [config]
-	    * @param {string | HTMLElement | null} [config.view] - 用于播放远端视频的 HTMLElement 实例或者 Id， 如果不传或传入null， 则不会渲染视频， 但会仍然会拉流消耗带宽
+	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 用于播放远端视频的 HTMLElement 实例或者 Id， 如果不传或传入null， 则不会渲染视频， 但会仍然会拉流消耗带宽
 	    * @param {string} config.userId - 远端用户Id
 	    * @param {TRTC.TYPE.STREAM_TYPE_MAIN|TRTC.TYPE.STREAM_TYPE_SUB} config.streamType - 远端流类型：
 	    * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: 主流（远端用户的摄像头）

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-sdk-v5",
-  "version": "5.0.0",
+  "version": "5.0.2-beta.1",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "module": "trtc.esm.js",