@tencentcloud/tuiroom-engine-js 2.2.1 → 2.2.2
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/index.cjs.js +1 -1
- package/index.d.ts +930 -11
- package/index.esm.js +1 -1
- package/index.js +1 -1
- package/package.json +2 -2
- package/types.d.ts +18 -119
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tencentcloud/tuiroom-engine-js",
|
|
3
|
-
"version": "2.2.
|
|
3
|
+
"version": "2.2.2",
|
|
4
4
|
"description": "TUIRoomEngine Web SDK",
|
|
5
5
|
"main": "index.js",
|
|
6
6
|
"types": "index.d.ts",
|
|
@@ -20,6 +20,6 @@
|
|
|
20
20
|
"dependencies": {
|
|
21
21
|
"rtc-detect": "^0.0.5",
|
|
22
22
|
"@tencentcloud/chat": "^3.2.3",
|
|
23
|
-
"trtc-cloud-js-sdk": "^2.3.
|
|
23
|
+
"trtc-cloud-js-sdk": "^2.3.3"
|
|
24
24
|
}
|
|
25
25
|
}
|
package/types.d.ts
CHANGED
|
@@ -56,10 +56,9 @@ export type TUIRoomInfo = {
|
|
|
56
56
|
roomId: string;
|
|
57
57
|
roomName: string;
|
|
58
58
|
roomType: TUIRoomType;
|
|
59
|
-
|
|
60
|
-
seatMode: TUISeatMode;
|
|
59
|
+
speechMode: TUISpeechMode;
|
|
61
60
|
isMicrophoneDisableForAllUser: boolean;
|
|
62
|
-
isScreenShareDisableForAllUser
|
|
61
|
+
isScreenShareDisableForAllUser?: boolean;
|
|
63
62
|
isCameraDisableForAllUser: boolean;
|
|
64
63
|
isMessageDisableForAllUser: boolean;
|
|
65
64
|
maxSeatCount: number;
|
|
@@ -198,7 +197,7 @@ export declare enum TUIRequestAction {
|
|
|
198
197
|
kRequestRemoteUserOnSeat = 5,
|
|
199
198
|
kApplyToAdminToOpenLocalCamera = 6,
|
|
200
199
|
kApplyToAdminToOpenLocalMicrophone = 7,
|
|
201
|
-
kApplyToAdminToOpenLocalScreenShare = 8
|
|
200
|
+
kApplyToAdminToOpenLocalScreenShare = 8,
|
|
202
201
|
}
|
|
203
202
|
export declare enum TUIRequestCallbackType {
|
|
204
203
|
kRequestAccepted = 0,
|
|
@@ -246,31 +245,6 @@ export type TUIRequestCallback = {
|
|
|
246
245
|
code: number;
|
|
247
246
|
message: string;
|
|
248
247
|
};
|
|
249
|
-
export declare enum TUIMediaDeviceType {
|
|
250
|
-
kMediaDeviceTypeUnknown = -1,
|
|
251
|
-
kMediaDeviceTypeAudioInput = 0,
|
|
252
|
-
kMediaDeviceTypeAudioOutput = 1,
|
|
253
|
-
kMediaDeviceTypeVideoCamera = 2
|
|
254
|
-
}
|
|
255
|
-
export declare enum TUIMediaDeviceState {
|
|
256
|
-
kMediaDeviceStateAdd = 0,
|
|
257
|
-
kMediaDeviceStateRemove = 1,
|
|
258
|
-
kMediaDeviceStateActive = 2
|
|
259
|
-
}
|
|
260
|
-
export declare enum TUIAudioRoute {
|
|
261
|
-
kAudioRouteSpeakerphone = 0,
|
|
262
|
-
kAudioRouteEarpiece = 1
|
|
263
|
-
}
|
|
264
|
-
export type TUIDeviceInfo = {
|
|
265
|
-
deviceId: string;
|
|
266
|
-
deviceName: string;
|
|
267
|
-
deviceProperties?: {
|
|
268
|
-
supportedResolution?: {
|
|
269
|
-
width: number;
|
|
270
|
-
height: number;
|
|
271
|
-
}[];
|
|
272
|
-
};
|
|
273
|
-
};
|
|
274
248
|
/**
|
|
275
249
|
* **TUIRoomEngine 事件列表**<br>
|
|
276
250
|
* @namespace TUIRoomEvents
|
|
@@ -362,7 +336,6 @@ export declare enum TUIRoomEvents {
|
|
|
362
336
|
onRoomNameChanged = "onRoomNameChanged",
|
|
363
337
|
/**
|
|
364
338
|
* @description 房间模式修改事件
|
|
365
|
-
* @deprecated 该事件自 v2.0.0 版本废弃
|
|
366
339
|
* @default 'onRoomSpeechModeChanged'
|
|
367
340
|
* @event TUIRoomEvents#onRoomSpeechModeChanged
|
|
368
341
|
* @param {object} options
|
|
@@ -374,19 +347,7 @@ export declare enum TUIRoomEvents {
|
|
|
374
347
|
* });
|
|
375
348
|
*/
|
|
376
349
|
onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
|
|
377
|
-
|
|
378
|
-
* @description 上麦模式修改事件
|
|
379
|
-
* @default 'onRoomSeatModeChanged'
|
|
380
|
-
* @event TUIRoomEvents#onRoomSeatModeChanged
|
|
381
|
-
* @param {object} options
|
|
382
|
-
* @param {TUISeatMode} options.seatMode 房间上麦模式
|
|
383
|
-
* @example
|
|
384
|
-
* const roomEngine = new TUIRoomEngine();
|
|
385
|
-
* roomEngine.on(TUIRoomEvents.onRoomSeatModeChanged, ({ roomId, seatMode }) =>{
|
|
386
|
-
* console.log('roomEngine.onRoomSeatModeChanged', roomId, seatMode);
|
|
387
|
-
* });
|
|
388
|
-
*/
|
|
389
|
-
onRoomSeatModeChanged = "onRoomSeatModeChanged",
|
|
350
|
+
|
|
390
351
|
/**
|
|
391
352
|
* @description 所有成员摄像头使用权限改变事件
|
|
392
353
|
* @default 'onAllUserCameraDisableChanged'
|
|
@@ -400,20 +361,6 @@ export declare enum TUIRoomEvents {
|
|
|
400
361
|
* });
|
|
401
362
|
*/
|
|
402
363
|
onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
|
|
403
|
-
/**
|
|
404
|
-
* @since v2.2.0
|
|
405
|
-
* @description 房间内所有用户屏幕分享被禁用事件
|
|
406
|
-
* @default 'onScreenShareForAllUserDisableChanged'
|
|
407
|
-
* @event TUIRoomEvents#onScreenShareForAllUserDisableChanged
|
|
408
|
-
* @param {object} options
|
|
409
|
-
* @param {boolean} options.isDisable 是否开启禁止屏幕分享
|
|
410
|
-
* @example
|
|
411
|
-
* const roomEngine = new TUIRoomEngine();
|
|
412
|
-
* roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
|
|
413
|
-
* console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
|
|
414
|
-
* });
|
|
415
|
-
*/
|
|
416
|
-
onScreenShareForAllUserDisableChanged = "onScreenShareForAllUserDisableChanged",
|
|
417
364
|
/**
|
|
418
365
|
* @description 所有成员麦克风使用权限改变事件
|
|
419
366
|
* @default 'onAllUserMicrophoneDisableChanged'
|
|
@@ -427,6 +374,20 @@ export declare enum TUIRoomEvents {
|
|
|
427
374
|
* });
|
|
428
375
|
*/
|
|
429
376
|
onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
|
|
377
|
+
/**
|
|
378
|
+
* @since v2.2.0
|
|
379
|
+
* @description 房间内所有用户屏幕分享被禁用事件
|
|
380
|
+
* @default 'onScreenShareForAllUserDisableChanged'
|
|
381
|
+
* @event TUIRoomEvents#onScreenShareForAllUserDisableChanged
|
|
382
|
+
* @param {object} options
|
|
383
|
+
* @param {boolean} options.isDisable 是否禁止打开屏幕分享
|
|
384
|
+
* @example
|
|
385
|
+
* const roomEngine = new TUIRoomEngine();
|
|
386
|
+
* roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
|
|
387
|
+
* console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
|
|
388
|
+
* });
|
|
389
|
+
*/
|
|
390
|
+
onScreenShareForAllUserDisableChanged = 'onScreenShareForAllUserDisableChanged',
|
|
430
391
|
/**
|
|
431
392
|
* @description 所有成员发送消息权限改变事件
|
|
432
393
|
* @default 'onSendMessageForAllUserDisableChanged'
|
|
@@ -624,23 +585,8 @@ export declare enum TUIRoomEvents {
|
|
|
624
585
|
* });
|
|
625
586
|
*/
|
|
626
587
|
onRequestCancelled = "onRequestCancelled",
|
|
627
|
-
/**
|
|
628
|
-
* @description 请求被其他 管理员/房主 处理事件
|
|
629
|
-
* @default 'onRequestProcessed'
|
|
630
|
-
* @event TUIRoomEvents#onRequestProcessed
|
|
631
|
-
* @param {object} options
|
|
632
|
-
* @param {string} options.requestId 请求Id
|
|
633
|
-
* @param {string} options.userId 处理该请求的 管理员/房主 的用户ID
|
|
634
|
-
* @example
|
|
635
|
-
* const roomEngine = new TUIRoomEngine();
|
|
636
|
-
* roomEngine.on(TUIRoomEvents.onRequestProcessed, ({ requestId, userId }) => {
|
|
637
|
-
* console.log('roomEngine.onRequestProcessed', requestId, userId);
|
|
638
|
-
* });
|
|
639
|
-
*/
|
|
640
|
-
onRequestProcessed = "onRequestProcessed",
|
|
641
588
|
/**
|
|
642
589
|
* @description 接收文本消息事件
|
|
643
|
-
* @deprecated 该接口自 v2.0.0 版本废弃,请使用 tim 实例监听收消息事件
|
|
644
590
|
* @default 'onReceiveTextMessage'
|
|
645
591
|
* @event TUIRoomEvents#onReceiveTextMessage
|
|
646
592
|
* @param {object} options
|
|
@@ -655,7 +601,6 @@ export declare enum TUIRoomEvents {
|
|
|
655
601
|
onReceiveTextMessage = "onReceiveTextMessage",
|
|
656
602
|
/**
|
|
657
603
|
* @description 接收自定义消息事件
|
|
658
|
-
* @deprecated 该接口自 v2.0.0 版本废弃,请使用 tim 实例监听收消息事件
|
|
659
604
|
* @default 'onReceiveCustomMessage'
|
|
660
605
|
* @event TUIRoomEvents#onReceiveCustomMessage
|
|
661
606
|
* @param {object} options
|
|
@@ -695,49 +640,3 @@ export declare enum TUIRoomEvents {
|
|
|
695
640
|
*/
|
|
696
641
|
onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
|
|
697
642
|
}
|
|
698
|
-
export declare enum TUIRoomDeviceMangerEvents {
|
|
699
|
-
/**
|
|
700
|
-
* @description 设备变更事件
|
|
701
|
-
* @default 'onDeviceChange'
|
|
702
|
-
* @event TUIRoomDeviceMangerEvents#onDeviceChange
|
|
703
|
-
* @param {object} options
|
|
704
|
-
* @param {string} options.deviceId 设备 Id
|
|
705
|
-
* @param {TRTCDeviceType} options.type 设备类型
|
|
706
|
-
* @param {TRTCDeviceState} options.state 设备变更状态
|
|
707
|
-
* @example
|
|
708
|
-
* const roomEngine = new TUIRoomEngine();
|
|
709
|
-
* const deviceManager = roomEngine.getDeviceManager();
|
|
710
|
-
* deviceManager.on(TUIRoomDeviceMangerEvents.onDeviceChange, ({ deviceId, type, state }) => {
|
|
711
|
-
* console.log('deviceManager.onDeviceChange', deviceId, type, state);
|
|
712
|
-
* });
|
|
713
|
-
*/
|
|
714
|
-
onDeviceChanged = "onDeviceChanged",
|
|
715
|
-
/**
|
|
716
|
-
* @description 麦克风测试音量
|
|
717
|
-
* @default 'onTestMicVolume'
|
|
718
|
-
* @event TUIRoomDeviceMangerEvents#onTestMicVolume
|
|
719
|
-
* @param {object} options
|
|
720
|
-
* @param {number} options.volume 麦克风测试音量(0-100)
|
|
721
|
-
* @example
|
|
722
|
-
* const roomEngine = new TUIRoomEngine();
|
|
723
|
-
* const deviceManager = roomEngine.getDeviceManager();
|
|
724
|
-
* deviceManager.on(TUIRoomDeviceMangerEvents.onTestMicVolume, ({ volume }) => {
|
|
725
|
-
* console.log('deviceManager.onTestMicVolume', volume);
|
|
726
|
-
* });
|
|
727
|
-
*/
|
|
728
|
-
onTestMicVolume = "onTestMicVolume",
|
|
729
|
-
/**
|
|
730
|
-
* @description 扬声器测试音量,仅 Electron 端支持
|
|
731
|
-
* @default 'onTestSpeakerVolume'
|
|
732
|
-
* @event TUIRoomDeviceMangerEvents#onTestSpeakerVolume
|
|
733
|
-
* @param {object} options
|
|
734
|
-
* @param {number} options.volume 扬声器测试音量(0-100)
|
|
735
|
-
* @example
|
|
736
|
-
* const roomEngine = new TUIRoomEngine();
|
|
737
|
-
* const deviceManager = roomEngine.getDeviceManager();
|
|
738
|
-
* deviceManager.on(TUIRoomDeviceMangerEvents.onTestSpeakerVolume, ({ volume }) => {
|
|
739
|
-
* console.log('deviceManager.onTestSpeakerVolume', volume);
|
|
740
|
-
* });
|
|
741
|
-
*/
|
|
742
|
-
onTestSpeakerVolume = "onTestSpeakerVolume"
|
|
743
|
-
}
|