trtc-electron-sdk 10.3.8-beta.2 → 10.3.8-beta.20
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/Render/util.d.ts +1 -0
- package/liteav/Render/util.js +5 -1
- package/liteav/trtc.d.ts +103 -57
- package/liteav/trtc.js +407 -149
- package/liteav/trtc_define.d.ts +6 -6
- package/liteav/trtc_define.js +6 -7
- package/package.json +1 -1
- package/scripts/download.js +5 -26
package/liteav/Render/util.d.ts
CHANGED
package/liteav/Render/util.js
CHANGED
|
@@ -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
|
@@ -54,7 +54,17 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
54
54
|
*/
|
|
55
55
|
static destroyTRTCShareInstance(): void;
|
|
56
56
|
/**
|
|
57
|
-
*
|
|
57
|
+
* 获取 TRTC 配置对象
|
|
58
|
+
*
|
|
59
|
+
* 可以通过 TRTC 配置对象 {@link TRTCConfig} 打开 debug 模式
|
|
60
|
+
*
|
|
61
|
+
* @example
|
|
62
|
+
* // Enable 'debug' mode
|
|
63
|
+
* const TRTCCloud = require('trtc-electron-sdk');
|
|
64
|
+
* const rtcCloud = new TRTCCloud();
|
|
65
|
+
* rtcCloud.getConfigObject().setDebugMode(true);
|
|
66
|
+
*
|
|
67
|
+
* @returns {TRTCConfig}
|
|
58
68
|
*/
|
|
59
69
|
getConfigObject(): import("./Render/util").Config;
|
|
60
70
|
setExternalRenderEnabled(enabled: boolean): void;
|
|
@@ -194,11 +204,11 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
194
204
|
/**
|
|
195
205
|
* 3.3 用户是否开启摄像头视频
|
|
196
206
|
*
|
|
197
|
-
* 当您收到 onUserVideoAvailable(userId,
|
|
207
|
+
* 当您收到 onUserVideoAvailable(userId, 1) 通知时,代表该路画面已经有可用的视频数据帧到达。
|
|
198
208
|
* 之后,您需要调用 [startRemoteView()]{@link TRTCCloud#startRemoteView} 接口加载该用户的远程画面。
|
|
199
209
|
* 再之后,您还会收到名为 onFirstVideoFrame(userId) 的首帧画面渲染回调。
|
|
200
210
|
*
|
|
201
|
-
* 当您收到了 onUserVideoAvailable(userId,
|
|
211
|
+
* 当您收到了 onUserVideoAvailable(userId, 0) 通知时,代表该路远程画面已经被关闭,这可能是
|
|
202
212
|
* 由于该用户调用了 [muteLocalVideo()]{@link TRTCCloud#muteLocalVideo} 或 [stopLocalPreview()]{@link TRTCCloud#stopLocalPreview} 所致。
|
|
203
213
|
*
|
|
204
214
|
* @event TRTCCallback#onUserVideoAvailable
|
|
@@ -209,7 +219,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
209
219
|
/**
|
|
210
220
|
* 3.4 用户是否开启了辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)
|
|
211
221
|
*
|
|
212
|
-
* 注意:显示辅路画面使用的函数是
|
|
222
|
+
* 注意:显示辅路画面使用的函数是[startRemoteView()]{@link TRTCCloud#startRemoteView}, 从 8.0 版本开始已不再推荐使用 [startRemoteSubStreamView()]{@link TRTCCloud#startRemoteSubStreamView}。
|
|
213
223
|
*
|
|
214
224
|
* @event TRTCCallback#onUserSubStreamAvailable
|
|
215
225
|
* @param {String} userId - 用户标识
|
|
@@ -598,7 +608,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
598
608
|
* - ERR_AUDIO_PLUGIN_INSTALL_FAILED (-1332) :安装音频驱动插件失败
|
|
599
609
|
*/
|
|
600
610
|
handleOnSystemAudioLoopbackError(errCode: number): void;
|
|
601
|
-
|
|
611
|
+
handleVideoSizeChange(userId: string, streamType: number, width: number, height: number): void;
|
|
602
612
|
/**
|
|
603
613
|
* 1.1 进入房间
|
|
604
614
|
*
|
|
@@ -661,7 +671,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
661
671
|
*
|
|
662
672
|
* @param {TRTCSwitchRoomParam} params 房间切换参数,请参考 {@link TRTCSwitchRoomParam}
|
|
663
673
|
*
|
|
664
|
-
* 接口调用结果会通过
|
|
674
|
+
* 接口调用结果会通过 onSwitchRoom(errCode, errMsg) 事件回调通知给您。
|
|
665
675
|
*/
|
|
666
676
|
switchRoom(params: TRTCSwitchRoomParam): void;
|
|
667
677
|
/**
|
|
@@ -690,13 +700,13 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
690
700
|
* <pre>
|
|
691
701
|
* 房间 001 房间 002
|
|
692
702
|
* ------------- ------------
|
|
693
|
-
*
|
|
703
|
+
* 跨房连麦前: | 主播 A | | 主播 B |
|
|
694
704
|
* | 观众 U V W | | 观众 X Y Z |
|
|
695
705
|
* ------------- ------------
|
|
696
706
|
*
|
|
697
707
|
* 房间 001 房间 002
|
|
698
708
|
* ------------- ------------
|
|
699
|
-
*
|
|
709
|
+
* 跨房连麦后: | 主播 A B | | 主播 B A |
|
|
700
710
|
* | 观众 U V W | | 观众 X Y Z |
|
|
701
711
|
* ------------- ------------
|
|
702
712
|
* </pre>
|
|
@@ -809,6 +819,8 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
809
819
|
*
|
|
810
820
|
* 参考文档:[云端混流转码](https://cloud.tencent.com/document/product/647/16827)。
|
|
811
821
|
*
|
|
822
|
+
* 注意:混流转码为收费功能,调用接口将产生云端混流转码费用,详见 [云端混流转码计费说明](https://cloud.tencent.com/document/product/647/49446)。
|
|
823
|
+
*
|
|
812
824
|
* @note 关于云端混流的注意事项:
|
|
813
825
|
* - 云端转码会引入一定的 CDN 观看延时,大概会增加1 - 2秒。
|
|
814
826
|
* - 调用该函数的用户,会将连麦中的多路画面混合到自己当前这路画面中。
|
|
@@ -830,7 +842,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
830
842
|
* @param {String} config.streamId - 输出到 CDN 上的直播流 ID
|
|
831
843
|
* @param {TRTCMixUser[]} config.mixUsersArray - 每一路子画面的位置信息
|
|
832
844
|
* @param {String} config.mixUsersArray[].userId - 参与混流的 userId
|
|
833
|
-
* @param {String} config.mixUsersArray[].roomId - 参与混流的 roomId,跨房流传入的实际 roomId
|
|
845
|
+
* @param {String} config.mixUsersArray[].roomId - 参与混流的 roomId,跨房流传入的实际 roomId。当前房间流,请传入空字符串(roomId = '')。
|
|
834
846
|
* @param {Rect} config.mixUsersArray[].rect - 图层位置坐标以及大小,左上角为坐标原点(0,0) (绝对像素值)
|
|
835
847
|
* @param {Number} config.mixUsersArray[].rect.left - 图层位置的左坐标
|
|
836
848
|
* @param {Number} config.mixUsersArray[].rect.top - 图层位置的上坐标
|
|
@@ -855,16 +867,36 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
855
867
|
*/
|
|
856
868
|
stopLocalPreview(): void;
|
|
857
869
|
/**
|
|
858
|
-
* 3.3
|
|
870
|
+
* 3.3 修改本地摄像头预览的 HTML 元素
|
|
859
871
|
*
|
|
860
|
-
*
|
|
861
|
-
*
|
|
872
|
+
* 本接口用于切换显示区域的交互场景中,修改本地摄像头预览的 HTML 元素。
|
|
873
|
+
*
|
|
874
|
+
* 注意:必须在调用 [startLocalPreview()]{@link TRTCCloud#startLocalPreview} 接口开启本地摄像头采集后,调用本接口才会生效。
|
|
875
|
+
* - 如果用户调用 `startLocalPreview(view)` 接口开启了摄像头采集,则通过此接口可以修改摄像头采集视频渲染的 HTML 元素。
|
|
876
|
+
* - 如果用户调用 `startLocalPreview(null)` 接口开启了摄像头采集,但未开启本地预览,支持调用此接口开启预览。
|
|
877
|
+
*
|
|
878
|
+
* @param {HTMLElement|null} view - 接收本地摄像头采集视频渲染的 HTML 元素,传入 `null` 结束本地摄像头采集视频的预览。
|
|
879
|
+
* - 传入的 HTML 元素必须是块元素,比如:`div`
|
|
880
|
+
*/
|
|
881
|
+
updateLocalView(view: HTMLElement | null): void;
|
|
882
|
+
/**
|
|
883
|
+
* 3.3 暂停/恢复发布本地的视频流
|
|
884
|
+
*
|
|
885
|
+
* 该接口可以暂停(或恢复)发布本地的视频画面,暂停之后,同一房间中的其他用户将无法继续看到自己画面。
|
|
886
|
+
* 该接口在指定 TRTCVideoStreamTypeBig 时等效于 start/stopLocalPreview 这两个接口,但具有更好的响应速度。
|
|
887
|
+
* 因为 start/stopLocalPreview 需要打开和关闭摄像头,而打开和关闭摄像头都是硬件设备相关的操作,非常耗时。
|
|
888
|
+
* 相比之下,muteLocalVideo 只需要在软件层面对数据流进行暂停或者放行即可,因此效率更高,也更适合需要频繁打开关闭的场景。
|
|
889
|
+
* 当暂停/恢复发布指定 TRTCVideoStreamTypeBig 后,同一房间中的其他用户将会收到 onUserVideoAvailable 回调通知。
|
|
890
|
+
* 当暂停/恢复发布指定 TRTCVideoStreamTypeSub 后,同一房间中的其他用户将会收到 onUserSubStreamAvailable 回调通知。
|
|
891
|
+
*
|
|
892
|
+
* @param {Boolean} mute - true:屏蔽;false:开启,默认值:false
|
|
893
|
+
* @param {TRTCVideoStreamType} streamType - 要暂停/恢复的视频流类型, 仅支持 TRTCVideoStreamTypeBig 和 TRTCVideoStreamTypeSub
|
|
862
894
|
*/
|
|
863
895
|
muteLocalVideo(mute: boolean, streamType?: TRTCVideoStreamType): void;
|
|
864
896
|
/**
|
|
865
897
|
* 3.4 开始显示远端视频画面
|
|
866
898
|
*
|
|
867
|
-
* 在收到 SDK 的 onUserVideoAvailable(userId,
|
|
899
|
+
* 在收到 SDK 的 onUserVideoAvailable(userId, 1) 通知时,可以获知该远程用户开启了视频,
|
|
868
900
|
* 此后调用 startRemoteView(userId) 接口加载该用户的远程画面时,可以用 loading 动画优化加载过程中的等待体验。
|
|
869
901
|
* 待该用户的首帧画面开始显示时,您会收到 onFirstVideoFrame(userId) 事件回调。
|
|
870
902
|
*
|
|
@@ -882,6 +914,20 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
882
914
|
* @param {TRTCVideoStreamType} streamType - 视频流类型
|
|
883
915
|
*/
|
|
884
916
|
stopRemoteView(userId: string, streamType?: TRTCVideoStreamType): void;
|
|
917
|
+
/**
|
|
918
|
+
* 3.7 修改远端视频渲染的 HTML 元素
|
|
919
|
+
*
|
|
920
|
+
* 本接口用于切换显示区域的交互场景中,修改远端视频渲染的 HTML 元素。
|
|
921
|
+
*
|
|
922
|
+
* 注意:必须调用 [startRemoteView()]{@link TRTCCloud#startRemoteView} 订阅了远端视频流之后,调用此接口才会生效。
|
|
923
|
+
*
|
|
924
|
+
* @param {String} userId - 远端视频流的用户 ID
|
|
925
|
+
* @param {HTMLElement|null} view - 接受远端视频流渲染的 HTML 元素,传入 null 结束远端视频的渲染
|
|
926
|
+
* - 传入的 HTML 元素必须时块元素,例如:div
|
|
927
|
+
* @param {TRTCVideoStreamType} streamType - 视频流类型
|
|
928
|
+
*
|
|
929
|
+
*/
|
|
930
|
+
updateRemoteView(userId: string, view: HTMLElement | null, streamType: TRTCVideoStreamType): void;
|
|
885
931
|
/**
|
|
886
932
|
* 3.6 停止显示所有远端视频画面,同时不再拉取该远端用户的视频数据流
|
|
887
933
|
*
|
|
@@ -953,7 +999,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
953
999
|
*/
|
|
954
1000
|
setLocalViewFillMode(mode: TRTCVideoFillMode): void;
|
|
955
1001
|
/**
|
|
956
|
-
* 3.13
|
|
1002
|
+
* 3.13 设置远端画面的渲染模式
|
|
957
1003
|
*
|
|
958
1004
|
* @param {String} userId - 用户 ID
|
|
959
1005
|
* @param {TRTCVideoStreamType} streamType - 视频流类型
|
|
@@ -1048,11 +1094,11 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1048
1094
|
* 如果该 userId 没有开启双路编码模式,则此操作无效。
|
|
1049
1095
|
*
|
|
1050
1096
|
* @param {String} userId - 用户 ID
|
|
1051
|
-
* @param {TRTCVideoStreamType}
|
|
1097
|
+
* @param {TRTCVideoStreamType} streamType - 视频流类型,即选择看大画面还是小画面,默认为 TRTCVideoStreamTypeBig
|
|
1052
1098
|
* - TRTCVideoStreamTypeBig : 大画面视频流
|
|
1053
1099
|
* - TRTCVideoStreamTypeSmall: 小画面视频流
|
|
1054
1100
|
*/
|
|
1055
|
-
setRemoteVideoStreamType(userId: string,
|
|
1101
|
+
setRemoteVideoStreamType(userId: string, streamType: TRTCVideoStreamType): void;
|
|
1056
1102
|
/**
|
|
1057
1103
|
* 3.22 视频画面截图
|
|
1058
1104
|
*
|
|
@@ -1116,7 +1162,11 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1116
1162
|
*/
|
|
1117
1163
|
muteRemoteAudio(userId: string, mute: boolean): void;
|
|
1118
1164
|
/**
|
|
1119
|
-
* 4.5
|
|
1165
|
+
* 4.5 静音/取消静音所有远端用户的音频流
|
|
1166
|
+
*
|
|
1167
|
+
* 当您静音所有用户的远端音频时,SDK 会停止播放所有来自远端的音频流,同时也会停止拉取所有用户的音频数据。
|
|
1168
|
+
*
|
|
1169
|
+
* 注意:该接口支持您在进入房间(enterRoom)前调用,暂停状态会在退出房间(exitRoom)在之后会被重置。
|
|
1120
1170
|
*
|
|
1121
1171
|
* @param {Boolean} mute - true:静音;false:非静音
|
|
1122
1172
|
*/
|
|
@@ -1164,9 +1214,10 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1164
1214
|
* 我们在 Demo 中有一个音量大小的提示条,就是基于这个接口实现的。
|
|
1165
1215
|
* 如希望打开此功能,请在 startLocalAudio() 之前调用。
|
|
1166
1216
|
*
|
|
1167
|
-
* @param {Number} interval
|
|
1217
|
+
* @param {Number} interval - 设置 onUserVoiceVolume 回调的触发间隔,单位为ms,最小间隔为100ms,如果小于等于0则会关闭回调,建议设置为300ms
|
|
1218
|
+
* @param {Boolean} enableVad - true: 打开人声检测;false: 关闭人声检测。目前仅 windows 支持。
|
|
1168
1219
|
*/
|
|
1169
|
-
enableAudioVolumeEvaluation(interval: number): void;
|
|
1220
|
+
enableAudioVolumeEvaluation(interval: number, enableVad?: boolean): void;
|
|
1170
1221
|
/**
|
|
1171
1222
|
* 4.12 开始录音
|
|
1172
1223
|
*
|
|
@@ -1205,11 +1256,18 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1205
1256
|
* - TRTCAudioQualityMusic: 音乐模式:采样率:48k
|
|
1206
1257
|
*/
|
|
1207
1258
|
setAudioQuality(quality: TRTCAudioQuality): void;
|
|
1259
|
+
/**
|
|
1260
|
+
* 4.15 废弃接口:设置麦克风的音量大小
|
|
1261
|
+
*
|
|
1262
|
+
* @deprecated 从 TRTCSDK6.9 后该接口已被废弃,请使用 setAudioCaptureVolume 接口替代。
|
|
1263
|
+
* @param {Number} volume - 音量大小,100为正常音量,取值范围为0 - 200。
|
|
1264
|
+
*/
|
|
1265
|
+
setMicVolumeOnMixing(volume: number): void;
|
|
1208
1266
|
/**
|
|
1209
1267
|
* 5.1 获取摄像头设备列表
|
|
1210
1268
|
*
|
|
1211
1269
|
* @example
|
|
1212
|
-
* var cameralist =
|
|
1270
|
+
* var cameralist = rtcCloud.getCameraDevicesList();
|
|
1213
1271
|
* for (i=0;i<cameralist.length;i++) {
|
|
1214
1272
|
* var camera = cameralist[i];
|
|
1215
1273
|
* console.info("camera deviceName: " + camera.deviceName + " deviceId:" + camera.deviceId);
|
|
@@ -1233,7 +1291,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1233
1291
|
* 6.1 获取麦克风设备列表
|
|
1234
1292
|
*
|
|
1235
1293
|
* @example
|
|
1236
|
-
* var miclist =
|
|
1294
|
+
* var miclist = rtcCloud.getMicDevicesList();
|
|
1237
1295
|
* for (i=0;i<miclist.length;i++) {
|
|
1238
1296
|
* var mic = miclist[i];
|
|
1239
1297
|
* console.info("mic deviceName: " + mic.deviceName + " deviceId:" + mic.deviceId);
|
|
@@ -1285,7 +1343,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1285
1343
|
* 6.8 获取扬声器设备列表
|
|
1286
1344
|
*
|
|
1287
1345
|
* @example
|
|
1288
|
-
* var speakerlist =
|
|
1346
|
+
* var speakerlist = rtcCloud.getSpeakerDevicesList();
|
|
1289
1347
|
* for (i=0;i<speakerlist.length;i++) {
|
|
1290
1348
|
* var speaker = speakerlist[i];
|
|
1291
1349
|
* console.info("mic deviceName: " + speaker.deviceName + " deviceId:" + speaker.deviceId);
|
|
@@ -1308,10 +1366,6 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1308
1366
|
/**
|
|
1309
1367
|
* 6.11 获取系统当前扬声器设备音量
|
|
1310
1368
|
*
|
|
1311
|
-
* 注意:
|
|
1312
|
-
* - SDK6.7 及以下版本,windows 查询的不是系统扬声器的音量大小,mac 是查询系统扬声器音量大小
|
|
1313
|
-
* - SDK6.8 及以上版本,windows 和 mac 查询的都是系统扬声器的音量大小
|
|
1314
|
-
*
|
|
1315
1369
|
* @return {Number} 扬声器音量,范围0 - 100
|
|
1316
1370
|
*/
|
|
1317
1371
|
getCurrentSpeakerVolume(): any;
|
|
@@ -1319,8 +1373,6 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1319
1373
|
* 6.12 设置系统当前扬声器设备音量
|
|
1320
1374
|
*
|
|
1321
1375
|
* 注意:该接口的功能是调节系统播放音量,如果用户直接调节系统设置的播放音量时,该接口的设置结果会被用户的操作所覆盖。
|
|
1322
|
-
* - SDK6.7 及以下版本,windows 设置的不是系统扬声器的音量大小,mac 是设置系统扬声器音量大小
|
|
1323
|
-
* - SDK6.8 及以上版本,windows 和 mac 设置的都是系统扬声器的音量大小
|
|
1324
1376
|
*
|
|
1325
1377
|
* @param {Number} volume - 设置的扬声器音量,范围0 - 100
|
|
1326
1378
|
*/
|
|
@@ -1426,7 +1478,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1426
1478
|
* 8.5 枚举可共享的窗口列表
|
|
1427
1479
|
*
|
|
1428
1480
|
* 如果您要给您的 App 增加屏幕分享功能,一般需要先显示一个窗口选择界面,这样用户可以选择希望分享的窗口。
|
|
1429
|
-
*
|
|
1481
|
+
* 通过此函数,您可以获得可分享窗口的 ID、类型、窗口名称以及缩略图。
|
|
1430
1482
|
* 拿到这些信息后,您就可以实现一个窗口选择界面,当然,您也可以使用我们在 Demo 源码中已经实现好的一个界面。
|
|
1431
1483
|
*
|
|
1432
1484
|
* 注意:返回的列表中包括屏幕和应用窗口,屏幕会在列表的前面几个元素中。
|
|
@@ -1471,7 +1523,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1471
1523
|
*/
|
|
1472
1524
|
selectScreenCaptureTarget(source: TRTCScreenCaptureSourceInfo | number, captureRect: Rect | string, property: TRTCScreenCaptureProperty | string, deprecatedCaptureRect?: Rect, captureMouse?: boolean, highlightWindow?: boolean): any;
|
|
1473
1525
|
/**
|
|
1474
|
-
* 8.7
|
|
1526
|
+
* 8.7 启动屏幕分享,支持选择使用主路或辅路进行屏幕分享。
|
|
1475
1527
|
*
|
|
1476
1528
|
* 注意:
|
|
1477
1529
|
* 一个用户同时最多只能上传一条主路(TRTCVideoStreamTypeBig)画面和一条辅路(TRTCVideoStreamTypeSub)画面,
|
|
@@ -1495,12 +1547,14 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1495
1547
|
*/
|
|
1496
1548
|
stopScreenCapture(): void;
|
|
1497
1549
|
/**
|
|
1498
|
-
* 8.11
|
|
1550
|
+
* 8.11 设置屏幕分享(即辅路)的视频编码参数
|
|
1499
1551
|
*
|
|
1500
|
-
*
|
|
1501
|
-
* -
|
|
1552
|
+
* 该接口可以设定远端用户所看到的屏幕分享(即辅路)的画面质量,同时也能决定云端录制出的视频文件中屏幕分享的画面质量。 请注意如下两个接口的差异:
|
|
1553
|
+
* - setVideoEncoderParam() 用于设置主路画面(TRTCVideoStreamTypeBig,一般用于摄像头)的视频编码参数。
|
|
1554
|
+
* - setSubStreamEncoderParam() 用于设置辅路画面(TRTCVideoStreamTypeSub,一般用于屏幕分享)的视频编码参数。
|
|
1502
1555
|
*
|
|
1503
|
-
*
|
|
1556
|
+
* 注意:
|
|
1557
|
+
* 即使您使用主路传输屏幕分享(在调用 startScreenCapture 时设置 type=TRTCVideoStreamTypeBig),依然要使用 setSubStreamEncoderParam 设定屏幕分享的编码参数,而不要使用 setVideoEncoderParam 。
|
|
1504
1558
|
*
|
|
1505
1559
|
* @param {TRTCVideoEncParam} params - 辅流(屏幕分享)编码参数
|
|
1506
1560
|
* @param {TRTCVideoResolution} params.videoResolution - 视频分辨率
|
|
@@ -1773,7 +1827,13 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1773
1827
|
*/
|
|
1774
1828
|
seekMusicToPosInTime(id: number, pts: number): any;
|
|
1775
1829
|
/**
|
|
1776
|
-
* 11.19
|
|
1830
|
+
* 11.19 设置所有背景音乐的本地音量和远端音量的大小
|
|
1831
|
+
*
|
|
1832
|
+
* 该接口可以设置所有背景音乐的本地音量和远端音量。
|
|
1833
|
+
* - 本地音量:即主播本地可以听到的背景音乐的音量大小。
|
|
1834
|
+
* - 远端音量:即观众端可以听到的背景音乐的音量大小。
|
|
1835
|
+
*
|
|
1836
|
+
* 注意:如果将 volume 设置成 100 之后感觉音量还是太小,可以将 volume 最大设置成 150,但超过 100 的 volume 会有爆音的风险,请谨慎操作。
|
|
1777
1837
|
*
|
|
1778
1838
|
* @param {Number} volume - 音量大小,100为正常音量,取值范围为0 - 200。
|
|
1779
1839
|
*/
|
|
@@ -1886,15 +1946,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1886
1946
|
*/
|
|
1887
1947
|
stopSpeedTest(): void;
|
|
1888
1948
|
/**
|
|
1889
|
-
* 13.3
|
|
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 开始进行摄像头测试
|
|
1949
|
+
* 13.3 开始进行摄像头测试
|
|
1898
1950
|
*
|
|
1899
1951
|
* 会触发 onFirstVideoFrame 回调接口
|
|
1900
1952
|
*
|
|
@@ -1904,25 +1956,26 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1904
1956
|
*/
|
|
1905
1957
|
startCameraDeviceTest(view: HTMLElement): void;
|
|
1906
1958
|
/**
|
|
1907
|
-
* 13.
|
|
1959
|
+
* 13.4 停止摄像头测试
|
|
1908
1960
|
*/
|
|
1909
1961
|
stopCameraDeviceTest(): void;
|
|
1910
1962
|
/**
|
|
1911
|
-
* 13.
|
|
1963
|
+
* 13.5 开始进行麦克风测试
|
|
1912
1964
|
*
|
|
1913
1965
|
* 回调接口 onTestMicVolume 获取测试数据
|
|
1914
1966
|
*
|
|
1915
1967
|
* 该方法测试麦克风是否能正常工作,volume 的取值范围为0 - 100。
|
|
1916
1968
|
*
|
|
1917
1969
|
* @param {Number} interval - 反馈音量提示的时间间隔(ms),建议设置到大于 200 毫秒
|
|
1970
|
+
* @param {Boolean} playback - 是否开启回播麦克风声音,开启后用户测试麦克风时会听到自己的声音。默认值 true
|
|
1918
1971
|
*/
|
|
1919
|
-
startMicDeviceTest(interval: number): void;
|
|
1972
|
+
startMicDeviceTest(interval: number, playback?: boolean): void;
|
|
1920
1973
|
/**
|
|
1921
|
-
* 13.
|
|
1974
|
+
* 13.6 停止麦克风测试
|
|
1922
1975
|
*/
|
|
1923
1976
|
stopMicDeviceTest(): void;
|
|
1924
1977
|
/**
|
|
1925
|
-
* 13.
|
|
1978
|
+
* 13.7 开始进行扬声器测试
|
|
1926
1979
|
*
|
|
1927
1980
|
* 回调接口 onTestSpeakerVolume 获取测试数据
|
|
1928
1981
|
*
|
|
@@ -1932,7 +1985,7 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1932
1985
|
*/
|
|
1933
1986
|
startSpeakerDeviceTest(testAudioFilePath: string): void;
|
|
1934
1987
|
/**
|
|
1935
|
-
* 13.
|
|
1988
|
+
* 13.8 停止扬声器测试
|
|
1936
1989
|
*/
|
|
1937
1990
|
stopSpeakerDeviceTest(): void;
|
|
1938
1991
|
/**
|
|
@@ -1992,13 +2045,6 @@ declare class TRTCCloud extends EventEmitter {
|
|
|
1992
2045
|
* @param {String} jsonStr - 接口及参数描述的 JSON 字符串
|
|
1993
2046
|
*/
|
|
1994
2047
|
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
2048
|
addLocalVideoRenderCallback(): void;
|
|
2003
2049
|
addRemoteVideoRenderCallback(userId: string): void;
|
|
2004
2050
|
/**
|