@tencentcloud/tuiroom-engine-electron 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 +1 -1
- package/types.d.ts +15 -121
package/package.json
CHANGED
package/types.d.ts
CHANGED
|
@@ -56,8 +56,7 @@ 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
61
|
isScreenShareDisableForAllUser: boolean;
|
|
63
62
|
isCameraDisableForAllUser: boolean;
|
|
@@ -167,10 +166,6 @@ export declare enum TUISpeechMode {
|
|
|
167
166
|
kApplyToSpeak = 2,
|
|
168
167
|
kSpeakAfterTakingSeat = 3
|
|
169
168
|
}
|
|
170
|
-
export declare enum TUISeatMode {
|
|
171
|
-
kFreeToTake = 1,
|
|
172
|
-
kApplyToTake = 2
|
|
173
|
-
}
|
|
174
169
|
export declare enum TUIMediaDevice {
|
|
175
170
|
kMicrophone = 1,
|
|
176
171
|
kCamera = 2,
|
|
@@ -198,7 +193,7 @@ export declare enum TUIRequestAction {
|
|
|
198
193
|
kRequestRemoteUserOnSeat = 5,
|
|
199
194
|
kApplyToAdminToOpenLocalCamera = 6,
|
|
200
195
|
kApplyToAdminToOpenLocalMicrophone = 7,
|
|
201
|
-
kApplyToAdminToOpenLocalScreenShare = 8
|
|
196
|
+
kApplyToAdminToOpenLocalScreenShare = 8,
|
|
202
197
|
}
|
|
203
198
|
export declare enum TUIRequestCallbackType {
|
|
204
199
|
kRequestAccepted = 0,
|
|
@@ -246,31 +241,6 @@ export type TUIRequestCallback = {
|
|
|
246
241
|
code: number;
|
|
247
242
|
message: string;
|
|
248
243
|
};
|
|
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
244
|
/**
|
|
275
245
|
* **TUIRoomEngine 事件列表**<br>
|
|
276
246
|
* @namespace TUIRoomEvents
|
|
@@ -362,7 +332,6 @@ export declare enum TUIRoomEvents {
|
|
|
362
332
|
onRoomNameChanged = "onRoomNameChanged",
|
|
363
333
|
/**
|
|
364
334
|
* @description 房间模式修改事件
|
|
365
|
-
* @deprecated 该事件自 v2.0.0 版本废弃
|
|
366
335
|
* @default 'onRoomSpeechModeChanged'
|
|
367
336
|
* @event TUIRoomEvents#onRoomSpeechModeChanged
|
|
368
337
|
* @param {object} options
|
|
@@ -374,19 +343,6 @@ export declare enum TUIRoomEvents {
|
|
|
374
343
|
* });
|
|
375
344
|
*/
|
|
376
345
|
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",
|
|
390
346
|
/**
|
|
391
347
|
* @description 所有成员摄像头使用权限改变事件
|
|
392
348
|
* @default 'onAllUserCameraDisableChanged'
|
|
@@ -414,19 +370,19 @@ export declare enum TUIRoomEvents {
|
|
|
414
370
|
*/
|
|
415
371
|
onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
|
|
416
372
|
/**
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
onScreenShareForAllUserDisableChanged =
|
|
373
|
+
* @since v2.2.0
|
|
374
|
+
* @description 房间内所有用户屏幕分享被禁用事件
|
|
375
|
+
* @default 'onScreenShareForAllUserDisableChanged'
|
|
376
|
+
* @event TUIRoomEvents#onScreenShareForAllUserDisableChanged
|
|
377
|
+
* @param {object} options
|
|
378
|
+
* @param {boolean} options.isDisable 是否开启禁止屏幕分享
|
|
379
|
+
* @example
|
|
380
|
+
* const roomEngine = new TUIRoomEngine();
|
|
381
|
+
* roomEngine.on(TUIRoomEvents.onScreenShareForAllUserDisableChanged, ({ isDisable }) =>{
|
|
382
|
+
* console.log('roomEngine.onScreenShareForAllUserDisableChanged', isDisable);
|
|
383
|
+
* });
|
|
384
|
+
*/
|
|
385
|
+
onScreenShareForAllUserDisableChanged = 'onScreenShareForAllUserDisableChanged',
|
|
430
386
|
/**
|
|
431
387
|
* @description 所有成员发送消息权限改变事件
|
|
432
388
|
* @default 'onSendMessageForAllUserDisableChanged'
|
|
@@ -624,23 +580,8 @@ export declare enum TUIRoomEvents {
|
|
|
624
580
|
* });
|
|
625
581
|
*/
|
|
626
582
|
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
583
|
/**
|
|
642
584
|
* @description 接收文本消息事件
|
|
643
|
-
* @deprecated 该接口自 v2.0.0 版本废弃,请使用 tim 实例监听收消息事件
|
|
644
585
|
* @default 'onReceiveTextMessage'
|
|
645
586
|
* @event TUIRoomEvents#onReceiveTextMessage
|
|
646
587
|
* @param {object} options
|
|
@@ -655,7 +596,6 @@ export declare enum TUIRoomEvents {
|
|
|
655
596
|
onReceiveTextMessage = "onReceiveTextMessage",
|
|
656
597
|
/**
|
|
657
598
|
* @description 接收自定义消息事件
|
|
658
|
-
* @deprecated 该接口自 v2.0.0 版本废弃,请使用 tim 实例监听收消息事件
|
|
659
599
|
* @default 'onReceiveCustomMessage'
|
|
660
600
|
* @event TUIRoomEvents#onReceiveCustomMessage
|
|
661
601
|
* @param {object} options
|
|
@@ -695,49 +635,3 @@ export declare enum TUIRoomEvents {
|
|
|
695
635
|
*/
|
|
696
636
|
onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
|
|
697
637
|
}
|
|
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
|
-
}
|