trtc-electron-sdk 9.3.201 → 9.3.301

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