@tencentcloud/tuiroom-engine-js 2.2.2 → 2.2.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-js",
3
- "version": "2.2.2",
3
+ "version": "2.2.3",
4
4
  "description": "TUIRoomEngine Web SDK",
5
5
  "main": "index.js",
6
+ "module": "index.esm.js",
6
7
  "types": "index.d.ts",
7
8
  "keywords": [
8
9
  "tuiroom",
package/types.d.ts DELETED
@@ -1,642 +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 TUISeatMode {
170
- kFreeToTake = 1,
171
- kApplyToTake = 2
172
- }
173
- export declare enum TUIMediaDevice {
174
- kMicrophone = 1,
175
- kCamera = 2,
176
- kScreen = 3
177
- }
178
- export declare enum TUICaptureSourceType {
179
- kWindow = 0,
180
- kScreen = 1
181
- }
182
- export declare enum TUIChangeReason {
183
- kChangedBySelf = 0,
184
- kChangedByAdmin = 1
185
- }
186
- export declare enum TUIKickedOutOfRoomReason {
187
- kKickedByAdmin = 0,
188
- kKickedByLoggedOnOtherDevice = 1,
189
- kKickedByServer = 2
190
- }
191
- export declare enum TUIRequestAction {
192
- kInvalidAction = 0,
193
- kRequestToOpenRemoteCamera = 1,
194
- kRequestToOpenRemoteMicrophone = 2,
195
- kRequestToConnectOtherRoom = 3,
196
- kRequestToTakeSeat = 4,
197
- kRequestRemoteUserOnSeat = 5,
198
- kApplyToAdminToOpenLocalCamera = 6,
199
- kApplyToAdminToOpenLocalMicrophone = 7,
200
- kApplyToAdminToOpenLocalScreenShare = 8,
201
- }
202
- export declare enum TUIRequestCallbackType {
203
- kRequestAccepted = 0,
204
- kRequestRejected = 1,
205
- kRequestCancelled = 2,
206
- kRequestTimeout = 3,
207
- kRequestError = 4
208
- }
209
- export declare enum TRTCRole {
210
- kAnchor = 0,
211
- kAudience = 1
212
- }
213
- export declare enum TUIResolutionMode {
214
- kResolutionMode_Landscape = 0,
215
- kResolutionMode_Portrait = 1
216
- }
217
- export type TUIUserInfo = {
218
- userId: string;
219
- userName: string;
220
- avatarUrl: string;
221
- userRole: TUIRole;
222
- hasAudioStream: boolean;
223
- hasVideoStream: boolean;
224
- hasScreenStream: boolean;
225
- roomCustomInfo: Record<string, any>;
226
- };
227
- export type TUISeatInfo = {
228
- index: number;
229
- userId: string;
230
- locked: boolean;
231
- isVideoLocked: boolean;
232
- isAudioLocked: boolean;
233
- };
234
- export type TUIRequest = {
235
- requestAction: TUIRequestAction;
236
- timestamp: number;
237
- requestId: string;
238
- userId: string;
239
- content: string;
240
- };
241
- export type TUIRequestCallback = {
242
- requestCallbackType: TUIRequestCallbackType;
243
- requestId: string;
244
- userId: string;
245
- code: number;
246
- message: string;
247
- };
248
- /**
249
- * **TUIRoomEngine 事件列表**<br>
250
- * @namespace TUIRoomEvents
251
- * @example
252
- * import TUIRoomEngine, { TUIRoomEvents } from '@tencentcloud/tuiroom-engine-js';
253
- * const roomEngine = new TUIRoomEngine();
254
- * roomEngine.on(TUIRoomEvents.onError, (error) => {
255
- * console.log('roomEngine.error', error);
256
- * })
257
- */
258
- export declare enum TUIRoomEvents {
259
- /**
260
- *
261
- * @description 错误事件
262
- * @event TUIRoomEvents#onError
263
- * @param {object} options
264
- * @param {number} options.code 错误代码
265
- * @param {string} options.message 错误信息
266
- * @example
267
- * const roomEngine = new TUIRoomEngine();
268
- * roomEngine.on(TUIRoomEvents.onError, (error) => {
269
- * console.log('TUIRoomError error', error);
270
- * })
271
- */
272
- onError = "onError",
273
- /**
274
- * @description 踢出房间事件
275
- * @default 'onKickedOutOfRoom'
276
- * @event TUIRoomEvents#onKickedOutOfRoom
277
- * @param {object} options
278
- * @param {string} options.roomId 房间号
279
- * @param {TUIKickedOutOfRoomReason} options.reason 用户被踢出房间枚举
280
- * @param {string} options.message 踢出房间信息
281
- * @example
282
- * const roomEngine = new TUIRoomEngine();
283
- * roomEngine.on(TUIRoomEvents.onKickedOutOfRoom, ({ roomId, reason, message }) => {
284
- * console.log('roomEngine.onKickedOutOfRoom', roomId, reason, message);
285
- * });
286
- */
287
- onKickedOutOfRoom = "onKickedOutOfRoom",
288
- /**
289
- * @description 当前用户被踢下线
290
- * @default 'onKickedOffLine'
291
- * @event TUIRoomEvents#onKickedOffLine
292
- * @param {string} options.message 用户被踢下线信息
293
- * @example
294
- * const roomEngine = new TUIRoomEngine();
295
- * roomEngine.on(TUIRoomEvents.onKickedOffLine, ({ message }) => {
296
- * console.log('roomEngine.onKickedOffLine', message);
297
- * });
298
- */
299
- onKickedOffLine = "onKickedOffLine",
300
- /**
301
- * @description userSig 过期事件
302
- * @default 'onUserSigExpired'
303
- * @event TUIRoomEvents#onUserSigExpired
304
- * @example
305
- * const roomEngine = new TUIRoomEngine();
306
- * roomEngine.on(TUIRoomEvents.onUserSigExpired, () => {
307
- * console.log('roomEngine.onUserSigExpired');
308
- * });
309
- */
310
- onUserSigExpired = "onUserSigExpired",
311
- /**
312
- * @description 主持人销毁房间事件
313
- * @default 'onRoomDismissed'
314
- * @event TUIRoomEvents#onRoomDismissed
315
- * @param {object} options
316
- * @param {string} options.roomId 房间号
317
- * @example
318
- * const roomEngine = new TUIRoomEngine();
319
- * roomEngine.on(TUIRoomEvents.onRoomDismissed, ({ roomId }) => {
320
- * console.log('roomEngine.onRoomDismissed', roomId);
321
- * });
322
- */
323
- onRoomDismissed = "onRoomDismissed",
324
- /**
325
- * @description 房间名字修改事件
326
- * @default 'onRoomNameChanged'
327
- * @event TUIRoomEvents#onRoomChanged
328
- * @param {object} options
329
- * @param {string} options.roomName 房间名字
330
- * @example
331
- * const roomEngine = new TUIRoomEngine();
332
- * roomEngine.on(TUIRoomEvents.onRoomNameChanged, ({ roomId, roomName }) =>{
333
- * console.log('roomEngine.onRoomNameChanged', roomId, roomName);
334
- * });
335
- */
336
- onRoomNameChanged = "onRoomNameChanged",
337
- /**
338
- * @description 房间模式修改事件
339
- * @default 'onRoomSpeechModeChanged'
340
- * @event TUIRoomEvents#onRoomSpeechModeChanged
341
- * @param {object} options
342
- * @param {TUISpeechMode} options.speechMode 房间模式
343
- * @example
344
- * const roomEngine = new TUIRoomEngine();
345
- * roomEngine.on(TUIRoomEvents.onRoomSpeechModeChanged, ({ roomId, speechMode }) =>{
346
- * console.log('roomEngine.onRoomSpeechModeChanged', roomId, speechMode);
347
- * });
348
- */
349
- onRoomSpeechModeChanged = "onRoomSpeechModeChanged",
350
-
351
- /**
352
- * @description 所有成员摄像头使用权限改变事件
353
- * @default 'onAllUserCameraDisableChanged'
354
- * @event TUIRoomEvents#onAllUserCameraDisableChanged
355
- * @param {object} options
356
- * @param {boolean} options.isDisable 是否允许使用摄像头
357
- * @example
358
- * const roomEngine = new TUIRoomEngine();
359
- * roomEngine.on(TUIRoomEvents.onAllUserCameraDisableChanged, ({ isDisable }) =>{
360
- * console.log('roomEngine.onAllUserCameraDisableChanged', isDisable);
361
- * });
362
- */
363
- onAllUserCameraDisableChanged = "onAllUserCameraDisableChanged",
364
- /**
365
- * @description 所有成员麦克风使用权限改变事件
366
- * @default 'onAllUserMicrophoneDisableChanged'
367
- * @event TUIRoomEvents#onAllUserMicrophoneDisableChanged
368
- * @param {object} options
369
- * @param {boolean} options.isDisable 是否允许使用麦克风
370
- * @example
371
- * const roomEngine = new TUIRoomEngine();
372
- * roomEngine.on(TUIRoomEvents.onAllUserMicrophoneDisableChanged, ({ isDisable }) =>{
373
- * console.log('roomEngine.onAllUserMicrophoneDisableChanged', isDisable);
374
- * });
375
- */
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',
391
- /**
392
- * @description 所有成员发送消息权限改变事件
393
- * @default 'onSendMessageForAllUserDisableChanged'
394
- * @event TUIRoomEvents#OnSendMessageForAllUserDisableChanged
395
- * @param {object} options
396
- * @param {boolean} options.isDisable 是否被允许
397
- * @example
398
- * const roomEngine = new TUIRoomEngine();
399
- * roomEngine.on(TUIRoomEvents.onSendMessageForAllUserDisableChanged, ({ isDisable }) =>{
400
- * console.log('roomEngine.onSendMessageForAllUserDisableChanged', isDisable);
401
- * });
402
- */
403
- onSendMessageForAllUserDisableChanged = "onSendMessageForAllUserDisableChanged",
404
- /**
405
- * @description 房间最大麦位数修改事件
406
- * @default 'onRoomMaxSeatCountChanged'
407
- * @event TUIRoomEvents#onRoomMaxSeatCountChanged
408
- * @param {object} options
409
- * @param {boolean} options.maxSeatNumber 最大麦位数
410
- * @example
411
- * const roomEngine = new TUIRoomEngine();
412
- * roomEngine.on(TUIRoomEvents.onRoomMaxSeatCountChanged, ({ maxSeatNumber }) =>{
413
- * console.log('roomEngine.onRoomMaxSeatCountChanged', maxSeatNumber);
414
- * });
415
- */
416
- onRoomMaxSeatCountChanged = "onRoomMaxSeatCountChanged",
417
- /**
418
- * @description 远端用户进入房间事件
419
- * @default 'onRemoteUserEnterRoom'
420
- * @event TUIRoomEvents#onRemoteUserEnterRoom
421
- * @param {object} options
422
- * @param {string} options.roomId 房间号
423
- * @param {TUIUserInfo} options.userInfo 用户信息
424
- * @example
425
- * const roomEngine = new TUIRoomEngine();
426
- * roomEngine.on(TUIRoomEvents.onRemoteUserEnterRoom, ({ roomId, userInfo }) => {
427
- * console.log('roomEngine.onRemoteUserEnterRoom', roomId, userInfo);
428
- * });
429
- */
430
- onRemoteUserEnterRoom = "onRemoteUserEnterRoom",
431
- /**
432
- * @description 远端用户离开房间事件
433
- * @default 'onRemoteUserLeaveRoom'
434
- * @event TUIRoomEvents#onRemoteUserLeaveRoom
435
- * @param {object} options
436
- * @param {string} options.roomId 房间号
437
- * @param {TUIUserInfo} options.userInfo 用户信息
438
- * @example
439
- * const roomEngine = new TUIRoomEngine();
440
- * roomEngine.on(TUIRoomEvents.onRemoteUserLeaveRoom, ({ roomId, userInfo }) => {
441
- * console.log('roomEngine.onRemoteUserLeaveRoom', roomId, userInfo);
442
- * });
443
- */
444
- onRemoteUserLeaveRoom = "onRemoteUserLeaveRoom",
445
- /**
446
- * @description 用户角色改变事件
447
- * @default 'onKickedOutOfRoom'
448
- * @event TUIRoomEvents#onUserRoleChanged
449
- * @param {object} options
450
- * @param {string} options.userId 用户Id
451
- * @param {TUIRole} options.userRole 用户变更后的角色
452
- * @example
453
- * const roomEngine = new TUIRoomEngine();
454
- * roomEngine.on(TUIRoomEvents.onUserRoleChanged, ({ userId, userRole }) => {
455
- * console.log('roomEngine.onUserRoleChanged', userId, userRole);
456
- * });
457
- */
458
- onUserRoleChanged = "onUserRoleChanged",
459
- /**
460
- * @description 用户视频状态改变事件
461
- * @default 'onUserVideoStateChanged'
462
- * @event TUIRoomEvents#onUserVideoStateChanged
463
- * @param {object} options
464
- * @param {string} options.userId 用户Id
465
- * @param {TUIVideoStreamType} options.streamType 用户流类型
466
- * @param {boolean} options.hasVideo 是否有视频流
467
- * @param {TUIChangeReason} options.reason 变更原因
468
- * @example
469
- * const roomEngine = new TUIRoomEngine();
470
- * roomEngine.on(TUIRoomEvents.onUserVideoStateChanged, ({ userId, streamType, hasVideo, reason }) => {
471
- * console.log('roomEngine.onUserVideoStateChanged', userId, streamType, hasVideo, reason);
472
- * });
473
- */
474
- onUserVideoStateChanged = "onUserVideoStateChanged",
475
- /**
476
- * @description 用户音频状态改变事件
477
- * @default 'onUserAudioStateChanged'
478
- * @event TUIRoomEvents#onUserAudioStateChanged
479
- * @param {object} options
480
- * @param {string} options.userId 用户Id
481
- * @param {boolean} options.hasVideo 是否有音频流
482
- * @param {TUIChangeReason} options.reason 原因
483
- * @example
484
- * const roomEngine = new TUIRoomEngine();
485
- * roomEngine.on(TUIRoomEvents.onUserAudioStateChanged, ({ userId, hasAudio, reason }) => {
486
- * console.log('roomEngine.onUserAudioStateChanged', userId, hasAudio, reason);
487
- * });
488
- */
489
- onUserAudioStateChanged = "onUserAudioStateChanged",
490
- /**
491
- * @description 用户发送消息状态改变事件
492
- * @default 'onSendMessageForUserDisableChanged'
493
- * @event TUIRoomEvents#onSendMessageForUserDisableChanged
494
- * @param {object} options
495
- * @param {string} options.userId 成员 Id
496
- * @param {boolean} options.isDisable 是否被允许
497
- * @example
498
- * const roomEngine = new TUIRoomEngine();
499
- * roomEngine.on(TUIRoomEvents.onSendMessageForUserDisableChanged, ({ userId, isDisable }) =>{
500
- * console.log('roomEngine.onSendMessageForUserDisableChanged', isDisable);
501
- * });
502
- */
503
- onSendMessageForUserDisableChanged = "onSendMessageForUserDisableChanged",
504
- /**
505
- * @description 用户音量改变事件
506
- * @default 'onUserVoiceVolumeChanged'
507
- * @event TUIRoomEvents#onUserVoiceVolumeChanged
508
- * @param {object} options
509
- * @param {Array<TRTCVolumeInfo>} options.userVolumeList 房间内所有用户的音量, 包含 userId 及 volume 信息,volume 区间为 1~100;
510
- * @example
511
- * const roomEngine = new TUIRoomEngine();
512
- * roomEngine.on(TUIRoomEvents.onUserVoiceVolumeChanged, ({ userVolumeList }) => {
513
- * userVolumeList.forEach(userVolume => {
514
- * console.log('roomEngine.onUserVoiceVolumeChanged', userVolume.userId, userVolume.volume);
515
- * })
516
- * });
517
- */
518
- onUserVoiceVolumeChanged = "onUserVoiceVolumeChanged",
519
- /**
520
- * @description 用户网络质量改变事件
521
- * @default 'onUserNetworkQualityChanged'
522
- * @event TUIRoomEvents#onUserNetworkQualityChanged
523
- * @param {object} options
524
- * @param {TUINetwork} options.userNetworkList 网络质量信息
525
- * @example
526
- * const roomEngine = new TUIRoomEngine();
527
- * roomEngine.on(TUIRoomEvents.onUserNetworkQualityChanged, ({ userNetworkList }) => {
528
- * userNetworkList.forEach(userNetwork => {
529
- * console.log('roomEngine.onUserNetworkQualityChanged',
530
- * userNetwork.userId, userNetwork.quality, userNetwork.upLoss, userNetwork.downLoss, userNetwork.delay);
531
- * })
532
- * });
533
- */
534
- onUserNetworkQualityChanged = "onUserNetworkQualityChanged",
535
- /**
536
- * @description 麦位列表改变事件
537
- * @default 'onSeatListChanged'
538
- * @event TUIRoomEvents#onSeatListChanged
539
- * @param {object} options
540
- * @param {Array<TUISeatInfo>} options.seatList 麦位列表
541
- * @param {Array<TUISeatInfo>} options.seatedList 新增麦位列表
542
- * @param {Array<TUISeatInfo>} options.leftList 离开的麦位列表
543
- * @example
544
- * const roomEngine = new TUIRoomEngine();
545
- * roomEngine.on(TUIRoomEvents.onSeatListChanged, ({ seatList, seatedList, leftList }) => {
546
- * console.log('roomEngine.onSeatListChanged',seatList, seatedList, leftList);
547
- * });
548
- */
549
- onSeatListChanged = "onSeatListChanged",
550
- /**
551
- * @description 当前用户被踢下麦事件
552
- * @default 'onKickedOffSeat'
553
- * @event TUIRoomEvents#onKickedOffSeat
554
- * @example
555
- * const roomEngine = new TUIRoomEngine();
556
- * roomEngine.on(TUIRoomEvents.onKickedOffSeat, ({ userId }) => {
557
- * console.log('roomEngine.onKickedOffSeat', userId);
558
- * });
559
- */
560
- onKickedOffSeat = "onKickedOffSeat",
561
- /**
562
- * @description 请求接收事件
563
- * @default 'onRequestReceived'
564
- * @event TUIRoomEvents#onRequestReceived
565
- * @param {object} options
566
- * @param {TUIRequest} options.request 请求接收
567
- * @example
568
- * const roomEngine = new TUIRoomEngine();
569
- * roomEngine.on(TUIRoomEvents.onRequestReceived, ({ request }) => {
570
- * console.log('roomEngine.onRequestReceived', request);
571
- * });
572
- */
573
- onRequestReceived = "onRequestReceived",
574
- /**
575
- * @description 请求取消事件
576
- * @default 'onRequestCancelled'
577
- * @event TUIRoomEvents#onRequestCancelled
578
- * @param {object} options
579
- * @param {string} options.requestId 请求Id
580
- * @param {string} options.userId 取消请求的用户Id
581
- * @example
582
- * const roomEngine = new TUIRoomEngine();
583
- * roomEngine.on(TUIRoomEvents.onRequestCancelled, ({ requestId, userId }) => {
584
- * console.log('roomEngine.onRequestCancelled', requestId, userId);
585
- * });
586
- */
587
- onRequestCancelled = "onRequestCancelled",
588
- /**
589
- * @description 接收文本消息事件
590
- * @default 'onReceiveTextMessage'
591
- * @event TUIRoomEvents#onReceiveTextMessage
592
- * @param {object} options
593
- * @param {string} options.roomId 房间Id
594
- * @param {TUIMessage} options.message 接收的文本消息
595
- * @example
596
- * const roomEngine = new TUIRoomEngine();
597
- * roomEngine.on(TUIRoomEvents.onReceiveTextMessage, ({ roomId, message }) => {
598
- * console.log('roomEngine.onReceiveTextMessage', roomId, message);
599
- * });
600
- */
601
- onReceiveTextMessage = "onReceiveTextMessage",
602
- /**
603
- * @description 接收自定义消息事件
604
- * @default 'onReceiveCustomMessage'
605
- * @event TUIRoomEvents#onReceiveCustomMessage
606
- * @param {object} options
607
- * @param {string} options.roomId 房间Id
608
- * @param {TUIMessage} options.message 接收的自定义消息
609
- * @example
610
- * const roomEngine = new TUIRoomEngine();
611
- * roomEngine.on(TUIRoomEvents.onReceiveCustomMessage, ({ roomId, message }) => {
612
- * console.log('roomEngine.onReceiveCustomMessage', roomId, message);
613
- * });
614
- */
615
- onReceiveCustomMessage = "onReceiveCustomMessage",
616
- /**
617
- * @description 设备变更事件
618
- * @default 'onDeviceChange'
619
- * @event TUIRoomEvents#onDeviceChange
620
- * @param {object} options
621
- * @param {string} options.deviceId 设备 Id
622
- * @param {TRTCDeviceType} options.type 设备类型
623
- * @param {TRTCDeviceState} options.state 设备变更状态
624
- * @example
625
- * const roomEngine = new TUIRoomEngine();
626
- * roomEngine.on(TUIRoomEvents.onDeviceChange, ({ deviceId, type, state }) => {
627
- * console.log('roomEngine.onDeviceChange', deviceId, type, state);
628
- * });
629
- */
630
- onDeviceChange = "onDeviceChange",
631
- /**
632
- * @description 屏幕分享停止事件,当用户使用浏览器自带的【停止分享】按钮结束屏幕共享时,该用户会收到 'onUserScreenCaptureStopped' 事件用来修改屏幕共享状态。
633
- * @default 'onUserScreenCaptureStopped'
634
- * @event TUIRoomEvents#onUserScreenCaptureStopped
635
- * @example
636
- * const roomEngine = new TUIRoomEngine();
637
- * roomEngine.on(TUIRoomEvents.onUserScreenCaptureStopped, () => {
638
- * console.log('roomEngine.onUserScreenCaptureStopped');
639
- * });
640
- */
641
- onUserScreenCaptureStopped = "onUserScreenCaptureStopped"
642
- }