trtc-electron-sdk 10.3.8-beta.4 → 10.3.8-beta.41

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.
@@ -44,3 +44,4 @@ export declare function calcVideoStyle(options?: {
44
44
  };
45
45
  export declare const config: Config;
46
46
  export declare function allocBuffer(length: number, userId?: string, streamType?: TRTCVideoStreamType): Buffer;
47
+ export declare function generateUniqueId(): number;
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.allocBuffer = exports.config = exports.calcVideoStyle = exports.calcCanvasStyle = exports.calcScaleRate = exports.isNeedKeepWidthAndHeight = exports.Config = void 0;
3
+ exports.generateUniqueId = exports.allocBuffer = exports.config = exports.calcVideoStyle = exports.calcCanvasStyle = exports.calcScaleRate = exports.isNeedKeepWidthAndHeight = exports.Config = void 0;
4
4
  /**
5
5
  * 配置对象, 可用来打开 debug 模式
6
6
  *
@@ -135,3 +135,7 @@ function allocBuffer(length, userId, streamType) {
135
135
  return null;
136
136
  }
137
137
  exports.allocBuffer = allocBuffer;
138
+ function generateUniqueId() {
139
+ return Date.now() * 1000 + Math.floor(Math.random() * 1000);
140
+ }
141
+ exports.generateUniqueId = generateUniqueId;
package/liteav/trtc.d.ts CHANGED
@@ -43,6 +43,8 @@ declare class TRTCCloud extends EventEmitter {
43
43
  private enableRenderFrame;
44
44
  private screenCaptureStreamType;
45
45
  private isScreenCapturing;
46
+ private isEnterRoom;
47
+ private isCaptureLocalVideoEnabled;
46
48
  constructor();
47
49
  /**
48
50
  * 创建 TRTCCloud 对象单例
@@ -54,10 +56,21 @@ declare class TRTCCloud extends EventEmitter {
54
56
  */
55
57
  static destroyTRTCShareInstance(): void;
56
58
  /**
57
- * 获取配置对象, 可用来打开 debug 模式
59
+ * 获取 TRTC 配置对象
60
+ *
61
+ * 可以通过 TRTC 配置对象 {@link TRTCConfig} 打开 debug 模式
62
+ *
63
+ * @example
64
+ * // Enable 'debug' mode
65
+ * const TRTCCloud = require('trtc-electron-sdk');
66
+ * const rtcCloud = new TRTCCloud();
67
+ * rtcCloud.getConfigObject().setDebugMode(true);
68
+ *
69
+ * @returns {TRTCConfig}
58
70
  */
59
71
  getConfigObject(): import("./Render/util").Config;
60
72
  setExternalRenderEnabled(enabled: boolean): void;
73
+ setCaptureLocalVideoEnabled(enabled: boolean): void;
61
74
  /**
62
75
  * 清理资源
63
76
  */
@@ -194,11 +207,11 @@ declare class TRTCCloud extends EventEmitter {
194
207
  /**
195
208
  * 3.3 用户是否开启摄像头视频
196
209
  *
197
- * 当您收到 onUserVideoAvailable(userId, YES) 通知时,代表该路画面已经有可用的视频数据帧到达。
210
+ * 当您收到 onUserVideoAvailable(userId, 1) 通知时,代表该路画面已经有可用的视频数据帧到达。
198
211
  * 之后,您需要调用 [startRemoteView()]{@link TRTCCloud#startRemoteView} 接口加载该用户的远程画面。
199
212
  * 再之后,您还会收到名为 onFirstVideoFrame(userId) 的首帧画面渲染回调。
200
213
  *
201
- * 当您收到了 onUserVideoAvailable(userId, NO) 通知时,代表该路远程画面已经被关闭,这可能是
214
+ * 当您收到了 onUserVideoAvailable(userId, 0) 通知时,代表该路远程画面已经被关闭,这可能是
202
215
  * 由于该用户调用了 [muteLocalVideo()]{@link TRTCCloud#muteLocalVideo} 或 [stopLocalPreview()]{@link TRTCCloud#stopLocalPreview} 所致。
203
216
  *
204
217
  * @event TRTCCallback#onUserVideoAvailable
@@ -209,7 +222,7 @@ declare class TRTCCloud extends EventEmitter {
209
222
  /**
210
223
  * 3.4 用户是否开启了辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)
211
224
  *
212
- * 注意:显示辅路画面使用的函数是 [startRemoteSubStreamView()]{@link TRTCCloud#startRemoteSubStreamView} 而非 [startRemoteView()]{@link TRTCCloud#startRemoteView}。
225
+ * 注意:显示辅路画面使用的函数是[startRemoteView()]{@link TRTCCloud#startRemoteView}, 从 8.0 版本开始已不再推荐使用 [startRemoteSubStreamView()]{@link TRTCCloud#startRemoteSubStreamView}。
213
226
  *
214
227
  * @event TRTCCallback#onUserSubStreamAvailable
215
228
  * @param {String} userId - 用户标识
@@ -598,7 +611,7 @@ declare class TRTCCloud extends EventEmitter {
598
611
  * - ERR_AUDIO_PLUGIN_INSTALL_FAILED (-1332) :安装音频驱动插件失败
599
612
  */
600
613
  handleOnSystemAudioLoopbackError(errCode: number): void;
601
- handleOnVideoSizeChange(userId: string, streamType: number, width: number, height: number): void;
614
+ handleVideoSizeChange(userId: string, streamType: number, width: number, height: number): void;
602
615
  /**
603
616
  * 1.1 进入房间
604
617
  *
@@ -661,7 +674,7 @@ declare class TRTCCloud extends EventEmitter {
661
674
  *
662
675
  * @param {TRTCSwitchRoomParam} params 房间切换参数,请参考 {@link TRTCSwitchRoomParam}
663
676
  *
664
- * 接口调用结果会通过 TRTCCloudListener 中的 onSwitchRoom(errCode, errMsg) 回调通知给您。
677
+ * 接口调用结果会通过 onSwitchRoom(errCode, errMsg) 事件回调通知给您。
665
678
  */
666
679
  switchRoom(params: TRTCSwitchRoomParam): void;
667
680
  /**
@@ -690,13 +703,13 @@ declare class TRTCCloud extends EventEmitter {
690
703
  * <pre>
691
704
  * 房间 001 房间 002
692
705
  * ------------- ------------
693
- * 跨房连麦前:| 主播 A | | 主播 B |
706
+ * 跨房连麦前: | 主播 A | | 主播 B |
694
707
  * | 观众 U V W | | 观众 X Y Z |
695
708
  * ------------- ------------
696
709
  *
697
710
  * 房间 001 房间 002
698
711
  * ------------- ------------
699
- * 跨房连麦后:| 主播 A B | | 主播 B A |
712
+ * 跨房连麦后: | 主播 A B | | 主播 B A |
700
713
  * | 观众 U V W | | 观众 X Y Z |
701
714
  * ------------- ------------
702
715
  * </pre>
@@ -809,6 +822,8 @@ declare class TRTCCloud extends EventEmitter {
809
822
  *
810
823
  * 参考文档:[云端混流转码](https://cloud.tencent.com/document/product/647/16827)。
811
824
  *
825
+ * 注意:混流转码为收费功能,调用接口将产生云端混流转码费用,详见 [云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。
826
+ *
812
827
  * @note 关于云端混流的注意事项:
813
828
  * - 云端转码会引入一定的 CDN 观看延时,大概会增加1 - 2秒。
814
829
  * - 调用该函数的用户,会将连麦中的多路画面混合到自己当前这路画面中。
@@ -830,7 +845,7 @@ declare class TRTCCloud extends EventEmitter {
830
845
  * @param {String} config.streamId - 输出到 CDN 上的直播流 ID
831
846
  * @param {TRTCMixUser[]} config.mixUsersArray - 每一路子画面的位置信息
832
847
  * @param {String} config.mixUsersArray[].userId - 参与混流的 userId
833
- * @param {String} config.mixUsersArray[].roomId - 参与混流的 roomId,跨房流传入的实际 roomId,当前房间流传入 roomId = null
848
+ * @param {String} config.mixUsersArray[].roomId - 参与混流的 roomId,跨房流传入的实际 roomId。当前房间流,请传入空字符串(roomId = '')。
834
849
  * @param {Rect} config.mixUsersArray[].rect - 图层位置坐标以及大小,左上角为坐标原点(0,0) (绝对像素值)
835
850
  * @param {Number} config.mixUsersArray[].rect.left - 图层位置的左坐标
836
851
  * @param {Number} config.mixUsersArray[].rect.top - 图层位置的上坐标
@@ -855,16 +870,36 @@ declare class TRTCCloud extends EventEmitter {
855
870
  */
856
871
  stopLocalPreview(): void;
857
872
  /**
858
- * 3.3 是否屏蔽自己的视频画面
873
+ * 3.3 修改本地摄像头预览的 HTML 元素
859
874
  *
860
- * 当屏蔽本地视频后,房间里的其它成员将会收到 onUserVideoAvailable 回调通知
861
- * @param {Boolean} mute - true:屏蔽;false:开启,默认值:false
875
+ * 本接口用于切换显示区域的交互场景中,修改本地摄像头预览的 HTML 元素。
876
+ *
877
+ * 注意:必须在调用 [startLocalPreview()]{@link TRTCCloud#startLocalPreview} 接口开启本地摄像头采集后,调用本接口才会生效。
878
+ * - 如果用户调用 `startLocalPreview(view)` 接口开启了摄像头采集,则通过此接口可以修改摄像头采集视频渲染的 HTML 元素。
879
+ * - 如果用户调用 `startLocalPreview(null)` 接口开启了摄像头采集,但未开启本地预览,支持调用此接口开启预览。
880
+ *
881
+ * @param {HTMLElement|null} view - 接收本地摄像头采集视频渲染的 HTML 元素,传入 `null` 结束本地摄像头采集视频的预览。
882
+ * - 传入的 HTML 元素必须是块元素,比如:`div`
883
+ */
884
+ updateLocalView(view: HTMLElement | null): void;
885
+ /**
886
+ * 3.3 暂停/恢复发布本地的视频流
887
+ *
888
+ * 该接口可以暂停(或恢复)发布本地的视频画面,暂停之后,同一房间中的其他用户将无法继续看到自己画面。
889
+ * 该接口在指定 TRTCVideoStreamTypeBig 时等效于 start/stopLocalPreview 这两个接口,但具有更好的响应速度。
890
+ * 因为 start/stopLocalPreview 需要打开和关闭摄像头,而打开和关闭摄像头都是硬件设备相关的操作,非常耗时。
891
+ * 相比之下,muteLocalVideo 只需要在软件层面对数据流进行暂停或者放行即可,因此效率更高,也更适合需要频繁打开关闭的场景。
892
+ * 当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后,同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
893
+ * 当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后,同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
894
+ *
895
+ * @param {Boolean} mute - true:屏蔽;false:开启,默认值:false
896
+ * @param {TRTCVideoStreamType} streamType - 要暂停/恢复的视频流类型, 仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub
862
897
  */
863
898
  muteLocalVideo(mute: boolean, streamType?: TRTCVideoStreamType): void;
864
899
  /**
865
900
  * 3.4 开始显示远端视频画面
866
901
  *
867
- * 在收到 SDK 的 onUserVideoAvailable(userId, true) 通知时,可以获知该远程用户开启了视频,
902
+ * 在收到 SDK 的 onUserVideoAvailable(userId, 1) 通知时,可以获知该远程用户开启了视频,
868
903
  * 此后调用 startRemoteView(userId) 接口加载该用户的远程画面时,可以用 loading 动画优化加载过程中的等待体验。
869
904
  * 待该用户的首帧画面开始显示时,您会收到 onFirstVideoFrame(userId) 事件回调。
870
905
  *
@@ -882,6 +917,20 @@ declare class TRTCCloud extends EventEmitter {
882
917
  * @param {TRTCVideoStreamType} streamType - 视频流类型
883
918
  */
884
919
  stopRemoteView(userId: string, streamType?: TRTCVideoStreamType): void;
920
+ /**
921
+ * 3.7 修改远端视频渲染的 HTML 元素
922
+ *
923
+ * 本接口用于切换显示区域的交互场景中,修改远端视频渲染的 HTML 元素。
924
+ *
925
+ * 注意:必须调用 [startRemoteView()]{@link TRTCCloud#startRemoteView} 订阅了远端视频流之后,调用此接口才会生效。
926
+ *
927
+ * @param {String} userId - 远端视频流的用户 ID
928
+ * @param {HTMLElement|null} view - 接受远端视频流渲染的 HTML 元素,传入 null 结束远端视频的渲染
929
+ * - 传入的 HTML 元素必须时块元素,例如:div
930
+ * @param {TRTCVideoStreamType} streamType - 视频流类型
931
+ *
932
+ */
933
+ updateRemoteView(userId: string, view: HTMLElement | null, streamType: TRTCVideoStreamType): void;
885
934
  /**
886
935
  * 3.6 停止显示所有远端视频画面,同时不再拉取该远端用户的视频数据流
887
936
  *
@@ -953,7 +1002,7 @@ declare class TRTCCloud extends EventEmitter {
953
1002
  */
954
1003
  setLocalViewFillMode(mode: TRTCVideoFillMode): void;
955
1004
  /**
956
- * 3.13 设置远端图像的渲染模式
1005
+ * 3.13 设置远端画面的渲染模式
957
1006
  *
958
1007
  * @param {String} userId - 用户 ID
959
1008
  * @param {TRTCVideoStreamType} streamType - 视频流类型
@@ -1048,11 +1097,11 @@ declare class TRTCCloud extends EventEmitter {
1048
1097
  * 如果该 userId 没有开启双路编码模式,则此操作无效。
1049
1098
  *
1050
1099
  * @param {String} userId - 用户 ID
1051
- * @param {TRTCVideoStreamType} type - 视频流类型,即选择看大画面还是小画面,默认为 TRTCVideoStreamTypeBig
1100
+ * @param {TRTCVideoStreamType} streamType - 视频流类型,即选择看大画面还是小画面,默认为 TRTCVideoStreamTypeBig
1052
1101
  * - TRTCVideoStreamTypeBig : 大画面视频流
1053
1102
  * - TRTCVideoStreamTypeSmall: 小画面视频流
1054
1103
  */
1055
- setRemoteVideoStreamType(userId: string, type: TRTCVideoStreamType): void;
1104
+ setRemoteVideoStreamType(userId: string, streamType: TRTCVideoStreamType): void;
1056
1105
  /**
1057
1106
  * 3.22 视频画面截图
1058
1107
  *
@@ -1116,7 +1165,11 @@ declare class TRTCCloud extends EventEmitter {
1116
1165
  */
1117
1166
  muteRemoteAudio(userId: string, mute: boolean): void;
1118
1167
  /**
1119
- * 4.5 静音掉所有用户的声音,同时不再拉取该远端用户的音频数据流
1168
+ * 4.5 静音/取消静音所有远端用户的音频流
1169
+ *
1170
+ * 当您静音所有用户的远端音频时,SDK 会停止播放所有来自远端的音频流,同时也会停止拉取所有用户的音频数据。
1171
+ *
1172
+ * 注意:该接口支持您在进入房间(enterRoom)前调用,暂停状态会在退出房间(exitRoom)在之后会被重置。
1120
1173
  *
1121
1174
  * @param {Boolean} mute - true:静音;false:非静音
1122
1175
  */
@@ -1164,9 +1217,10 @@ declare class TRTCCloud extends EventEmitter {
1164
1217
  * 我们在 Demo 中有一个音量大小的提示条,就是基于这个接口实现的。
1165
1218
  * 如希望打开此功能,请在 startLocalAudio() 之前调用。
1166
1219
  *
1167
- * @param {Number} interval - 设置 onUserVoiceVolume 回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于0则会关闭回调,建议设置为300ms
1220
+ * @param {Number} interval - 设置 onUserVoiceVolume 回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于0则会关闭回调,建议设置为300ms
1221
+ * @param {Boolean} enableVad - true: 打开人声检测;false: 关闭人声检测。目前仅 windows 支持。
1168
1222
  */
1169
- enableAudioVolumeEvaluation(interval: number): void;
1223
+ enableAudioVolumeEvaluation(interval: number, enableVad?: boolean): void;
1170
1224
  /**
1171
1225
  * 4.12 开始录音
1172
1226
  *
@@ -1205,11 +1259,18 @@ declare class TRTCCloud extends EventEmitter {
1205
1259
  * - TRTCAudioQualityMusic: 音乐模式:采样率:48k
1206
1260
  */
1207
1261
  setAudioQuality(quality: TRTCAudioQuality): void;
1262
+ /**
1263
+ * 4.15 废弃接口:设置麦克风的音量大小
1264
+ *
1265
+ * @deprecated 从 TRTCSDK6.9 后该接口已被废弃,请使用 setAudioCaptureVolume 接口替代。
1266
+ * @param {Number} volume - 音量大小,100为正常音量,取值范围为0 - 200。
1267
+ */
1268
+ setMicVolumeOnMixing(volume: number): void;
1208
1269
  /**
1209
1270
  * 5.1 获取摄像头设备列表
1210
1271
  *
1211
1272
  * @example
1212
- * var cameralist = this.rtcCloud.getCameraDevicesList();
1273
+ * var cameralist = rtcCloud.getCameraDevicesList();
1213
1274
  * for (i=0;i<cameralist.length;i++) {
1214
1275
  * var camera = cameralist[i];
1215
1276
  * console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
@@ -1233,7 +1294,7 @@ declare class TRTCCloud extends EventEmitter {
1233
1294
  * 6.1 获取麦克风设备列表
1234
1295
  *
1235
1296
  * @example
1236
- * var miclist = this.rtcCloud.getMicDevicesList();
1297
+ * var miclist = rtcCloud.getMicDevicesList();
1237
1298
  * for (i=0;i<miclist.length;i++) {
1238
1299
  * var mic = miclist[i];
1239
1300
  * console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
@@ -1285,7 +1346,7 @@ declare class TRTCCloud extends EventEmitter {
1285
1346
  * 6.8 获取扬声器设备列表
1286
1347
  *
1287
1348
  * @example
1288
- * var speakerlist = this.rtcCloud.getSpeakerDevicesList();
1349
+ * var speakerlist = rtcCloud.getSpeakerDevicesList();
1289
1350
  * for (i=0;i<speakerlist.length;i++) {
1290
1351
  * var speaker = speakerlist[i];
1291
1352
  * console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
@@ -1308,10 +1369,6 @@ declare class TRTCCloud extends EventEmitter {
1308
1369
  /**
1309
1370
  * 6.11 获取系统当前扬声器设备音量
1310
1371
  *
1311
- * 注意:
1312
- * - SDK6.7 及以下版本,windows 查询的不是系统扬声器的音量大小,mac 是查询系统扬声器音量大小
1313
- * - SDK6.8 及以上版本,windows 和 mac 查询的都是系统扬声器的音量大小
1314
- *
1315
1372
  * @return {Number} 扬声器音量,范围0 - 100
1316
1373
  */
1317
1374
  getCurrentSpeakerVolume(): any;
@@ -1319,8 +1376,6 @@ declare class TRTCCloud extends EventEmitter {
1319
1376
  * 6.12 设置系统当前扬声器设备音量
1320
1377
  *
1321
1378
  * 注意:该接口的功能是调节系统播放音量,如果用户直接调节系统设置的播放音量时,该接口的设置结果会被用户的操作所覆盖。
1322
- * - SDK6.7 及以下版本,windows 设置的不是系统扬声器的音量大小,mac 是设置系统扬声器音量大小
1323
- * - SDK6.8 及以上版本,windows 和 mac 设置的都是系统扬声器的音量大小
1324
1379
  *
1325
1380
  * @param {Number} volume - 设置的扬声器音量,范围0 - 100
1326
1381
  */
@@ -1337,6 +1392,15 @@ declare class TRTCCloud extends EventEmitter {
1337
1392
  * @return {Boolean} 静音状态
1338
1393
  */
1339
1394
  getCurrentSpeakerDeviceMute(): any;
1395
+ /**
1396
+ * 设置 SDK 使用的音频设备自动跟随系统默认设备(仅适用于桌面端)
1397
+ *
1398
+ * @param {TRTCDeviceType} deviceType - 设备类型,只支持麦克风和扬声器,摄像头不支持
1399
+ * @param {Boolean} enable - 是否跟随系统默认的音频设备。
1400
+ * - true: 跟随。当系统默认音频设备发生改变时,SDK 立即切换音频设备。
1401
+ * - false: 不跟随。只有当 SDK 使用的音频设备被移除后或插入新的音频设备为系统默认设备时,SDK 才切换至系统默认的音频设备。
1402
+ */
1403
+ enableFollowingDefaultAudioDevice(deviceType: TRTCDeviceType, enable: boolean): void;
1340
1404
  /**
1341
1405
  * 7.1 设置美颜、美白、红润效果级别
1342
1406
  *
@@ -1426,7 +1490,7 @@ declare class TRTCCloud extends EventEmitter {
1426
1490
  * 8.5 枚举可共享的窗口列表
1427
1491
  *
1428
1492
  * 如果您要给您的 App 增加屏幕分享功能,一般需要先显示一个窗口选择界面,这样用户可以选择希望分享的窗口。
1429
- * 通过如下函数,您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
1493
+ * 通过此函数,您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
1430
1494
  * 拿到这些信息后,您就可以实现一个窗口选择界面,当然,您也可以使用我们在 Demo 源码中已经实现好的一个界面。
1431
1495
  *
1432
1496
  * 注意:返回的列表中包括屏幕和应用窗口,屏幕会在列表的前面几个元素中。
@@ -1471,7 +1535,7 @@ declare class TRTCCloud extends EventEmitter {
1471
1535
  */
1472
1536
  selectScreenCaptureTarget(source: TRTCScreenCaptureSourceInfo | number, captureRect: Rect | string, property: TRTCScreenCaptureProperty | string, deprecatedCaptureRect?: Rect, captureMouse?: boolean, highlightWindow?: boolean): any;
1473
1537
  /**
1474
- * 8.7 启动屏幕分享,支持选择使用主路或辅路进行屏幕分享。(暂不支持 mac 平台预览界面)
1538
+ * 8.7 启动屏幕分享,支持选择使用主路或辅路进行屏幕分享。
1475
1539
  *
1476
1540
  * 注意:
1477
1541
  * 一个用户同时最多只能上传一条主路(TRTCVideoStreamTypeBig)画面和一条辅路(TRTCVideoStreamTypeSub)画面,
@@ -1495,12 +1559,14 @@ declare class TRTCCloud extends EventEmitter {
1495
1559
  */
1496
1560
  stopScreenCapture(): void;
1497
1561
  /**
1498
- * 8.11 设置辅流(屏幕分享)的编码器参数
1562
+ * 8.11 设置屏幕分享(即辅路)的视频编码参数
1499
1563
  *
1500
- * - setVideoEncoderParam() 用于设置远端主路画面(TRTCVideoStreamTypeBig,一般用于摄像头)的编码参数。
1501
- * - setSubStreamEncoderParam() 用于设置远端辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的编码参数。
1564
+ * 该接口可以设定远端用户所看到的屏幕分享(即辅路)的画面质量,同时也能决定云端录制出的视频文件中屏幕分享的画面质量。 请注意如下两个接口的差异:
1565
+ * - setVideoEncoderParam() 用于设置主路画面(TRTCVideoStreamTypeBig,一般用于摄像头)的视频编码参数。
1566
+ * - setSubStreamEncoderParam() 用于设置辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的视频编码参数。
1502
1567
  *
1503
- * 该设置决定了远端用户看到的画面质量,同时也是云端录制出的视频文件的画面质量。
1568
+ * 注意:
1569
+ * 即使您使用主路传输屏幕分享(在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig),依然要使用 setSubStreamEncoderParam 设定屏幕分享的编码参数,而不要使用 setVideoEncoderParam 。
1504
1570
  *
1505
1571
  * @param {TRTCVideoEncParam} params - 辅流(屏幕分享)编码参数
1506
1572
  * @param {TRTCVideoResolution} params.videoResolution - 视频分辨率
@@ -1773,7 +1839,13 @@ declare class TRTCCloud extends EventEmitter {
1773
1839
  */
1774
1840
  seekMusicToPosInTime(id: number, pts: number): any;
1775
1841
  /**
1776
- * 11.19 设置背景音乐的音量大小,播放背景音乐混音时使用,用来控制背景音音量大小
1842
+ * 11.19 设置所有背景音乐的本地音量和远端音量的大小
1843
+ *
1844
+ * 该接口可以设置所有背景音乐的本地音量和远端音量。
1845
+ * - 本地音量:即主播本地可以听到的背景音乐的音量大小。
1846
+ * - 远端音量:即观众端可以听到的背景音乐的音量大小。
1847
+ *
1848
+ * 注意:如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
1777
1849
  *
1778
1850
  * @param {Number} volume - 音量大小,100为正常音量,取值范围为0 - 200。
1779
1851
  */
@@ -1886,15 +1958,7 @@ declare class TRTCCloud extends EventEmitter {
1886
1958
  */
1887
1959
  stopSpeedTest(): void;
1888
1960
  /**
1889
- * 13.3 设置 SDK 使用的音频设备根据跟随系统默认设备
1890
- *
1891
- * @param {TRTCDeviceType} deviceType - 设备类型
1892
- * @param {Boolean} enable - 是否跟随系统默认的音频设备。 true:跟随, 当系统默认音频设备发生改变时,SDK 立即切换音频设备; false:不跟随, 只有当 SDK 使用的音频设备被移除后或插入新的音频设备为系统默认设备时,SDK 才切换至系统默认的音频设备。
1893
- *
1894
- */
1895
- enableFollowingDefaultAudioDevice(deviceType: TRTCDeviceType, enable: boolean): void;
1896
- /**
1897
- * 13.4 开始进行摄像头测试
1961
+ * 13.3 开始进行摄像头测试
1898
1962
  *
1899
1963
  * 会触发 onFirstVideoFrame 回调接口
1900
1964
  *
@@ -1904,25 +1968,26 @@ declare class TRTCCloud extends EventEmitter {
1904
1968
  */
1905
1969
  startCameraDeviceTest(view: HTMLElement): void;
1906
1970
  /**
1907
- * 13.5 停止摄像头测试
1971
+ * 13.4 停止摄像头测试
1908
1972
  */
1909
1973
  stopCameraDeviceTest(): void;
1910
1974
  /**
1911
- * 13.6 开始进行麦克风测试
1975
+ * 13.5 开始进行麦克风测试
1912
1976
  *
1913
1977
  * 回调接口 onTestMicVolume 获取测试数据
1914
1978
  *
1915
1979
  * 该方法测试麦克风是否能正常工作,volume 的取值范围为0 - 100。
1916
1980
  *
1917
1981
  * @param {Number} interval - 反馈音量提示的时间间隔(ms),建议设置到大于 200 毫秒
1982
+ * @param {Boolean} playback - 是否开启回播麦克风声音,开启后用户测试麦克风时会听到自己的声音。默认值 true
1918
1983
  */
1919
- startMicDeviceTest(interval: number): void;
1984
+ startMicDeviceTest(interval: number, playback?: boolean): void;
1920
1985
  /**
1921
- * 13.7 停止麦克风测试
1986
+ * 13.6 停止麦克风测试
1922
1987
  */
1923
1988
  stopMicDeviceTest(): void;
1924
1989
  /**
1925
- * 13.8 开始进行扬声器测试
1990
+ * 13.7 开始进行扬声器测试
1926
1991
  *
1927
1992
  * 回调接口 onTestSpeakerVolume 获取测试数据
1928
1993
  *
@@ -1932,7 +1997,7 @@ declare class TRTCCloud extends EventEmitter {
1932
1997
  */
1933
1998
  startSpeakerDeviceTest(testAudioFilePath: string): void;
1934
1999
  /**
1935
- * 13.9 停止扬声器测试
2000
+ * 13.8 停止扬声器测试
1936
2001
  */
1937
2002
  stopSpeakerDeviceTest(): void;
1938
2003
  /**
@@ -1992,13 +2057,6 @@ declare class TRTCCloud extends EventEmitter {
1992
2057
  * @param {String} jsonStr - 接口及参数描述的 JSON 字符串
1993
2058
  */
1994
2059
  callExperimentalAPI(jsonStr: string): void;
1995
- /**
1996
- * 从 TRTCSDK6.9 后该接口已被废弃
1997
- *
1998
- * @deprecated 从 TRTCSDK6.9 后该接口已被废弃,请使用 setAudioCaptureVolume 接口替代。
1999
- * @param {Number} volume - 音量大小,100为正常音量,取值范围为0 - 200。
2000
- */
2001
- setMicVolumeOnMixing(volume: number): void;
2002
2060
  addLocalVideoRenderCallback(): void;
2003
2061
  addRemoteVideoRenderCallback(userId: string): void;
2004
2062
  /**