trtc-sdk-v5 5.2.0-beta.6 → 5.2.0-beta.8
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +6 -6
- package/package.json +1 -1
- package/trtc.esm.js +15 -15
- package/trtc.js +1 -1
package/index.d.ts
CHANGED
|
@@ -871,7 +871,7 @@
|
|
|
871
871
|
* - 一个 trtc 实例只能开启一路麦克风,若您需要在已经开启一路麦克风的情况下,再开启一路麦克风用于测试,可以创建多个 trtc 实例实现。
|
|
872
872
|
*
|
|
873
873
|
* @param {object} [config] - 配置项
|
|
874
|
-
* @param {boolean} [config.publish] - 是否将本地音频发布到房间中,默认为true。若在进房前调用该接口,并且 publish = true,则在进房后 SDK
|
|
874
|
+
* @param {boolean} [config.publish] - 是否将本地音频发布到房间中,默认为true。若在进房前调用该接口,并且 publish = true,则在进房后 SDK 会自动发布。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
|
|
875
875
|
* @param {object} [config.option] - 本地音频选项
|
|
876
876
|
* @param {string} [config.option.microphoneId]- 指定使用哪个麦克风
|
|
877
877
|
* @param {MediaStreamTrack} [config.option.audioTrack] - 自定义采集的 audioTrack。{@tutorial 20-advanced-customized-capture-rendering}。
|
|
@@ -903,7 +903,7 @@
|
|
|
903
903
|
* - 调用时机:该接口需在 {@link TRTC#startLocalAudio startLocalAudio()} 成功后调用,可以多次调用。
|
|
904
904
|
* - 本方法采用增量更新方式:只更新传入的参数,不传入的参数保持不变。
|
|
905
905
|
* @param {object} [config]
|
|
906
|
-
* @param {boolean} [config.publish] - 是否将本地音频发布到房间中,默认为 true
|
|
906
|
+
* @param {boolean} [config.publish] - 是否将本地音频发布到房间中,默认为 true。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
|
|
907
907
|
* @param {boolean} [config.mute] - 静音麦克风。参考:{@tutorial 15-basic-dynamic-add-video}。
|
|
908
908
|
* @param {object} [config.option] - 本地音频配置
|
|
909
909
|
* @param {string} [config.option.microphoneId] - 指定使用哪个麦克风,用来切换麦克风。
|
|
@@ -981,7 +981,7 @@
|
|
|
981
981
|
*
|
|
982
982
|
* @param {object} [config]
|
|
983
983
|
* @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 本地视频预览的 HTMLElement 实例或者 Id, 如果不传或传入 null, 则不会播放视频。
|
|
984
|
-
* @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true,若在进房前调用该接口,SDK 会在进房成功后自动发布(若 publish=true
|
|
984
|
+
* @param {boolean} [config.publish] - 是否将本地视频发布到房间中。默认为 true,若在进房前调用该接口,SDK 会在进房成功后自动发布(若 publish=true)。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
|
|
985
985
|
* @param {object} [config.option] - 本地视频配置
|
|
986
986
|
* @param {string} [config.option.cameraId] - 指定使用哪个摄像头,用于切换摄像头。
|
|
987
987
|
* @param {boolean} [config.option.useFrontCamera] - 是否使用前置摄像头
|
|
@@ -1033,7 +1033,7 @@
|
|
|
1033
1033
|
* - 本方法采用增量更新方式:只更新传入的参数,不传入的参数保持不变。
|
|
1034
1034
|
* @param {object} [config]
|
|
1035
1035
|
* @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 预览摄像头的 HTMLElement 实例或者 Id, 如果不传或传入null, 则不会渲染视频, 但会仍然会推流消耗带宽的容器
|
|
1036
|
-
* @param {boolean} [config.publish] -
|
|
1036
|
+
* @param {boolean} [config.publish] - 是否将本地视频发布到房间中。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
|
|
1037
1037
|
* @param {boolean} [config.mute] - 是否暂停摄像头采集,参考:{@tutorial 15-basic-dynamic-add-video}。
|
|
1038
1038
|
* @param {object} [config.option] - 本地视频配置
|
|
1039
1039
|
* @param {string} [config.option.cameraId] - 指定使用哪个摄像头,
|
|
@@ -1101,7 +1101,7 @@
|
|
|
1101
1101
|
* - 开启屏幕分享后,房间内其他用户会收到 {@link module:EVENT.REMOTE_VIDEO_AVAILABLE REMOTE_VIDEO_AVAILABLE} 事件,streamType 为 {@link module:TYPE.STREAM_TYPE_SUB STREAM_TYPE_SUB},其他用户可以通过 {@link TRTC#startRemoteVideo startRemoteVideo} 播放屏幕分享。
|
|
1102
1102
|
* @param {object} [config]
|
|
1103
1103
|
* @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 预览本地屏幕分享的 HTMLElement 实例或 Id, 如果不传或传入 null, 则不会渲染本地屏幕分享。
|
|
1104
|
-
* @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。默认为 true,若在进房前调用该接口,SDK
|
|
1104
|
+
* @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。默认为 true,若在进房前调用该接口,SDK 会在进房成功后自动发布。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
|
|
1105
1105
|
* @param {object} [config.option] - 屏幕分享配置
|
|
1106
1106
|
* @param {boolean} [config.option.systemAudio] - 是否采集系统声音,默认为 false。
|
|
1107
1107
|
* @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。默认为 `contain`,参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
|
|
@@ -1128,7 +1128,7 @@
|
|
|
1128
1128
|
* - 本方法采用增量更新方式:只更新传入的参数,不传入的参数保持不变。
|
|
1129
1129
|
* @param {object} [config]
|
|
1130
1130
|
* @param {string | HTMLElement | HTMLElement[] | null} [config.view] - 屏幕分享预览的 HTMLElement 实例或 Id, 如果不传或传入 null, 则不会渲染屏幕分享。
|
|
1131
|
-
* @param {boolean} [config.publish] -
|
|
1131
|
+
* @param {boolean} [config.publish] - 是否将屏幕分享发布到房间中。可监听该事件获取推流状态 {@link module:EVENT.PUBLISH_STATE_CHANGED PUBLISH_STATE_CHANGED}。
|
|
1132
1132
|
* @param {object} [config.option] - 屏幕分享配置
|
|
1133
1133
|
* @param {'contain' | 'cover' | 'fill'} [config.option.fillMode] - 视频填充模式。默认为 `contain`,参考 {@link https://developer.mozilla.org/zh-CN/docs/Web/CSS/object-fit CSS object-fit} 属性。
|
|
1134
1134
|
* @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})
|