trtc-electron-sdk 9.3.111-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 +107 -67
- package/liteav/trtc.js +547 -438
- package/liteav/trtc_define.d.ts +84 -12
- package/liteav/trtc_define.js +122 -12
- package/package.json +1 -1
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,
|
|
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
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
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
|
-
|
|
284
|
+
bindOnUserExit(): void;
|
|
286
285
|
/**
|
|
287
286
|
* 4.1 网络质量:该回调每2秒触发一次,统计当前网络的上行和下行质量
|
|
288
287
|
*
|
|
@@ -310,21 +309,23 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
310
309
|
*
|
|
311
310
|
* @event TRTCCallback#onConnectionLost
|
|
312
311
|
*/
|
|
313
|
-
|
|
312
|
+
bindOnConnectionLost(): void;
|
|
314
313
|
/**
|
|
315
314
|
* 5.2 SDK 尝试重新连接到服务器
|
|
316
315
|
*
|
|
317
316
|
* @event TRTCCallback#onTryToReconnect
|
|
318
317
|
*/
|
|
319
|
-
|
|
318
|
+
bindOnTryToReconnect(): void;
|
|
320
319
|
/**
|
|
321
320
|
* 5.3 SDK 跟服务器的连接恢复
|
|
322
321
|
*
|
|
323
322
|
* @event TRTCCallback#onConnectionRecovery
|
|
324
323
|
*/
|
|
325
|
-
|
|
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
330
|
* @event TRTCCallback#onSpeedTest
|
|
330
331
|
* @param {TRTCSpeedTestResult} currentResult - 当前完成的测速结果
|
|
@@ -332,18 +333,27 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
332
333
|
* @param {Number} totalCount - 需要测速的服务器总数量
|
|
333
334
|
*/
|
|
334
335
|
bindOnSpeedTest(): void;
|
|
336
|
+
/**
|
|
337
|
+
* 5.5 网速测试的结果回调
|
|
338
|
+
*
|
|
339
|
+
* 该统计回调由 startSpeedTest 触发。
|
|
340
|
+
*
|
|
341
|
+
* @event TRTCCallback#onSpeedTestResult
|
|
342
|
+
* @param {TRTCSpeedTestResult} result 网速测试数据数据,包括丢包、往返延迟、上下行的带宽速率。
|
|
343
|
+
*/
|
|
344
|
+
bindOnSpeedTestResult(): void;
|
|
335
345
|
/**
|
|
336
346
|
* 6.1 摄像头准备就绪
|
|
337
347
|
*
|
|
338
348
|
* @event TRTCCallback#onCameraDidReady
|
|
339
349
|
*/
|
|
340
|
-
|
|
350
|
+
bindOnCameraDidReady(): void;
|
|
341
351
|
/**
|
|
342
352
|
* 6.2 麦克风准备就绪
|
|
343
353
|
*
|
|
344
354
|
* @event TRTCCallback#onMicDidReady
|
|
345
355
|
*/
|
|
346
|
-
|
|
356
|
+
bindOnMicDidReady(): void;
|
|
347
357
|
/**
|
|
348
358
|
* 6.3 userId 对应的成员语音音量
|
|
349
359
|
*
|
|
@@ -365,7 +375,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
365
375
|
* @param {TRTCDeviceType} type - 设备类型
|
|
366
376
|
* @param {TRTCDeviceState} state - 事件类型
|
|
367
377
|
*/
|
|
368
|
-
|
|
378
|
+
bindOnDeviceChange(): void;
|
|
369
379
|
/**
|
|
370
380
|
* 6.5 麦克风测试音量回调
|
|
371
381
|
*
|
|
@@ -374,7 +384,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
374
384
|
* @event TRTCCallback#onTestMicVolume
|
|
375
385
|
* @param {Number} volume - 音量值,取值范围0 - 100
|
|
376
386
|
*/
|
|
377
|
-
|
|
387
|
+
bindOnTestMicVolume(): void;
|
|
378
388
|
/**
|
|
379
389
|
* 6.6 扬声器测试音量回调
|
|
380
390
|
*
|
|
@@ -383,7 +393,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
383
393
|
* @event TRTCCallback#onTestSpeakerVolume
|
|
384
394
|
* @param {Number} volume - 音量值,取值范围0 - 100
|
|
385
395
|
*/
|
|
386
|
-
|
|
396
|
+
bindOnTestSpeakerVolume(): void;
|
|
387
397
|
/**
|
|
388
398
|
* 6.7 当前音频采集设备音量变化回调
|
|
389
399
|
*
|
|
@@ -393,7 +403,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
393
403
|
* @param {Number} volume - 音量值,取值范围0 - 100
|
|
394
404
|
* @param {Boolean} muted - 当前采集音频设备是否被静音
|
|
395
405
|
*/
|
|
396
|
-
|
|
406
|
+
bindOnAudioDeviceCaptureVolumeChanged(): void;
|
|
397
407
|
/**
|
|
398
408
|
* 6.8 当前音频播放设备音量变化回调
|
|
399
409
|
*
|
|
@@ -403,7 +413,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
403
413
|
* @param {Number} volume - 音量值,取值范围0 - 100
|
|
404
414
|
* @param {Boolean} muted - 当前音频播放设备是否被静音
|
|
405
415
|
*/
|
|
406
|
-
|
|
416
|
+
bindOnAudioDevicePlayoutVolumeChanged(): void;
|
|
407
417
|
/**
|
|
408
418
|
* 7.1 收到自定义消息回调
|
|
409
419
|
*
|
|
@@ -448,7 +458,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
448
458
|
* @param {Number} errCode - 0表示成功,其余值表示失败
|
|
449
459
|
* @param {String} errMsg - 具体错误原因
|
|
450
460
|
*/
|
|
451
|
-
|
|
461
|
+
bindOnStartPublishing(): void;
|
|
452
462
|
/**
|
|
453
463
|
* 8.2 停止向腾讯云的直播 CDN 推流的回调,对应于 TRTCCloud 中的 [stopPublishing()]{@link TRTCCloud#stopPublishing} 接口
|
|
454
464
|
*
|
|
@@ -456,7 +466,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
456
466
|
* @param {Number} errCode - 0表示成功,其余值表示失败
|
|
457
467
|
* @param {String} errMsg - 具体错误原因
|
|
458
468
|
*/
|
|
459
|
-
|
|
469
|
+
bindOnStopPublishing(): void;
|
|
460
470
|
/**
|
|
461
471
|
* 8.3 旁路推流到 CDN 的回调
|
|
462
472
|
*
|
|
@@ -468,7 +478,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
468
478
|
* @param {Number} errCode - 错误码
|
|
469
479
|
* @param {String} errMsg - 错误详细信息
|
|
470
480
|
*/
|
|
471
|
-
|
|
481
|
+
bindOnStartPublishCDNStream(): void;
|
|
472
482
|
/**
|
|
473
483
|
* 8.4 停止旁路推流到 CDN 的回调
|
|
474
484
|
*
|
|
@@ -478,7 +488,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
478
488
|
* @param {Number} errCode - 错误码
|
|
479
489
|
* @param {String} errMsg - 错误详细信息
|
|
480
490
|
*/
|
|
481
|
-
|
|
491
|
+
bindOnStopPublishCDNStream(): void;
|
|
482
492
|
/**
|
|
483
493
|
* 8.5 设置云端的混流转码参数的回调
|
|
484
494
|
*
|
|
@@ -488,7 +498,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
488
498
|
* @param {Number} errCode - 错误码
|
|
489
499
|
* @param {String} errMsg - 错误详细信息
|
|
490
500
|
*/
|
|
491
|
-
|
|
501
|
+
bindOnSetMixTranscodingConfig(): void;
|
|
492
502
|
/**
|
|
493
503
|
* 9.1 废弃事件: 播放音效结束回调
|
|
494
504
|
*
|
|
@@ -498,40 +508,40 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
498
508
|
* @param {Number} effectId - 音效 ID
|
|
499
509
|
* @param {Number} code - 0表示播放正常结束;其他表示异常结束
|
|
500
510
|
*/
|
|
501
|
-
|
|
511
|
+
bindOnAudioEffectFinished(): void;
|
|
502
512
|
/**
|
|
503
513
|
* 10.1 当屏幕分享窗口被遮挡无法正常捕获时,SDK 会通过此回调通知,可在此回调里通知用户移开遮挡窗口
|
|
504
514
|
*
|
|
505
515
|
* @event TRTCCallback#onScreenCaptureCovered
|
|
506
516
|
*/
|
|
507
|
-
|
|
517
|
+
bindOnScreenCaptureCovered(): void;
|
|
508
518
|
/**
|
|
509
519
|
* 10.2 当屏幕分享开始时,SDK 会通过此回调通知
|
|
510
520
|
*
|
|
511
521
|
* @event TRTCCallback#onScreenCaptureStarted
|
|
512
522
|
*/
|
|
513
|
-
|
|
523
|
+
bindOnScreenCaptureStarted(): void;
|
|
514
524
|
/**
|
|
515
525
|
* 10.3 当屏幕分享暂停时,SDK 会通过此回调通知
|
|
516
526
|
*
|
|
517
527
|
* @event TRTCCallback#onScreenCapturePaused
|
|
518
528
|
* @param {Number} reason - 停止原因,0:表示用户主动暂停;1:表示设置屏幕分享参数导致的暂停;2:表示屏幕分享窗口被最小化导致的暂停;3:表示屏幕分享窗口被隐藏导致的暂停
|
|
519
529
|
*/
|
|
520
|
-
|
|
530
|
+
bindOnScreenCapturePaused(): void;
|
|
521
531
|
/**
|
|
522
532
|
* 10.4 当屏幕分享恢复时,SDK 会通过此回调通知
|
|
523
533
|
*
|
|
524
534
|
* @event TRTCCallback#onScreenCaptureResumed
|
|
525
535
|
* @param {Number} reason - 停止原因,0:表示用户主动恢复,1:表示屏幕分享参数设置完毕后自动恢复;2:表示屏幕分享窗口从最小化被恢复;3:表示屏幕分享窗口从隐藏被恢复
|
|
526
536
|
*/
|
|
527
|
-
|
|
537
|
+
bindOnScreenCaptureResumed(): void;
|
|
528
538
|
/**
|
|
529
539
|
* 10.5 当屏幕分享停止时,SDK 会通过此回调通知
|
|
530
540
|
*
|
|
531
541
|
* @event TRTCCallback#onScreenCaptureStopped
|
|
532
542
|
* @param {Number} reason - 停止原因,0:表示用户主动停止;1:表示屏幕分享窗口被关闭
|
|
533
543
|
*/
|
|
534
|
-
|
|
544
|
+
bindOnScreenCaptureStopped(): void;
|
|
535
545
|
/**
|
|
536
546
|
* 11.1 截图完成时回调
|
|
537
547
|
*
|
|
@@ -543,7 +553,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
543
553
|
* @param {Number} width - 截图画面的宽度
|
|
544
554
|
* @param {Number} height - 截图画面的高度
|
|
545
555
|
*/
|
|
546
|
-
|
|
556
|
+
bindOnSnapshotComplete(): void;
|
|
547
557
|
/**
|
|
548
558
|
* 12.1 废弃事件: 开始播放背景音乐
|
|
549
559
|
*
|
|
@@ -552,7 +562,8 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
552
562
|
* @event TRTCCallback#onPlayBGMBegin
|
|
553
563
|
* @param {Number} errCode - 错误码
|
|
554
564
|
*/
|
|
555
|
-
|
|
565
|
+
bindOnPlayBGMBegin(): void;
|
|
566
|
+
bindOnMusicStart(): void;
|
|
556
567
|
/**
|
|
557
568
|
* 12.2 废弃事件: 播放背景音乐的进度
|
|
558
569
|
*
|
|
@@ -562,7 +573,8 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
562
573
|
* @param {Number} progressMS - 已播放时间
|
|
563
574
|
* @param {Number} durationMS - 总时间
|
|
564
575
|
*/
|
|
565
|
-
|
|
576
|
+
bindOnPlayBGMProgress(): void;
|
|
577
|
+
bindOnMusicPlayProgress(): void;
|
|
566
578
|
/**
|
|
567
579
|
* 12.3 废弃事件: 播放背景音乐结束
|
|
568
580
|
*
|
|
@@ -571,7 +583,8 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
571
583
|
* @event TRTCCallback#onPlayBGMComplete
|
|
572
584
|
* @param {Number} errCode - 错误码
|
|
573
585
|
*/
|
|
574
|
-
|
|
586
|
+
bindOnPlayBGMComplete(): void;
|
|
587
|
+
bindOnMusicComplete(): void;
|
|
575
588
|
/**
|
|
576
589
|
* 13.1 系统音频采集回调
|
|
577
590
|
*
|
|
@@ -583,7 +596,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
583
596
|
* - ERR_AUDIO_PLUGIN_INSTALL_NOT_AUTHORIZED (-1331) :未授权安装音频驱动插件
|
|
584
597
|
* - ERR_AUDIO_PLUGIN_INSTALL_FAILED (-1332) :安装音频驱动插件失败
|
|
585
598
|
*/
|
|
586
|
-
|
|
599
|
+
bindOnSystemAudioLoopbackError(): void;
|
|
587
600
|
/**
|
|
588
601
|
* 1.1 进入房间
|
|
589
602
|
*
|
|
@@ -794,6 +807,8 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
794
807
|
*
|
|
795
808
|
* 参考文档:[云端混流转码](https://cloud.tencent.com/document/product/647/16827)。
|
|
796
809
|
*
|
|
810
|
+
* 注意:混流转码为收费功能,调用接口将产生云端混流转码费用,详见 [云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。
|
|
811
|
+
*
|
|
797
812
|
* @note 关于云端混流的注意事项:
|
|
798
813
|
* - 云端转码会引入一定的 CDN 观看延时,大概会增加1 - 2秒。
|
|
799
814
|
* - 调用该函数的用户,会将连麦中的多路画面混合到自己当前这路画面中。
|
|
@@ -840,12 +855,19 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
840
855
|
*/
|
|
841
856
|
stopLocalPreview(): void;
|
|
842
857
|
/**
|
|
843
|
-
* 3.3
|
|
858
|
+
* 3.3 暂停/恢复发布本地的视频流
|
|
844
859
|
*
|
|
845
|
-
*
|
|
846
|
-
*
|
|
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
|
|
847
869
|
*/
|
|
848
|
-
muteLocalVideo(mute: boolean): void;
|
|
870
|
+
muteLocalVideo(mute: boolean, streamType?: TRTCVideoStreamType): void;
|
|
849
871
|
/**
|
|
850
872
|
* 3.4 开始显示远端视频画面
|
|
851
873
|
*
|
|
@@ -881,8 +903,9 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
881
903
|
*
|
|
882
904
|
* @param {String} userId - 对方的用户标识
|
|
883
905
|
* @param {Boolean} mute - 是否停止接收
|
|
906
|
+
* @param {TRTCVideoStreamType} streamType - 视频流类型
|
|
884
907
|
*/
|
|
885
|
-
muteRemoteVideoStream(userId: string, mute: boolean): void;
|
|
908
|
+
muteRemoteVideoStream(userId: string, mute: boolean, streamType?: TRTCVideoStreamType): void;
|
|
886
909
|
/**
|
|
887
910
|
* 3.8 停止接收所有远端视频流
|
|
888
911
|
*
|
|
@@ -1161,10 +1184,15 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1161
1184
|
* 注意:录音文件路径需精确到文件名及格式后缀,格式后缀决定录制文件的格式。
|
|
1162
1185
|
* 例如:指定路径为 path/to/audio.aac,则会生成一个 AAC 格式的文件。目前支持的格式有 PCM, WAV, AAC
|
|
1163
1186
|
*
|
|
1164
|
-
* @
|
|
1187
|
+
* @params {TRTCAudioRecordingParams} params - 录音参数。
|
|
1188
|
+
* @params {String} params.filePath - 文件路径(必填),录音文件的保存路径。该路径需要用户自行指定,请确保路径存在且可写
|
|
1189
|
+
* @params {TRTCAudioRecordingContent} params.recordingContent - 音频录制内容类型
|
|
1165
1190
|
* @return {Number} 0:成功;-1:录音已开始;-2:文件或目录创建失败;-3:后缀指定的音频格式不支持
|
|
1191
|
+
*
|
|
1192
|
+
* 注意:
|
|
1193
|
+
* - 在 9.3 之前的版本,params 为 string 代表 录音文件路径(必填), 9.3 以及以后同时支持 string 类型和 TRTCAudioRecordingParams。
|
|
1166
1194
|
*/
|
|
1167
|
-
startAudioRecording(
|
|
1195
|
+
startAudioRecording(params: TRTCAudioRecordingParams | string): number;
|
|
1168
1196
|
/**
|
|
1169
1197
|
* 4.13 停止录音
|
|
1170
1198
|
*
|
|
@@ -1188,7 +1216,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1188
1216
|
* 5.1 获取摄像头设备列表
|
|
1189
1217
|
*
|
|
1190
1218
|
* @example
|
|
1191
|
-
* var cameralist =
|
|
1219
|
+
* var cameralist = rtcCloud.getCameraDevicesList();
|
|
1192
1220
|
* for (i=0;i<cameralist.length;i++) {
|
|
1193
1221
|
* var camera = cameralist[i];
|
|
1194
1222
|
* console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
|
|
@@ -1212,7 +1240,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1212
1240
|
* 6.1 获取麦克风设备列表
|
|
1213
1241
|
*
|
|
1214
1242
|
* @example
|
|
1215
|
-
* var miclist =
|
|
1243
|
+
* var miclist = rtcCloud.getMicDevicesList();
|
|
1216
1244
|
* for (i=0;i<miclist.length;i++) {
|
|
1217
1245
|
* var mic = miclist[i];
|
|
1218
1246
|
* console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
|
|
@@ -1264,7 +1292,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1264
1292
|
* 6.8 获取扬声器设备列表
|
|
1265
1293
|
*
|
|
1266
1294
|
* @example
|
|
1267
|
-
* var speakerlist =
|
|
1295
|
+
* var speakerlist = rtcCloud.getSpeakerDevicesList();
|
|
1268
1296
|
* for (i=0;i<speakerlist.length;i++) {
|
|
1269
1297
|
* var speaker = speakerlist[i];
|
|
1270
1298
|
* console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
|
|
@@ -1429,6 +1457,11 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1429
1457
|
* - 共享整个窗口:sourceInfoList 中 type 为 Window 的 source,captureRect 设为 { 0, 0, 0, 0 }
|
|
1430
1458
|
* - 共享窗口区域:sourceInfoList 中 type 为 Window 的 source,captureRect 设为非 NULL,例如 { 100, 100, 300, 300 }
|
|
1431
1459
|
*
|
|
1460
|
+
* @param {TRTCScreenCaptureSourceInfo} source - 指定分享源,详情参考TRTCScreenCaptureSourceInfo 定义
|
|
1461
|
+
* @param {Rect} captureRect - 指定捕获的区域
|
|
1462
|
+
* @param {TRTCScreenCaptureProperty} property - 指定屏幕分享目标的属性,包括捕获鼠标,高亮捕获窗口等,详情参考TRTCScreenCaptureProperty 定义
|
|
1463
|
+
*
|
|
1464
|
+
* 废弃参数使用方法(针对 9.3 以下版本):
|
|
1432
1465
|
* @param {TRTCScreenCaptureSourceType} type - 采集源类型
|
|
1433
1466
|
* - TRTCScreenCaptureSourceTypeWindow: 该分享目标是某一个Windows窗口
|
|
1434
1467
|
* - TRTCScreenCaptureSourceTypeScreen: 该分享目标是整个Windows桌面
|
|
@@ -1443,9 +1476,9 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1443
1476
|
* @param {Boolean} captureMouse - 指定是否捕获鼠标指针
|
|
1444
1477
|
* @param {Boolean} highlightWindow - 指定是否高亮正在共享的窗口,以及当捕获图像被遮挡时高亮遮挡窗口提示用户移走遮挡
|
|
1445
1478
|
*/
|
|
1446
|
-
selectScreenCaptureTarget(
|
|
1479
|
+
selectScreenCaptureTarget(source: TRTCScreenCaptureSourceInfo | number, captureRect: Rect | string, property: TRTCScreenCaptureProperty | string, deprecatedCaptureRect?: Rect, captureMouse?: boolean, highlightWindow?: boolean): any;
|
|
1447
1480
|
/**
|
|
1448
|
-
* 8.7
|
|
1481
|
+
* 8.7 启动屏幕分享,支持选择使用主路或辅路进行屏幕分享。
|
|
1449
1482
|
*
|
|
1450
1483
|
* 注意:
|
|
1451
1484
|
* 一个用户同时最多只能上传一条主路(TRTCVideoStreamTypeBig)画面和一条辅路(TRTCVideoStreamTypeSub)画面,
|
|
@@ -1840,13 +1873,21 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1840
1873
|
* 测速结果将会用于优化 SDK 接下来的服务器选择策略,因此推荐您在用户首次通话前先进行一次测速,这将有助于我们选择最佳的服务器。
|
|
1841
1874
|
* 同时,如果测试结果非常不理想,您可以通过醒目的 UI 提示用户选择更好的网络。
|
|
1842
1875
|
*
|
|
1843
|
-
*
|
|
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 时不测试)。
|
|
1844
1887
|
*
|
|
1845
|
-
* @
|
|
1846
|
-
* @param {String} userId - 用户标识
|
|
1847
|
-
* @param {String} userSig - 用户签名
|
|
1888
|
+
* @return 接口调用结果,< 0:失败
|
|
1848
1889
|
*/
|
|
1849
|
-
startSpeedTest(
|
|
1890
|
+
startSpeedTest(params: TRTCSpeedTestParams | number, userId?: string, userSig?: string): any;
|
|
1850
1891
|
/**
|
|
1851
1892
|
* 13.2 停止网络测速
|
|
1852
1893
|
*/
|
|
@@ -1976,7 +2017,6 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1976
2017
|
removePlugin(id: string): void;
|
|
1977
2018
|
getPluginList(): PluginInfo[];
|
|
1978
2019
|
createPlugin(pluginId: string): PluginInfo;
|
|
1979
|
-
setPluginCallback(pluginCb: (pluginId: string, errorCode: number, msg: string) => void): void;
|
|
1980
2020
|
getKey(uid: string, type: TRTCVideoStreamType): string;
|
|
1981
2021
|
/**
|
|
1982
2022
|
* 判断是否支持webGL
|