@tencentcloud/tuiroom-engine-electron 2.2.2 → 2.3.3

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/package.json CHANGED
@@ -1,8 +1,9 @@
1
1
  {
2
2
  "name": "@tencentcloud/tuiroom-engine-electron",
3
- "version": "2.2.2",
3
+ "version": "2.3.3",
4
4
  "description": "TUIRoomEngine Electron SDK",
5
5
  "main": "index.js",
6
+ "module": "index.esm.js",
6
7
  "types": "index.d.ts",
7
8
  "keywords": [
8
9
  "tuiroom",
@@ -19,7 +20,7 @@
19
20
  "license": "ISC",
20
21
  "dependencies": {
21
22
  "rtc-detect": "^0.0.5",
22
- "@tencentcloud/chat": "^3.2.3",
23
- "trtc-electron-sdk": "11.6.504-beta.0"
23
+ "@tencentcloud/chat": "latest",
24
+ "trtc-electron-sdk": "11.7.603"
24
25
  }
25
- }
26
+ }
package/types.d.ts DELETED
@@ -1,637 +0,0 @@
1
- export declare enum TUIErrorCode {
2
- ERR_SUCC = 0,
3
- ERR_FAILED = -1,
4
- ERR_FREQ_LIMIT = -2,
5
- ERR_REPEAT_OPERATION = -3,
6
- ERR_SDKAPPID_NOT_FOUND = -1000,
7
- ERR_INVALID_PARAMETER = -1001,
8
- ERR_SDK_NOT_INITIALIZED = -1002,
9
- ERR_PERMISSION_DENIED = -1003,
10
- ERR_REQUIRE_PAYMENT = -1004,
11
- ERR_CAMERA_START_FAILED = -1100,
12
- ERR_CAMERA_NOT_AUTHORIZED = -1101,
13
- ERR_CAMERA_OCCUPIED = -1102,
14
- ERR_CAMERA_DEVICE_EMPTY = -1103,
15
- ERR_MICROPHONE_START_FAILED = -1104,
16
- ERR_MICROPHONE_NOT_AUTHORIZED = -1105,
17
- ERR_MICROPHONE_OCCUPIED = -1106,
18
- ERR_MICROPHONE_DEVICE_EMPTY = -1107,
19
- ERR_GET_SCREEN_SHARING_TARGET_FAILED = -1108,
20
- ERR_START_SCREEN_SHARING_FAILED = -1109,
21
- ERR_ROOM_ID_NOT_EXIST = -2100,
22
- ERR_OPERATION_INVALID_BEFORE_ENTER_ROOM = -2101,
23
- ERR_EXIT_NOT_SUPPORTED_FOR_ROOM_OWNER = -2102,
24
- ERR_OPERATION_NOT_SUPPORTED_IN_CURRENT_ROOM_TYPE = -2103,
25
- ERR_OPERATION_NOT_SUPPORTED_IN_CURRENT_SPEECH_MODE = -2104,
26
- ERR_ROOM_ID_INVALID = -2105,
27
- ERR_ROOM_ID_OCCUPIED = -2106,
28
- ERR_ROOM_NAME_INVALID = -2107,
29
- ERR_ALREADY_IN_OTHER_ROOM = -2108,
30
- ERR_USER_NOT_EXIST = -2200,
31
- ERR_USER_NOT_ENTERED = -2201,
32
- ERR_NEED_OWNER_PERMISSION = -2300,
33
- ERR_NEED_ADMIN_PERMISSION = -2301,
34
- ERR_REQUEST_NO_PERMISSION = -2310,
35
- ERR_REQUEST_ID_INVALID = -2311,
36
- ERR_REQUEST_ID_REPEAT = -2312,
37
- ERR_REQUEST_ID_CONFLICT = -2313,
38
- ERR_MAX_SEAT_COUNT_LIMIT = -2340,
39
- ERR_ALREADY_IN_SEAT = -2341,
40
- ERR_SEAT_OCCUPIED = -2342,
41
- ERR_SEAT_LOCKED = -2343,
42
- ERR_SEAT_INDEX_NOT_EXIST = -2344,
43
- ERR_USER_NOT_IN_SEAT = -2345,
44
- ERR_ALL_SEAT_OCCUPIED = -2346,
45
- ERR_SEAT_NOT_SUPPORT_LINK_MIC = -2347,
46
- ERR_OPEN_MICROPHONE_NEED_SEAT_UNLOCK = -2360,
47
- ERR_OPEN_MICROPHONE_NEED_PERMISSION_FROM_ADMIN = -2361,
48
- ERR_OPEN_CAMERA_NEED_SEAT_UNLOCK = -2370,
49
- ERR_OPEN_CAMERA_NEED_PERMISSION_FROM_ADMIN = -2371,
50
- ERR_OPEN_SCREEN_SHARE_NEED_SEAT_UNLOCK = -2372,
51
- ERR_OPEN_SCREEN_SHARE_NEED_PERMISSION_FROM_ADMIN = -2373,
52
- ERR_SEND_MESSAGE_DISABLED_FOR_ALL = -2380,
53
- ERR_SEND_MESSAGE_DISABLED_FOR_CURRENT = -2381
54
- }
55
- export type TUIRoomInfo = {
56
- roomId: string;
57
- roomName: string;
58
- roomType: TUIRoomType;
59
- speechMode: TUISpeechMode;
60
- isMicrophoneDisableForAllUser: boolean;
61
- isScreenShareDisableForAllUser: boolean;
62
- isCameraDisableForAllUser: boolean;
63
- isMessageDisableForAllUser: boolean;
64
- maxSeatCount: number;
65
- roomOwner: string;
66
- createTime: number;
67
- roomMemberCount: number;
68
- };
69
- export type TUILoginUserInfo = {
70
- userId: string;
71
- userName: string;
72
- avatarUrl: string;
73
- customInfo: Record<string, any>;
74
- };
75
- export type TUISeatLockParams = {
76
- lockSeat: boolean;
77
- lockVideo: boolean;
78
- lockAudio: boolean;
79
- };
80
- export declare enum TUIRole {
81
- kRoomOwner = 0,
82
- kAdministrator = 1,
83
- kGeneralUser = 2
84
- }
85
- /**
86
- * 消息结构体
87
- * @typedef {object} TUIMessage
88
- * @property {string} messageId 消息 Id
89
- * @property {string} message 消息内容
90
- * @property {number} timestamp 时间戳信息, 精确到秒
91
- * @property {TUIRole} userId 用户 Id
92
- * @property {boolean} userName 用户名称
93
- * @property {boolean} avatarUrl 用户头像地址
94
- */
95
- export type TUIMessage = {
96
- messageId: string;
97
- message: string;
98
- timestamp: number;
99
- userId: string;
100
- userName: string;
101
- avatarUrl: string;
102
- };
103
- export declare enum TUIVideoQuality {
104
- kVideoQuality_360p = 1,
105
- kVideoQuality_540p = 2,
106
- kVideoQuality_720p = 3,
107
- kVideoQuality_1080p = 4
108
- }
109
- export declare enum TUIAudioQuality {
110
- kAudioProfileSpeech = 0,
111
- kAudioProfileDefault = 1,
112
- kAudioProfileMusic = 2
113
- }
114
- export declare enum TUIVideoStreamType {
115
- kCameraStream = 0,
116
- kScreenStream = 1,
117
- kCameraStreamLow = 2
118
- }
119
- export declare enum TUINetworkQuality {
120
- kQualityUnknown = 0,
121
- kQualityExcellent = 1,
122
- kQualityGood = 2,
123
- kQualityPoor = 3,
124
- kQualityBad = 4,
125
- kQualityVeryBad = 5,
126
- kQualityDown = 6
127
- }
128
- /**
129
- * 消息结构体
130
- * @typedef {object} TUINetwork
131
- * @property {string} userId 用户 Id
132
- * @property {TUINetworkQuality} quality 网络质量
133
- * @property {number} upLoss 上行丢包率,单位 (%) 该数值越小越好,目前仅本地用户有该信息
134
- * @property {TUIRole} downLoss 下行丢包率,单位 (%) 该数值越小越好,目前仅本地用户有该信息
135
- * @property {Number} delay 网络延迟,单位 ms,目前仅本地用户有该信息
136
- */
137
- export type TUINetwork = {
138
- userId: string;
139
- quality: TUINetworkQuality;
140
- upLoss: number;
141
- downLoss: number;
142
- delay: number;
143
- };
144
- /**
145
- * 视频编码参数
146
- * @typedef {object} TUIVideoEncoderParams
147
- * @property {number} fps 帧率设置
148
- * @property {number} bitrate 目标编码码率设置
149
- * @property {TUIVideoQuality} quality 上行视频分辨率
150
- * @property {TUIVideoQuality} videoResolution 上行视频分辨率(自 v1.6.0 版本开始支持,v1.6.0 之前版本请使用 quality 参数)
151
- * @property {TUIResolutionMode} resolutionMode 横竖屏模式
152
- */
153
- export type TUIVideoEncoderParams = {
154
- quality?: TUIVideoQuality;
155
- videoResolution: TUIVideoQuality;
156
- fps: number;
157
- bitrate: number;
158
- resolutionMode: TUIResolutionMode;
159
- };
160
- export declare enum TUIRoomType {
161
- kConference = 1,
162
- kLivingRoom = 2
163
- }
164
- export declare enum TUISpeechMode {
165
- kFreeToSpeak = 1,
166
- kApplyToSpeak = 2,
167
- kSpeakAfterTakingSeat = 3
168
- }
169
- export declare enum TUIMediaDevice {
170
- kMicrophone = 1,
171
- kCamera = 2,
172
- kScreen = 3
173
- }
174
- export declare enum TUICaptureSourceType {
175
- kWindow = 0,
176
- kScreen = 1
177
- }
178
- export declare enum TUIChangeReason {
179
- kChangedBySelf = 0,
180
- kChangedByAdmin = 1
181
- }
182
- export declare enum TUIKickedOutOfRoomReason {
183
- kKickedByAdmin = 0,
184
- kKickedByLoggedOnOtherDevice = 1,
185
- kKickedByServer = 2
186
- }
187
- export declare enum TUIRequestAction {
188
- kInvalidAction = 0,
189
- kRequestToOpenRemoteCamera = 1,
190
- kRequestToOpenRemoteMicrophone = 2,
191
- kRequestToConnectOtherRoom = 3,
192
- kRequestToTakeSeat = 4,
193
- kRequestRemoteUserOnSeat = 5,
194
- kApplyToAdminToOpenLocalCamera = 6,
195
- kApplyToAdminToOpenLocalMicrophone = 7,
196
- kApplyToAdminToOpenLocalScreenShare = 8,
197
- }
198
- export declare enum TUIRequestCallbackType {
199
- kRequestAccepted = 0,
200
- kRequestRejected = 1,
201
- kRequestCancelled = 2,
202
- kRequestTimeout = 3,
203
- kRequestError = 4
204
- }
205
- export declare enum TRTCRole {
206
- kAnchor = 0,
207
- kAudience = 1
208
- }
209
- export declare enum TUIResolutionMode {
210
- kResolutionMode_Landscape = 0,
211
- kResolutionMode_Portrait = 1
212
- }
213
- export type TUIUserInfo = {
214
- userId: string;
215
- userName: string;
216
- avatarUrl: string;
217
- userRole: TUIRole;
218
- hasAudioStream: boolean;
219
- hasVideoStream: boolean;
220
- hasScreenStream: boolean;
221
- roomCustomInfo: Record<string, any>;
222
- };
223
- export type TUISeatInfo = {
224
- index: number;
225
- userId: string;
226
- locked: boolean;
227
- isVideoLocked: boolean;
228
- isAudioLocked: boolean;
229
- };
230
- export type TUIRequest = {
231
- requestAction: TUIRequestAction;
232
- timestamp: number;
233
- requestId: string;
234
- userId: string;
235
- content: string;
236
- };
237
- export type TUIRequestCallback = {
238
- requestCallbackType: TUIRequestCallbackType;
239
- requestId: string;
240
- userId: string;
241
- code: number;
242
- message: string;
243
- };
244
- /**
245
- * **TUIRoomEngine 事件列表**<br>
246
- * @namespace TUIRoomEvents
247
- * @example
248
- * import TUIRoomEngine, { TUIRoomEvents } from '@tencentcloud/tuiroom-engine-electron';
249
- * const roomEngine = new TUIRoomEngine();
250
- * roomEngine.on(TUIRoomEvents.onError, (error) => {
251
- * console.log('roomEngine.error', error);
252
- * })
253
- */
254
- export declare enum TUIRoomEvents {
255
- /**
256
- *
257
- * @description 错误事件
258
- * @event TUIRoomEvents#onError
259
- * @param {object} options
260
- * @param {number} options.code 错误代码
261
- * @param {string} options.message 错误信息
262
- * @example
263
- * const roomEngine = new TUIRoomEngine();
264
- * roomEngine.on(TUIRoomEvents.onError, (error) => {
265
- * console.log('TUIRoomError error', error);
266
- * })
267
- */
268
- onError = "onError",
269
- /**
270
- * @description 踢出房间事件
271
- * @default 'onKickedOutOfRoom'
272
- * @event TUIRoomEvents#onKickedOutOfRoom
273
- * @param {object} options
274
- * @param {string} options.roomId 房间号
275
- * @param {TUIKickedOutOfRoomReason} options.reason 用户被踢出房间枚举
276
- * @param {string} options.message 踢出房间信息
277
- * @example
278
- * const roomEngine = new TUIRoomEngine();
279
- * roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, ({ roomId, reason, message }) => {
280
- * console.log('roomEngine.onKickedOutOfRoom', roomId, reason, message);
281
- * });
282
- */
283
- onKickedOutOfRoom = "onKickedOutOfRoom",
284
- /**
285
- * @description 当前用户被踢下线
286
- * @default 'onKickedOffLine'
287
- * @event TUIRoomEvents#onKickedOffLine
288
- * @param {string} options.message 用户被踢下线信息
289
- * @example
290
- * const roomEngine = new TUIRoomEngine();
291
- * roomEngine.on(TUIRoomEvents.onKickedOffLine, ({ message }) => {
292
- * console.log('roomEngine.onKickedOffLine', message);
293
- * });
294
- */
295
- onKickedOffLine = "onKickedOffLine",
296
- /**
297
- * @description userSig 过期事件
298
- * @default 'onUserSigExpired'
299
- * @event TUIRoomEvents#onUserSigExpired
300
- * @example
301
- * const roomEngine = new TUIRoomEngine();
302
- * roomEngine.on(TUIRoomEvents.onUserSigExpired, () => {
303
- * console.log('roomEngine.onUserSigExpired');
304
- * });
305
- */
306
- onUserSigExpired = "onUserSigExpired",
307
- /**
308
- * @description 主持人销毁房间事件
309
- * @default 'onRoomDismissed'
310
- * @event TUIRoomEvents#onRoomDismissed
311
- * @param {object} options
312
- * @param {string} options.roomId 房间号
313
- * @example
314
- * const roomEngine = new TUIRoomEngine();
315
- * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
316
- * console.log('roomEngine.onRoomDismissed', roomId);
317
- * });
318
- */
319
- onRoomDismissed = "onRoomDismissed",
320
- /**
321
- * @description 房间名字修改事件
322
- * @default 'onRoomNameChanged'
323
- * @event TUIRoomEvents#onRoomChanged
324
- * @param {object} options
325
- * @param {string} options.roomName 房间名字
326
- * @example
327
- * const roomEngine = new TUIRoomEngine();
328
- * roomEngine.on(TUIRoomEvents.onRoomNameChanged, ({ roomId, roomName }) =>{
329
- * console.log('roomEngine.onRoomNameChanged', roomId, roomName);
330
- * });
331
- */
332
- onRoomNameChanged = "onRoomNameChanged",
333
- /**
334
- * @description 房间模式修改事件
335
- * @default 'onRoomSpeechModeChanged'
336
- * @event TUIRoomEvents#onRoomSpeechModeChanged
337
- * @param {object} options
338
- * @param {TUISpeechMode} options.speechMode 房间模式
339
- * @example
340
- * const roomEngine = new TUIRoomEngine();
341
- * roomEngine.on(TUIRoomEvents.onRoomSpeechModeChanged, ({ roomId, speechMode }) =>{
342
- * console.log('roomEngine.onRoomSpeechModeChanged', roomId, speechMode);
343
- * });
344
- */
345
- onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
346
- /**
347
- * @description 所有成员摄像头使用权限改变事件
348
- * @default 'onAllUserCameraDisableChanged'
349
- * @event TUIRoomEvents#onAllUserCameraDisableChanged
350
- * @param {object} options
351
- * @param {boolean} options.isDisable 是否允许使用摄像头
352
- * @example
353
- * const roomEngine = new TUIRoomEngine();
354
- * roomEngine.on(TUIRoomEvents.onAllUserCameraDisableChanged, ({ isDisable }) =>{
355
- * console.log('roomEngine.onAllUserCameraDisableChanged', isDisable);
356
- * });
357
- */
358
- onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
359
- /**
360
- * @description 所有成员麦克风使用权限改变事件
361
- * @default 'onAllUserMicrophoneDisableChanged'
362
- * @event TUIRoomEvents#onAllUserMicrophoneDisableChanged
363
- * @param {object} options
364
- * @param {boolean} options.isDisable 是否允许使用麦克风
365
- * @example
366
- * const roomEngine = new TUIRoomEngine();
367
- * roomEngine.on(TUIRoomEvents.onAllUserMicrophoneDisableChanged, ({ isDisable }) =>{
368
- * console.log('roomEngine.onAllUserMicrophoneDisableChanged', isDisable);
369
- * });
370
- */
371
- onAllUserMicrophoneDisableChanged = "onAllUserMicrophoneDisableChanged",
372
- /**
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',
386
- /**
387
- * @description 所有成员发送消息权限改变事件
388
- * @default 'onSendMessageForAllUserDisableChanged'
389
- * @event TUIRoomEvents#OnSendMessageForAllUserDisableChanged
390
- * @param {object} options
391
- * @param {boolean} options.isDisable 是否被允许
392
- * @example
393
- * const roomEngine = new TUIRoomEngine();
394
- * roomEngine.on(TUIRoomEvents.onSendMessageForAllUserDisableChanged, ({ isDisable }) =>{
395
- * console.log('roomEngine.onSendMessageForAllUserDisableChanged', isDisable);
396
- * });
397
- */
398
- onSendMessageForAllUserDisableChanged = "onSendMessageForAllUserDisableChanged",
399
- /**
400
- * @description 房间最大麦位数修改事件
401
- * @default 'onRoomMaxSeatCountChanged'
402
- * @event TUIRoomEvents#onRoomMaxSeatCountChanged
403
- * @param {object} options
404
- * @param {boolean} options.maxSeatNumber 最大麦位数
405
- * @example
406
- * const roomEngine = new TUIRoomEngine();
407
- * roomEngine.on(TUIRoomEvents.onRoomMaxSeatCountChanged, ({ maxSeatNumber }) =>{
408
- * console.log('roomEngine.onRoomMaxSeatCountChanged', maxSeatNumber);
409
- * });
410
- */
411
- onRoomMaxSeatCountChanged = "onRoomMaxSeatCountChanged",
412
- /**
413
- * @description 远端用户进入房间事件
414
- * @default 'onRemoteUserEnterRoom'
415
- * @event TUIRoomEvents#onRemoteUserEnterRoom
416
- * @param {object} options
417
- * @param {string} options.roomId 房间号
418
- * @param {TUIUserInfo} options.userInfo 用户信息
419
- * @example
420
- * const roomEngine = new TUIRoomEngine();
421
- * roomEngine.on(TUIRoomEvents.onRemoteUserEnterRoom, ({ roomId, userInfo }) => {
422
- * console.log('roomEngine.onRemoteUserEnterRoom', roomId, userInfo);
423
- * });
424
- */
425
- onRemoteUserEnterRoom = "onRemoteUserEnterRoom",
426
- /**
427
- * @description 远端用户离开房间事件
428
- * @default 'onRemoteUserLeaveRoom'
429
- * @event TUIRoomEvents#onRemoteUserLeaveRoom
430
- * @param {object} options
431
- * @param {string} options.roomId 房间号
432
- * @param {TUIUserInfo} options.userInfo 用户信息
433
- * @example
434
- * const roomEngine = new TUIRoomEngine();
435
- * roomEngine.on(TUIRoomEvents.onRemoteUserLeaveRoom, ({ roomId, userInfo }) => {
436
- * console.log('roomEngine.onRemoteUserLeaveRoom', roomId, userInfo);
437
- * });
438
- */
439
- onRemoteUserLeaveRoom = "onRemoteUserLeaveRoom",
440
- /**
441
- * @description 用户角色改变事件
442
- * @default 'onKickedOutOfRoom'
443
- * @event TUIRoomEvents#onUserRoleChanged
444
- * @param {object} options
445
- * @param {string} options.userId 用户Id
446
- * @param {TUIRole} options.userRole 用户变更后的角色
447
- * @example
448
- * const roomEngine = new TUIRoomEngine();
449
- * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
450
- * console.log('roomEngine.onUserRoleChanged', userId, userRole);
451
- * });
452
- */
453
- onUserRoleChanged = "onUserRoleChanged",
454
- /**
455
- * @description 用户视频状态改变事件
456
- * @default 'onUserVideoStateChanged'
457
- * @event TUIRoomEvents#onUserVideoStateChanged
458
- * @param {object} options
459
- * @param {string} options.userId 用户Id
460
- * @param {TUIVideoStreamType} options.streamType 用户流类型
461
- * @param {boolean} options.hasVideo 是否有视频流
462
- * @param {TUIChangeReason} options.reason 变更原因
463
- * @example
464
- * const roomEngine = new TUIRoomEngine();
465
- * roomEngine.on(TUIRoomEvents.onUserVideoStateChanged, ({ userId, streamType, hasVideo, reason }) => {
466
- * console.log('roomEngine.onUserVideoStateChanged', userId, streamType, hasVideo, reason);
467
- * });
468
- */
469
- onUserVideoStateChanged = "onUserVideoStateChanged",
470
- /**
471
- * @description 用户音频状态改变事件
472
- * @default 'onUserAudioStateChanged'
473
- * @event TUIRoomEvents#onUserAudioStateChanged
474
- * @param {object} options
475
- * @param {string} options.userId 用户Id
476
- * @param {boolean} options.hasVideo 是否有音频流
477
- * @param {TUIChangeReason} options.reason 原因
478
- * @example
479
- * const roomEngine = new TUIRoomEngine();
480
- * roomEngine.on(TUIRoomEvents.onUserAudioStateChanged, ({ userId, hasAudio, reason }) => {
481
- * console.log('roomEngine.onUserAudioStateChanged', userId, hasAudio, reason);
482
- * });
483
- */
484
- onUserAudioStateChanged = "onUserAudioStateChanged",
485
- /**
486
- * @description 用户发送消息状态改变事件
487
- * @default 'onSendMessageForUserDisableChanged'
488
- * @event TUIRoomEvents#onSendMessageForUserDisableChanged
489
- * @param {object} options
490
- * @param {string} options.userId 成员 Id
491
- * @param {boolean} options.isDisable 是否被允许
492
- * @example
493
- * const roomEngine = new TUIRoomEngine();
494
- * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
495
- * console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
496
- * });
497
- */
498
- onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
499
- /**
500
- * @description 用户音量改变事件
501
- * @default 'onUserVoiceVolumeChanged'
502
- * @event TUIRoomEvents#onUserVoiceVolumeChanged
503
- * @param {object} options
504
- * @param {Array<TRTCVolumeInfo>} options.userVolumeList 房间内所有用户的音量, 包含 userId 及 volume 信息,volume 区间为 1~100;
505
- * @example
506
- * const roomEngine = new TUIRoomEngine();
507
- * roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, ({ userVolumeList }) => {
508
- * userVolumeList.forEach(userVolume => {
509
- * console.log('roomEngine.onUserVoiceVolumeChanged', userVolume.userId, userVolume.volume);
510
- * })
511
- * });
512
- */
513
- onUserVoiceVolumeChanged = "onUserVoiceVolumeChanged",
514
- /**
515
- * @description 用户网络质量改变事件
516
- * @default 'onUserNetworkQualityChanged'
517
- * @event TUIRoomEvents#onUserNetworkQualityChanged
518
- * @param {object} options
519
- * @param {TUINetwork} options.userNetworkList 网络质量信息
520
- * @example
521
- * const roomEngine = new TUIRoomEngine();
522
- * roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
523
- * userNetworkList.forEach(userNetwork => {
524
- * console.log('roomEngine.onUserNetworkQualityChanged',
525
- * userNetwork.userId, userNetwork.quality, userNetwork.upLoss, userNetwork.downLoss, userNetwork.delay);
526
- * })
527
- * });
528
- */
529
- onUserNetworkQualityChanged = "onUserNetworkQualityChanged",
530
- /**
531
- * @description 麦位列表改变事件
532
- * @default 'onSeatListChanged'
533
- * @event TUIRoomEvents#onSeatListChanged
534
- * @param {object} options
535
- * @param {Array<TUISeatInfo>} options.seatList 麦位列表
536
- * @param {Array<TUISeatInfo>} options.seatedList 新增麦位列表
537
- * @param {Array<TUISeatInfo>} options.leftList 离开的麦位列表
538
- * @example
539
- * const roomEngine = new TUIRoomEngine();
540
- * roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, seatedList, leftList }) => {
541
- * console.log('roomEngine.onSeatListChanged',seatList, seatedList, leftList);
542
- * });
543
- */
544
- onSeatListChanged = "onSeatListChanged",
545
- /**
546
- * @description 当前用户被踢下麦事件
547
- * @default 'onKickedOffSeat'
548
- * @event TUIRoomEvents#onKickedOffSeat
549
- * @example
550
- * const roomEngine = new TUIRoomEngine();
551
- * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
552
- * console.log('roomEngine.onKickedOffSeat', userId);
553
- * });
554
- */
555
- onKickedOffSeat = "onKickedOffSeat",
556
- /**
557
- * @description 请求接收事件
558
- * @default 'onRequestReceived'
559
- * @event TUIRoomEvents#onRequestReceived
560
- * @param {object} options
561
- * @param {TUIRequest} options.request 请求接收
562
- * @example
563
- * const roomEngine = new TUIRoomEngine();
564
- * roomEngine.on(TUIRoomEvents.onRequestReceived, ({ request }) => {
565
- * console.log('roomEngine.onRequestReceived', request);
566
- * });
567
- */
568
- onRequestReceived = "onRequestReceived",
569
- /**
570
- * @description 请求取消事件
571
- * @default 'onRequestCancelled'
572
- * @event TUIRoomEvents#onRequestCancelled
573
- * @param {object} options
574
- * @param {string} options.requestId 请求Id
575
- * @param {string} options.userId 取消请求的用户Id
576
- * @example
577
- * const roomEngine = new TUIRoomEngine();
578
- * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
579
- * console.log('roomEngine.onRequestCancelled', requestId, userId);
580
- * });
581
- */
582
- onRequestCancelled = "onRequestCancelled",
583
- /**
584
- * @description 接收文本消息事件
585
- * @default 'onReceiveTextMessage'
586
- * @event TUIRoomEvents#onReceiveTextMessage
587
- * @param {object} options
588
- * @param {string} options.roomId 房间Id
589
- * @param {TUIMessage} options.message 接收的文本消息
590
- * @example
591
- * const roomEngine = new TUIRoomEngine();
592
- * roomEngine.on(TUIRoomEvents.onReceiveTextMessage, ({ roomId, message }) => {
593
- * console.log('roomEngine.onReceiveTextMessage', roomId, message);
594
- * });
595
- */
596
- onReceiveTextMessage = "onReceiveTextMessage",
597
- /**
598
- * @description 接收自定义消息事件
599
- * @default 'onReceiveCustomMessage'
600
- * @event TUIRoomEvents#onReceiveCustomMessage
601
- * @param {object} options
602
- * @param {string} options.roomId 房间Id
603
- * @param {TUIMessage} options.message 接收的自定义消息
604
- * @example
605
- * const roomEngine = new TUIRoomEngine();
606
- * roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, ({ roomId, message }) => {
607
- * console.log('roomEngine.onReceiveCustomMessage', roomId, message);
608
- * });
609
- */
610
- onReceiveCustomMessage = "onReceiveCustomMessage",
611
- /**
612
- * @description 设备变更事件
613
- * @default 'onDeviceChange'
614
- * @event TUIRoomEvents#onDeviceChange
615
- * @param {object} options
616
- * @param {string} options.deviceId 设备 Id
617
- * @param {TRTCDeviceType} options.type 设备类型
618
- * @param {TRTCDeviceState} options.state 设备变更状态
619
- * @example
620
- * const roomEngine = new TUIRoomEngine();
621
- * roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
622
- * console.log('roomEngine.onDeviceChange', deviceId, type, state);
623
- * });
624
- */
625
- onDeviceChange = "onDeviceChange",
626
- /**
627
- * @description 屏幕分享停止事件,当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时,该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
628
- * @default 'onUserScreenCaptureStopped'
629
- * @event TUIRoomEvents#onUserScreenCaptureStopped
630
- * @example
631
- * const roomEngine = new TUIRoomEngine();
632
- * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
633
- * console.log('roomEngine.onUserScreenCaptureStopped');
634
- * });
635
- */
636
- onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
637
- }