trtc-electron-sdk 9.3.108-beta.0 → 9.3.201

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/liteav/trtc.d.ts CHANGED
@@ -1,6 +1,6 @@
1
1
  /// <reference types="node" />
2
2
  import { EventEmitter } from 'events';
3
- import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCDeviceState, TRTCDeviceType, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCVideoFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, PluginInfo, TRTCSpeedTestParams } from './trtc_define';
3
+ import { AudioMusicParam, Rect, TRTCAppScene, TRTCAudioEffectParam, TRTCAudioQuality, TRTCBeautyStyle, TRTCLogLevel, TRTCRenderParams, TRTCRoleType, TRTCSwitchRoomParam, TRTCVideoBufferType, TRTCVideoFillMode, TRTCVideoFrame, TRTCVideoPixelFormat, TRTCVideoRotation, TRTCVideoStreamType, TRTCWaterMarkSrcType, PluginInfo, TRTCSpeedTestParams, TRTCScreenCaptureSourceInfo, TRTCScreenCaptureProperty, TRTCAudioRecordingParams } from './trtc_define';
4
4
  export * from './trtc_define';
5
5
  export * from './trtc_code';
6
6
  /**
@@ -16,7 +16,6 @@ export * from './trtc_code';
16
16
  *
17
17
  */
18
18
  declare class TRTCCloud extends EventEmitter {
19
- private rtcCloud;
20
19
  private streams;
21
20
  private firstVideoFrameList;
22
21
  private playStreamType;
@@ -39,7 +38,7 @@ declare class TRTCCloud extends EventEmitter {
39
38
  private audioQuality;
40
39
  private bgmId;
41
40
  private playAudioEffectIdList;
42
- private isStartLocalPreview;
41
+ private isLocalPreviewStarted;
43
42
  constructor();
44
43
  /**
45
44
  * 创建 TRTCCloud 对象单例
@@ -85,7 +84,7 @@ declare class TRTCCloud extends EventEmitter {
85
84
  * @param {Number} errCode - 错误码
86
85
  * @param {String} errMsg - 错误信息
87
86
  */
88
- handleOnError(errCode: number, errMsg: string): void;
87
+ bindOnError(): void;
89
88
  /**
90
89
  * 1.2 警告回调:用于告知您一些非严重性问题,例如出现了卡顿或者可恢复的解码失败。
91
90
  *
@@ -93,7 +92,7 @@ declare class TRTCCloud extends EventEmitter {
93
92
  * @param {Number} warningCode - 警告码
94
93
  * @param {String} warningMsg - 警告信息
95
94
  */
96
- handleOnWarning(warningCode: number, warningMsg: string): void;
95
+ bindOnWarning(): void;
97
96
  /**
98
97
  * 2.1 已加入房间的回调
99
98
  *
@@ -109,7 +108,7 @@ declare class TRTCCloud extends EventEmitter {
109
108
  * @event TRTCCallback#onEnterRoom
110
109
  * @param {Number} result - result > 0 时为进房耗时(ms),result < 0 时为进房错误码。
111
110
  */
112
- handleOnEnterRoom(result: number): void;
111
+ bindOnEnterRoom(): void;
113
112
  /**
114
113
  * 2.2 退出房间的事件回调
115
114
  *
@@ -122,7 +121,7 @@ declare class TRTCCloud extends EventEmitter {
122
121
  * @event TRTCCallback#onExitRoom
123
122
  * @param {Number} reason - 离开房间原因,0:主动调用 exitRoom 退房;1:被服务器踢出当前房间;2:当前房间整个被解散。
124
123
  */
125
- handleOnExitRoom(reason: number): void;
124
+ bindOnExitRoom(): void;
126
125
  /**
127
126
  * 2.3 切换房间的事件回调
128
127
  *
@@ -130,7 +129,7 @@ declare class TRTCCloud extends EventEmitter {
130
129
  * @param {Number} errCode - 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
131
130
  * @param {String} errMsg - 错误信息。
132
131
  */
133
- handleOnSwitchRoom(errCode: number, errMsg: string): void;
132
+ bindOnSwitchRoom(): void;
134
133
  /**
135
134
  * 2.4 切换角色的事件回调
136
135
  *
@@ -141,7 +140,7 @@ declare class TRTCCloud extends EventEmitter {
141
140
  * @param {Number} errCode - 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
142
141
  * @param {String} errMsg - 错误信息。
143
142
  */
144
- handleOnSwitchRole(errCode: number, errMsg: string): void;
143
+ bindOnSwitchRole(): void;
145
144
  /**
146
145
  * 2.5 请求跨房连麦(主播跨房 PK)的结果回调
147
146
  *
@@ -154,7 +153,7 @@ declare class TRTCCloud extends EventEmitter {
154
153
  * @param {Number} errCode - 错误码,ERR_NULL 代表切换成功,其他请参见[错误码](https://cloud.tencent.com/document/product/647/32257)。
155
154
  * @param {String} errMsg - 错误信息。
156
155
  */
157
- handleOnConnectOtherRoom(userId: string, errCode: number, errMsg: string): void;
156
+ bindOnConnectOtherRoom(): void;
158
157
  /**
159
158
  * 2.6 关闭跨房连麦(主播跨房 PK)的结果回调
160
159
  *
@@ -162,7 +161,7 @@ declare class TRTCCloud extends EventEmitter {
162
161
  * @param {Number} errCode - 错误码,ERR_NULL 代表切换成功,其他请参见 [错误码](https://cloud.tencent.com/document/product/647/32257)。
163
162
  * @param {String} errMsg - 错误信息。
164
163
  */
165
- handleOnDisconnectOtherRoom(errCode: number, errMsg: string): void;
164
+ bindOnDisconnectOtherRoom(): void;
166
165
  /**
167
166
  * 3.1 有用户加入当前房间
168
167
  *
@@ -175,7 +174,7 @@ declare class TRTCCloud extends EventEmitter {
175
174
  * @event TRTCCallback#onRemoteUserEnterRoom
176
175
  * @param {String} userId - 用户标识
177
176
  */
178
- handleOnRemoteUserEnterRoom(userId: string): void;
177
+ bindOnRemoteUserEnterRoom(): void;
179
178
  /**
180
179
  * 3.2 有用户离开当前房间
181
180
  *
@@ -187,7 +186,7 @@ declare class TRTCCloud extends EventEmitter {
187
186
  * @param {String} userId - 用户标识
188
187
  * @param {Number} reason - 离开原因,0表示用户主动退出房间,1表示用户超时退出,2表示被踢出房间。
189
188
  */
190
- handleOnRemoteUserLeaveRoom(userId: string, reason: number): void;
189
+ bindOnRemoteUserLeaveRoom(): void;
191
190
  /**
192
191
  * 3.3 用户是否开启摄像头视频
193
192
  *
@@ -202,7 +201,7 @@ declare class TRTCCloud extends EventEmitter {
202
201
  * @param {String} userId - 用户标识
203
202
  * @param {Number} available - 画面是否开启
204
203
  */
205
- handleOnUserVideoAvailable(userId: string, available: number): void;
204
+ bindOnUserVideoAvailable(): void;
206
205
  /**
207
206
  * 3.4 用户是否开启了辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)
208
207
  *
@@ -212,7 +211,7 @@ declare class TRTCCloud extends EventEmitter {
212
211
  * @param {String} userId - 用户标识
213
212
  * @param {Number} available - 辅路画面是否开启
214
213
  */
215
- handleOnUserSubStreamAvailable(userId: string, available: number): void;
214
+ bindOnUserSubStreamAvailable(): void;
216
215
  /**
217
216
  * 3.5 用户是否开启音频上行
218
217
  *
@@ -220,7 +219,7 @@ declare class TRTCCloud extends EventEmitter {
220
219
  * @param {String} userId - 用户标识
221
220
  * @param {Number} available - 声音是否开启
222
221
  */
223
- handleOnUserAudioAvailable(userId: string, available: number): void;
222
+ bindOnUserAudioAvailable(): void;
224
223
  /**
225
224
  * 3.6 开始渲染本地或远程用户的首帧画面
226
225
  *
@@ -235,14 +234,14 @@ declare class TRTCCloud extends EventEmitter {
235
234
  * @param {Number} width - 画面宽度
236
235
  * @param {Number} height - 画面高度
237
236
  */
238
- handleOnFirstVideoFrame(userId: string, streamType: number, width: number, height: number): void;
237
+ bindOnFirstVideoFrame(): void;
239
238
  /**
240
239
  * 3.7 开始播放远程用户的首帧音频(本地声音暂不通知)
241
240
  *
242
241
  * @event TRTCCallback#onFirstAudioFrame
243
242
  * @param {String} userId - 远程用户 ID。
244
243
  */
245
- handleOnFirstAudioFrame(userId: string): void;
244
+ bindOnFirstAudioFrame(): void;
246
245
  /**
247
246
  * 3.8 首帧本地视频数据已经被送出
248
247
  *
@@ -252,7 +251,7 @@ declare class TRTCCloud extends EventEmitter {
252
251
  * @event TRTCCallback#onSendFirstLocalVideoFrame
253
252
  * @param {Number} streamType - - 视频流类型,TRTCVideoStreamTypeBig:主路画面,一般用于摄像头;TRTCVideoStreamTypeSub:辅路画面,一般用于屏幕分享。
254
253
  */
255
- handleOnSendFirstLocalVideoFrame(streamType: number): void;
254
+ bindOnSendFirstLocalVideoFrame(): void;
256
255
  /**
257
256
  * 3.9 首帧本地音频数据已经被送出
258
257
  *
@@ -261,7 +260,7 @@ declare class TRTCCloud extends EventEmitter {
261
260
  *
262
261
  * @event TRTCCallback#onSendFirstLocalAudioFrame
263
262
  */
264
- handleOnSendFirstLocalAudioFrame(): void;
263
+ bindOnSendFirstLocalAudioFrame(): void;
265
264
  /**
266
265
  * 3.10 废弃事件:有主播加入当前房间
267
266
  *
@@ -271,7 +270,7 @@ declare class TRTCCloud extends EventEmitter {
271
270
  * @event TRTCCallback#onUserEnter
272
271
  * @param {String} userId - 用户标识
273
272
  */
274
- handleOnUserEnter(userId: string): void;
273
+ bindOnUserEnter(): void;
275
274
  /**
276
275
  * 3.11 废弃事件:有主播离开当前房间
277
276
  *
@@ -282,7 +281,7 @@ declare class TRTCCloud extends EventEmitter {
282
281
  * @param {String} userId - 用户标识
283
282
  * @param {Number} reason - 离开原因代码,区分用户是正常离开,还是由于网络断线等原因离开。
284
283
  */
285
- handleOnUserExit(userId: string, reason: number): void;
284
+ bindOnUserExit(): void;
286
285
  /**
287
286
  * 4.1 网络质量:该回调每2秒触发一次,统计当前网络的上行和下行质量
288
287
  *
@@ -310,23 +309,24 @@ declare class TRTCCloud extends EventEmitter {
310
309
  *
311
310
  * @event TRTCCallback#onConnectionLost
312
311
  */
313
- handleOnConnectionLost(): void;
312
+ bindOnConnectionLost(): void;
314
313
  /**
315
314
  * 5.2 SDK 尝试重新连接到服务器
316
315
  *
317
316
  * @event TRTCCallback#onTryToReconnect
318
317
  */
319
- handleOnTryToReconnect(): void;
318
+ bindOnTryToReconnect(): void;
320
319
  /**
321
320
  * 5.3 SDK 跟服务器的连接恢复
322
321
  *
323
322
  * @event TRTCCallback#onConnectionRecovery
324
323
  */
325
- handleOnConnectionRecovery(): void;
324
+ bindOnConnectionRecovery(): void;
326
325
  /**
327
- * 5.4 废弃事件:服务器测速的回调,SDK 对多个服务器 IP 做测速,每个 IP 的测速结果通过这个回调通知
326
+ * 5.4 废弃事件: 服务器测速的回调,SDK 对多个服务器 IP 做测速,每个 IP 的测速结果通过这个回调通知
327
+ *
328
+ * @deprecated 从 TRTCSDK 9.3 后该接口已被废弃,不会抛出该事件, 请采用 onSpeedTestResult 事件代替
328
329
  *
329
- * @deprecated
330
330
  * @event TRTCCallback#onSpeedTest
331
331
  * @param {TRTCSpeedTestResult} currentResult - 当前完成的测速结果
332
332
  * @param {Number} finishedCount - 已完成测速的服务器数量
@@ -336,9 +336,10 @@ declare class TRTCCloud extends EventEmitter {
336
336
  /**
337
337
  * 5.5 网速测试的结果回调
338
338
  *
339
+ * 该统计回调由 startSpeedTest 触发。
340
+ *
339
341
  * @event TRTCCallback#onSpeedTestResult
340
- * 该统计回调由 @link TRTCCloud#startSpeedTest 触发。
341
- * @param {TRTCSpeedTestResult} result - 网速测试数据数据,包括丢包、往返延迟、上下行的带宽速率,详情请参考 {@link TRTCSpeedTestResult}。
342
+ * @param {TRTCSpeedTestResult} result 网速测试数据数据,包括丢包、往返延迟、上下行的带宽速率。
342
343
  */
343
344
  bindOnSpeedTestResult(): void;
344
345
  /**
@@ -346,13 +347,13 @@ declare class TRTCCloud extends EventEmitter {
346
347
  *
347
348
  * @event TRTCCallback#onCameraDidReady
348
349
  */
349
- handleOnCameraDidReady(): void;
350
+ bindOnCameraDidReady(): void;
350
351
  /**
351
352
  * 6.2 麦克风准备就绪
352
353
  *
353
354
  * @event TRTCCallback#onMicDidReady
354
355
  */
355
- handleOnMicDidReady(): void;
356
+ bindOnMicDidReady(): void;
356
357
  /**
357
358
  * 6.3 userId 对应的成员语音音量
358
359
  *
@@ -374,7 +375,7 @@ declare class TRTCCloud extends EventEmitter {
374
375
  * @param {TRTCDeviceType} type - 设备类型
375
376
  * @param {TRTCDeviceState} state - 事件类型
376
377
  */
377
- handleOnDeviceChange(deviceId: string, type: TRTCDeviceType, state: TRTCDeviceState): void;
378
+ bindOnDeviceChange(): void;
378
379
  /**
379
380
  * 6.5 麦克风测试音量回调
380
381
  *
@@ -383,7 +384,7 @@ declare class TRTCCloud extends EventEmitter {
383
384
  * @event TRTCCallback#onTestMicVolume
384
385
  * @param {Number} volume - 音量值,取值范围0 - 100
385
386
  */
386
- handleOnTestMicVolume(volume: number): void;
387
+ bindOnTestMicVolume(): void;
387
388
  /**
388
389
  * 6.6 扬声器测试音量回调
389
390
  *
@@ -392,7 +393,7 @@ declare class TRTCCloud extends EventEmitter {
392
393
  * @event TRTCCallback#onTestSpeakerVolume
393
394
  * @param {Number} volume - 音量值,取值范围0 - 100
394
395
  */
395
- handleOnTestSpeakerVolume(volume: number): void;
396
+ bindOnTestSpeakerVolume(): void;
396
397
  /**
397
398
  * 6.7 当前音频采集设备音量变化回调
398
399
  *
@@ -402,7 +403,7 @@ declare class TRTCCloud extends EventEmitter {
402
403
  * @param {Number} volume - 音量值,取值范围0 - 100
403
404
  * @param {Boolean} muted - 当前采集音频设备是否被静音
404
405
  */
405
- handleOnAudioDeviceCaptureVolumeChanged(volume: number, muted: number): void;
406
+ bindOnAudioDeviceCaptureVolumeChanged(): void;
406
407
  /**
407
408
  * 6.8 当前音频播放设备音量变化回调
408
409
  *
@@ -412,7 +413,7 @@ declare class TRTCCloud extends EventEmitter {
412
413
  * @param {Number} volume - 音量值,取值范围0 - 100
413
414
  * @param {Boolean} muted - 当前音频播放设备是否被静音
414
415
  */
415
- handleOnAudioDevicePlayoutVolumeChanged(volume: number, muted: number): void;
416
+ bindOnAudioDevicePlayoutVolumeChanged(): void;
416
417
  /**
417
418
  * 7.1 收到自定义消息回调
418
419
  *
@@ -457,7 +458,7 @@ declare class TRTCCloud extends EventEmitter {
457
458
  * @param {Number} errCode - 0表示成功,其余值表示失败
458
459
  * @param {String} errMsg - 具体错误原因
459
460
  */
460
- handleOnStartPublishing(errCode: number, errMsg: string): void;
461
+ bindOnStartPublishing(): void;
461
462
  /**
462
463
  * 8.2 停止向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 [stopPublishing()]{@link TRTCCloud#stopPublishing} 接口
463
464
  *
@@ -465,7 +466,7 @@ declare class TRTCCloud extends EventEmitter {
465
466
  * @param {Number} errCode - 0表示成功,其余值表示失败
466
467
  * @param {String} errMsg - 具体错误原因
467
468
  */
468
- handleOnStopPublishing(errCode: number, errMsg: string): void;
469
+ bindOnStopPublishing(): void;
469
470
  /**
470
471
  * 8.3 旁路推流到 CDN 的回调
471
472
  *
@@ -477,7 +478,7 @@ declare class TRTCCloud extends EventEmitter {
477
478
  * @param {Number} errCode - 错误码
478
479
  * @param {String} errMsg - 错误详细信息
479
480
  */
480
- handleOnStartPublishCDNStream(errCode: number, errMsg: string): void;
481
+ bindOnStartPublishCDNStream(): void;
481
482
  /**
482
483
  * 8.4 停止旁路推流到 CDN 的回调
483
484
  *
@@ -487,7 +488,7 @@ declare class TRTCCloud extends EventEmitter {
487
488
  * @param {Number} errCode - 错误码
488
489
  * @param {String} errMsg - 错误详细信息
489
490
  */
490
- handleOnStopPublishCDNStream(errCode: number, errMsg: string): void;
491
+ bindOnStopPublishCDNStream(): void;
491
492
  /**
492
493
  * 8.5 设置云端的混流转码参数的回调
493
494
  *
@@ -497,7 +498,7 @@ declare class TRTCCloud extends EventEmitter {
497
498
  * @param {Number} errCode - 错误码
498
499
  * @param {String} errMsg - 错误详细信息
499
500
  */
500
- handleOnSetMixTranscodingConfig(errCode: number, errMsg: string): void;
501
+ bindOnSetMixTranscodingConfig(): void;
501
502
  /**
502
503
  * 9.1 废弃事件: 播放音效结束回调
503
504
  *
@@ -507,40 +508,40 @@ declare class TRTCCloud extends EventEmitter {
507
508
  * @param {Number} effectId - 音效 ID
508
509
  * @param {Number} code - 0表示播放正常结束;其他表示异常结束
509
510
  */
510
- handleOnAudioEffectFinished(effectId: number, code: number): void;
511
+ bindOnAudioEffectFinished(): void;
511
512
  /**
512
513
  * 10.1 当屏幕分享窗口被遮挡无法正常捕获时,SDK 会通过此回调通知,可在此回调里通知用户移开遮挡窗口
513
514
  *
514
515
  * @event TRTCCallback#onScreenCaptureCovered
515
516
  */
516
- handleOnScreenCaptureCovered(): void;
517
+ bindOnScreenCaptureCovered(): void;
517
518
  /**
518
519
  * 10.2 当屏幕分享开始时,SDK 会通过此回调通知
519
520
  *
520
521
  * @event TRTCCallback#onScreenCaptureStarted
521
522
  */
522
- handleOnScreenCaptureStarted(): void;
523
+ bindOnScreenCaptureStarted(): void;
523
524
  /**
524
525
  * 10.3 当屏幕分享暂停时,SDK 会通过此回调通知
525
526
  *
526
527
  * @event TRTCCallback#onScreenCapturePaused
527
528
  * @param {Number} reason - 停止原因,0:表示用户主动暂停;1:表示设置屏幕分享参数导致的暂停;2:表示屏幕分享窗口被最小化导致的暂停;3:表示屏幕分享窗口被隐藏导致的暂停
528
529
  */
529
- handleOnScreenCapturePaused(reason: number): void;
530
+ bindOnScreenCapturePaused(): void;
530
531
  /**
531
532
  * 10.4 当屏幕分享恢复时,SDK 会通过此回调通知
532
533
  *
533
534
  * @event TRTCCallback#onScreenCaptureResumed
534
535
  * @param {Number} reason - 停止原因,0:表示用户主动恢复,1:表示屏幕分享参数设置完毕后自动恢复;2:表示屏幕分享窗口从最小化被恢复;3:表示屏幕分享窗口从隐藏被恢复
535
536
  */
536
- handleOnScreenCaptureResumed(reason: number): void;
537
+ bindOnScreenCaptureResumed(): void;
537
538
  /**
538
539
  * 10.5 当屏幕分享停止时,SDK 会通过此回调通知
539
540
  *
540
541
  * @event TRTCCallback#onScreenCaptureStopped
541
542
  * @param {Number} reason - 停止原因,0:表示用户主动停止;1:表示屏幕分享窗口被关闭
542
543
  */
543
- handleOnScreenCaptureStopped(reason: number): void;
544
+ bindOnScreenCaptureStopped(): void;
544
545
  /**
545
546
  * 11.1 截图完成时回调
546
547
  *
@@ -552,7 +553,7 @@ declare class TRTCCloud extends EventEmitter {
552
553
  * @param {Number} width - 截图画面的宽度
553
554
  * @param {Number} height - 截图画面的高度
554
555
  */
555
- handleOnSnapshotComplete(userId: string, type: TRTCVideoStreamType, buffer: ArrayBuffer, width: number, height: number): void;
556
+ bindOnSnapshotComplete(): void;
556
557
  /**
557
558
  * 12.1 废弃事件: 开始播放背景音乐
558
559
  *
@@ -561,7 +562,8 @@ declare class TRTCCloud extends EventEmitter {
561
562
  * @event TRTCCallback#onPlayBGMBegin
562
563
  * @param {Number} errCode - 错误码
563
564
  */
564
- handleOnPlayBGMBegin(errCode: number): void;
565
+ bindOnPlayBGMBegin(): void;
566
+ bindOnMusicStart(): void;
565
567
  /**
566
568
  * 12.2 废弃事件: 播放背景音乐的进度
567
569
  *
@@ -571,7 +573,8 @@ declare class TRTCCloud extends EventEmitter {
571
573
  * @param {Number} progressMS - 已播放时间
572
574
  * @param {Number} durationMS - 总时间
573
575
  */
574
- handleOnPlayBGMProgress(progressMS: number, durationMS: number): void;
576
+ bindOnPlayBGMProgress(): void;
577
+ bindOnMusicPlayProgress(): void;
575
578
  /**
576
579
  * 12.3 废弃事件: 播放背景音乐结束
577
580
  *
@@ -580,7 +583,8 @@ declare class TRTCCloud extends EventEmitter {
580
583
  * @event TRTCCallback#onPlayBGMComplete
581
584
  * @param {Number} errCode - 错误码
582
585
  */
583
- handleOnPlayBGMComplete(errCode: number): void;
586
+ bindOnPlayBGMComplete(): void;
587
+ bindOnMusicComplete(): void;
584
588
  /**
585
589
  * 13.1 系统音频采集回调
586
590
  *
@@ -592,7 +596,7 @@ declare class TRTCCloud extends EventEmitter {
592
596
  * - ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED (-1331) :未授权安装音频驱动插件
593
597
  * - ERR_AUDIO_PLUGIN_INSTALL_FAILED (-1332) :安装音频驱动插件失败
594
598
  */
595
- handleOnSystemAudioLoopbackError(errCode: number): void;
599
+ bindOnSystemAudioLoopbackError(): void;
596
600
  /**
597
601
  * 1.1 进入房间
598
602
  *
@@ -851,12 +855,19 @@ declare class TRTCCloud extends EventEmitter {
851
855
  */
852
856
  stopLocalPreview(): void;
853
857
  /**
854
- * 3.3 是否屏蔽自己的视频画面
858
+ * 3.3 暂停/恢复发布本地的视频流
855
859
  *
856
- * 当屏蔽本地视频后,房间里的其它成员将会收到 onUserVideoAvailable 回调通知
857
- * @param {Boolean} mute - true:屏蔽;false:开启,默认值:false
860
+ * 该接口可以暂停(或恢复)发布本地的视频画面,暂停之后,同一房间中的其他用户将无法继续看到自己画面。
861
+ * 该接口在指定 TRTCVideoStreamTypeBig 时等效于 start/stopLocalPreview 这两个接口,但具有更好的响应速度。
862
+ * 因为 start/stopLocalPreview 需要打开和关闭摄像头,而打开和关闭摄像头都是硬件设备相关的操作,非常耗时。
863
+ * 相比之下,muteLocalVideo 只需要在软件层面对数据流进行暂停或者放行即可,因此效率更高,也更适合需要频繁打开关闭的场景。
864
+ * 当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后,同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
865
+ * 当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后,同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
866
+ *
867
+ * @param {Boolean} mute - true:屏蔽;false:开启,默认值:false
868
+ * @param {TRTCVideoStreamType} streamType - 要暂停/恢复的视频流类型, 仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub
858
869
  */
859
- muteLocalVideo(mute: boolean): void;
870
+ muteLocalVideo(mute: boolean, streamType?: TRTCVideoStreamType): void;
860
871
  /**
861
872
  * 3.4 开始显示远端视频画面
862
873
  *
@@ -892,8 +903,9 @@ declare class TRTCCloud extends EventEmitter {
892
903
  *
893
904
  * @param {String} userId - 对方的用户标识
894
905
  * @param {Boolean} mute - 是否停止接收
906
+ * @param {TRTCVideoStreamType} streamType - 视频流类型
895
907
  */
896
- muteRemoteVideoStream(userId: string, mute: boolean): void;
908
+ muteRemoteVideoStream(userId: string, mute: boolean, streamType?: TRTCVideoStreamType): void;
897
909
  /**
898
910
  * 3.8 停止接收所有远端视频流
899
911
  *
@@ -1172,10 +1184,15 @@ declare class TRTCCloud extends EventEmitter {
1172
1184
  * 注意:录音文件路径需精确到文件名及格式后缀,格式后缀决定录制文件的格式。
1173
1185
  * 例如:指定路径为 path/to/audio.aac,则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
1174
1186
  *
1175
- * @param {String} path - 录音文件路径(必填),录音文件的保存路径,该路径需要用户自行指定,请确保路径存在且可写。
1187
+ * @params {TRTCAudioRecordingParams} params - 录音参数。
1188
+ * @params {String} params.filePath - 文件路径(必填),录音文件的保存路径。该路径需要用户自行指定,请确保路径存在且可写
1189
+ * @params {TRTCAudioRecordingContent} params.recordingContent - 音频录制内容类型
1176
1190
  * @return {Number} 0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持
1191
+ *
1192
+ * 注意:
1193
+ * - 在 9.3 之前的版本,params 为 string 代表 录音文件路径(必填), 9.3 以及以后同时支持 string 类型和 TRTCAudioRecordingParams。
1177
1194
  */
1178
- startAudioRecording(path: string): number;
1195
+ startAudioRecording(params: TRTCAudioRecordingParams | string): number;
1179
1196
  /**
1180
1197
  * 4.13 停止录音
1181
1198
  *
@@ -1199,7 +1216,7 @@ declare class TRTCCloud extends EventEmitter {
1199
1216
  * 5.1 获取摄像头设备列表
1200
1217
  *
1201
1218
  * @example
1202
- * var cameralist = this.rtcCloud.getCameraDevicesList();
1219
+ * var cameralist = rtcCloud.getCameraDevicesList();
1203
1220
  * for (i=0;i<cameralist.length;i++) {
1204
1221
  * var camera = cameralist[i];
1205
1222
  * console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
@@ -1223,7 +1240,7 @@ declare class TRTCCloud extends EventEmitter {
1223
1240
  * 6.1 获取麦克风设备列表
1224
1241
  *
1225
1242
  * @example
1226
- * var miclist = this.rtcCloud.getMicDevicesList();
1243
+ * var miclist = rtcCloud.getMicDevicesList();
1227
1244
  * for (i=0;i<miclist.length;i++) {
1228
1245
  * var mic = miclist[i];
1229
1246
  * console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
@@ -1275,7 +1292,7 @@ declare class TRTCCloud extends EventEmitter {
1275
1292
  * 6.8 获取扬声器设备列表
1276
1293
  *
1277
1294
  * @example
1278
- * var speakerlist = this.rtcCloud.getSpeakerDevicesList();
1295
+ * var speakerlist = rtcCloud.getSpeakerDevicesList();
1279
1296
  * for (i=0;i<speakerlist.length;i++) {
1280
1297
  * var speaker = speakerlist[i];
1281
1298
  * console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
@@ -1440,6 +1457,11 @@ declare class TRTCCloud extends EventEmitter {
1440
1457
  * - 共享整个窗口:sourceInfoList 中 type 为 Window 的 source,captureRect 设为 { 0, 0, 0, 0 }
1441
1458
  * - 共享窗口区域:sourceInfoList 中 type 为 Window 的 source,captureRect 设为非 NULL,例如 { 100, 100, 300, 300 }
1442
1459
  *
1460
+ * @param {TRTCScreenCaptureSourceInfo} source - 指定分享源,详情参考TRTCScreenCaptureSourceInfo 定义
1461
+ * @param {Rect} captureRect - 指定捕获的区域
1462
+ * @param {TRTCScreenCaptureProperty} property - 指定屏幕分享目标的属性,包括捕获鼠标,高亮捕获窗口等,详情参考TRTCScreenCaptureProperty 定义
1463
+ *
1464
+ * 废弃参数使用方法(针对 9.3 以下版本):
1443
1465
  * @param {TRTCScreenCaptureSourceType} type - 采集源类型
1444
1466
  * - TRTCScreenCaptureSourceTypeWindow: 该分享目标是某一个Windows窗口
1445
1467
  * - TRTCScreenCaptureSourceTypeScreen: 该分享目标是整个Windows桌面
@@ -1454,7 +1476,7 @@ declare class TRTCCloud extends EventEmitter {
1454
1476
  * @param {Boolean} captureMouse - 指定是否捕获鼠标指针
1455
1477
  * @param {Boolean} highlightWindow - 指定是否高亮正在共享的窗口,以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡
1456
1478
  */
1457
- selectScreenCaptureTarget(type: number, sourceId: string, sourcename: string, captureRect: Rect, captureMouse: boolean, highlightWindow: boolean): any;
1479
+ selectScreenCaptureTarget(source: TRTCScreenCaptureSourceInfo | number, captureRect: Rect | string, property: TRTCScreenCaptureProperty | string, deprecatedCaptureRect?: Rect, captureMouse?: boolean, highlightWindow?: boolean): any;
1458
1480
  /**
1459
1481
  * 8.7 启动屏幕分享,支持选择使用主路或辅路进行屏幕分享。
1460
1482
  *
@@ -1851,16 +1873,21 @@ declare class TRTCCloud extends EventEmitter {
1851
1873
  * 测速结果将会用于优化 SDK 接下来的服务器选择策略,因此推荐您在用户首次通话前先进行一次测速,这将有助于我们选择最佳的服务器。
1852
1874
  * 同时,如果测试结果非常不理想,您可以通过醒目的 UI 提示用户选择更好的网络。
1853
1875
  *
1854
- * 注意:测速过程将产生少量的基础服务费用,详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
1876
+ * 注意:
1877
+ * 1. 测速过程将产生少量的基础服务费用,详见 [计费概述 > 基础服务](https://cloud.tencent.com/document/product/647/17157#.E5.9F.BA.E7.A1.80.E6.9C.8D.E5.8A.A1) 文档说明。
1878
+ * 2. 请在进入房间前进行网速测试,在房间中网速测试会影响正常的音视频传输效果,而且由于干扰过多,网速测试结果也不准确。
1879
+ * 3. 同一时间只允许一项网速测试任务运行。
1855
1880
  *
1856
- * @param {TRTCSpeedTestParams} params - 网络测速参数
1857
- * @param {Number} params.sdkAppId - 应用标识(必填)
1858
- * @param {String} params.userId - 用户标识(必填)
1859
- * @param {String} params.userSig - 用户签名(必填)
1860
- * @param {Number} params.expectedUpBandwidth - 预期的上行带宽(kbps,取值范围: 10 ~ 5000,为 0 时不测试)
1861
- * @param {Number} params.expectedDownBandwidth - 预期的下行带宽(kbps,取值范围: 10 ~ 5000,为 0 时不测试)。
1881
+ * @param {TRTCSpeedTestParams} params - 测速参数
1882
+ * @param {Number} params.sdkAppId - 应用标识
1883
+ * @param {String} params.userId - 用户标识
1884
+ * @param {String} params.userSig - 用户签名
1885
+ * @param {Number} params.expectedUpBandwidth - 预期的上行带宽(kbps,取值范围: 10 ~ 5000,为 0 时不测试)。
1886
+ * @param {Number} params.expectedDownBandwidth - 预期的下行带宽(kbps,取值范围: 10 ~ 5000,为 0 时不测试)。
1887
+ *
1888
+ * @return 接口调用结果,< 0:失败
1862
1889
  */
1863
- startSpeedTest(params: TRTCSpeedTestParams | number, userId?: string, userSig?: string): void;
1890
+ startSpeedTest(params: TRTCSpeedTestParams | number, userId?: string, userSig?: string): any;
1864
1891
  /**
1865
1892
  * 13.2 停止网络测速
1866
1893
  */