trtc-sdk-v5 5.2.0-beta.2 → 5.2.0-beta.8

package/index.d.ts

@@ -871,10 +871,10 @@
 	    * - 一个 trtc 实例只能开启一路麦克风，若您需要在已经开启一路麦克风的情况下，再开启一路麦克风用于测试，可以创建多个 trtc 实例实现。
 	    *
 	    * @param {object} [config] - 配置项
-	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为true。若在进房前调用该接口，并且 publish = true，则在进房后 SDK 会自动发布。
+	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为true。若在进房前调用该接口，并且 publish = true，则在进房后 SDK 会自动发布。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {object} [config.option] - 本地音频选项
 	    * @param {string} [config.option.microphoneId]- 指定使用哪个麦克风
-	    * @param {MediaStreamTrack} [config.option.audioTrack] - 自定义采集的 audioTrack。若同时设置 microphoneId，audioTrack，则按优先级（microphoneId>audioTrack）进行采集。
+	    * @param {MediaStreamTrack} [config.option.audioTrack] - 自定义采集的 audioTrack。{@tutorial 20-advanced-customized-capture-rendering}。
 	    * @param {number} [config.option.earMonitorVolume] - 设置耳返音量，取值[0, 100]，本地麦克风默认静音播放。
 	    * @param {string} [config.option.profile] - 音频编码配置, 默认{@link module:TYPE.AUDIO_PROFILE_STANDARD TRTC.TYPE.AUDIO_PROFILE_STANDARD}
 	    * @throws
@@ -903,11 +903,11 @@
 	    * - 调用时机：该接口需在 {@link TRTC#startLocalAudio startLocalAudio()} 成功后调用，可以多次调用。
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
-	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为 true
-	    * @param {boolean} [config.mute] - 静音麦克风。参考：[开关麦克风、摄像头](./tutorial-15-basic-dynamic-add-video.html)。
+	    * @param {boolean} [config.publish] - 是否将本地音频发布到房间中，默认为 true。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
+	    * @param {boolean} [config.mute] - 静音麦克风。参考：{@tutorial 15-basic-dynamic-add-video}。
 	    * @param {object} [config.option] - 本地音频配置
 	    * @param {string} [config.option.microphoneId] - 指定使用哪个麦克风，用来切换麦克风。
-	    * @param {MediaStreamTrack} [config.option.audioSource] - 自定义采集的 audioTrack，具体参考自定义采集指引
+	    * @param {MediaStreamTrack} [config.option.audioTrack] - 自定义采集的 audioTrack。 {@tutorial 20-advanced-customized-capture-rendering}。
 	    * @throws
 	    * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
 	    * - {@link module:ERROR_CODE.DEVICE_ERROR DEVICE_ERROR}
@@ -924,7 +924,7 @@
 	    updateLocalAudio(config: UpdateLocalAudioConfig): Promise<void>;
 	    /**
 	    * 停止本地麦克风的采集及发布。
-	    * - 如果您只是想静音麦克风，请使用 updateLocalAudio({ mute: true })。参考：[开关麦克风、摄像头](./tutorial-15-basic-dynamic-add-video.html)。
+	    * - 如果您只是想静音麦克风，请使用 updateLocalAudio({ mute: true })。参考：{@tutorial 15-basic-dynamic-add-video}。
 	    * @throws {@link module:ERROR_CODE.OPERATION_ABORT OPERATION_ABORT}
 	    * @example
 	    * await trtc.stopLocalAudio();
@@ -981,11 +981,11 @@
 	    *
 	    * @param {object} [config]
 	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 本地视频预览的 HTMLElement 实例或者 Id， 如果不传或传入 null， 则不会播放视频。
-	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布（若 publish=true）。
+	    * @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布（若 publish=true）。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {object} [config.option] - 本地视频配置
 	    * @param {string} [config.option.cameraId] - 指定使用哪个摄像头，用于切换摄像头。
 	    * @param {boolean} [config.option.useFrontCamera] - 是否使用前置摄像头
-	    * @param {MediaStreamTrack} [config.option.videoTrack] - 自定义采集的 videoTrack。若同时设置 cameraId，useFrontCamera，videoTrack，则按优先级（cameraId>useFrontCamera>videoTrack）进行采集。
+	    * @param {MediaStreamTrack} [config.option.videoTrack] - 自定义采集的 videoTrack。{@tutorial 20-advanced-customized-capture-rendering}。
 	    * @param {boolean} [config.option.mirror] - 是否开启本地预览镜像，默认为 true。
 	    * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。默认为 `cover`。参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
 	    * @param {VideoProfile} [config.option.profile] - 视频大流编码参数。
@@ -1033,12 +1033,12 @@
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
 	    * @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 {boolean} [config.publish] - 是否将本地视频发布到房间中。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
+	    * @param {boolean} [config.mute] - 是否暂停摄像头采集，参考：{@tutorial 15-basic-dynamic-add-video}。
 	    * @param {object} [config.option] - 本地视频配置
 	    * @param {string} [config.option.cameraId] - 指定使用哪个摄像头，
 	    * @param {boolean} [config.option.useFrontCamera] - 是否使用前置摄像头
-	    * @param {MediaStreamTrack} [config.option.videoTrack] - 自定义采集的 videoTrack
+	    * @param {MediaStreamTrack} [config.option.videoTrack] - 自定义采集的 videoTrack，{@tutorial 20-advanced-customized-capture-rendering}。
 	    * @param {boolean} [config.option.mirror] - 是否开启镜像
 	    * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit| CSS object-fit} 属性
 	    * @param {VideoProfile} [config.option.profile] - 视频大流编码参数
@@ -1101,12 +1101,13 @@
 	    * - 开启屏幕分享后，房间内其他用户会收到 {@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 | HTMLElement[] | null} [config.view] - 预览本地屏幕分享的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染本地屏幕分享。
-	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布。
+	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。默认为 true，若在进房前调用该接口，SDK 会在进房成功后自动发布。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @param {object} [config.option] - 屏幕分享配置
 	    * @param {boolean} [config.option.systemAudio] - 是否采集系统声音，默认为 false。
 	    * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。默认为 `contain`，参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
 	    * @param {ScreenShareProfile} [config.option.profile] - 屏幕分享编码配置。
 	    * @param {QOS_PREFERENCE_SMOOTH|QOS_PREFERENCE_CLEAR} [config.option.qosPreference] - 设置弱网时，视频编码策略。流畅度优先（{@link module:TYPE.QOS_PREFERENCE_SMOOTH QOS_PREFERENCE_SMOOTH}）或 （默认）清晰度优先（{@link module:TYPE.QOS_PREFERENCE_CLEAR QOS_PREFERENCE_CLEAR}）
+	    * @param {MediaStreamTrack} [config.option.videoTrack] - 自定义采集的 videoTrack。{@tutorial 20-advanced-customized-capture-rendering}。
 	    * @throws
 	    * - {@link module:ERROR_CODE.ENV_NOT_SUPPORTED ENV_NOT_SUPPORTED}
 	    * - {@link module:ERROR_CODE.INVALID_PARAMETER INVALID_PARAMETER}
@@ -1127,7 +1128,7 @@
 	    * - 本方法采用增量更新方式：只更新传入的参数，不传入的参数保持不变。
 	    * @param {object} [config]
 	    * @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 屏幕分享预览的 HTMLElement 实例或 Id， 如果不传或传入 null， 则不会渲染屏幕分享。
-	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中
+	    * @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
 	    * @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} 属性。
 	    * @param {QOS_PREFERENCE_SMOOTH|QOS_PREFERENCE_CLEAR} [config.option.qosPreference] - 设置弱网时，视频编码策略。流畅度优先（{@link module:TYPE.QOS_PREFERENCE_SMOOTH QOS_PREFERENCE_SMOOTH}）或 （默认）清晰度优先（{@link module:TYPE.QOS_PREFERENCE_CLEAR QOS_PREFERENCE_CLEAR}）
@@ -1190,7 +1191,7 @@
 	    * - {@link module:TYPE.STREAM_TYPE_MAIN TRTC.TYPE.STREAM_TYPE_MAIN}: 主流（远端用户的摄像头）
 	    * - {@link module:TYPE.STREAM_TYPE_SUB TRTC.TYPE.STREAM_TYPE_SUB}: 辅流（远端用户的屏幕分享）
 	    * @param {object} [config.option] - 远端视频配置
-	    * @param {boolean} [config.option.small] - 是否拉小流，参考：[开启大小流](./tutorial-27-advanced-small-stream.html)
+	    * @param {boolean} [config.option.small] - 是否拉小流，参考：{@tutorial 27-advanced-small-stream}
 	    * @param {boolean} [config.option.mirror] - 是否开启镜像
 	    * @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
 	    * @throws
@@ -1449,7 +1450,7 @@
 	    /**
 	     * 检测 TRTC Web SDK 是否支持当前浏览器
 	     *
-	     * - 参考：[浏览器兼容情况](tutorial-05-info-browser.html)。
+	     * - 参考：{@tutorial 05-info-browser}。
 	     * @example
 	     * TRTC.isSupported().then((checkResult) => {
 	     *   if(!checkResult.result) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "trtc-sdk-v5",
-  "version": "5.2.0-beta.2",
+  "version": "5.2.0-beta.8",
   "description": "Tencent Cloud RTC SDK for Web",
   "main": "trtc.js",
   "types": "index.d.ts",